Technical documentation

Guides

I wrote all the content of each guide and designed its cover and document styles.

• Compliance Manager GRC User Guide

  Kaseya (RapidFire Tools). PDF excerpt, 34 of 493 pages, 1.6 MB. The full guide to Compliance Manager GRC, a platform that automates compliance assessment, management and documentation. It covers everything an auditor does in the product. The excerpt has the contents, the overview, site and user setup, the technical review, and policies and procedures.

• Network Detective Pro: Cyberattack Risk Assessment Quick Start Guide

  Kaseya (RapidFire Tools). PDF, 1.6 MB. Step-by-step instructions for a complete cyberattack risk assessment, from installing the application to generating the risk reports.

• RouteMatch Mobility Platform User Guide

  RouteMatch Software. PDF excerpt, 23 of 106 pages, 1.1 MB. One guide to a whole transit platform: the rider and facility web portals, the rider app, the management portal, the trip planner and the driver app. The excerpt has the contents, the platform overview and the full rider app chapter.

Video tutorials

I designed, scripted, recorded and edited each of these videos.

• Network Detective Pro onboarding

  Kaseya (RapidFire Tools). Vimeo, 36 minutes. New customers had few onboarding resources. This walkthrough takes a new user through setup, then through a network and security assessment that generates IT documentation.

• Compliance Manager GRC and Datto Continuity

  Kaseya (RapidFire Tools). Vimeo, 3 minutes. How to connect Datto Continuity to Compliance Manager GRC: prerequisites, setup and turning on the integration, then keeping the data in sync.

• Ridekick: booking a multi-mode trip

  RouteMatch Software. MP4, 8.7 MB. Part of a training series that shared product knowledge across RouteMatch teams. Ridekick is RouteMatch’s transit companion app. The video shows a rider booking one trip that uses more than one mode of transit.

How I run documentation

• I set the documentation standards, templates and style guides across all published materials.
• I ran the MadCap Flare project in Git, with branching and continuous updates.
• I wrote user, admin and integration guides, training materials, video tutorials and in-app help.
• I mentored a technical writer who reported to me and oversaw their knowledge base articles, tutorial videos and in-app content.
• I used Python and the OpenAI API to scale compliance content, including HIPAA, and cut manual authoring time.