Spirent

01

I was on a small team working through a sweeping update of all the documentation for a large software product and preparing the documentation for an AI support model.

02

The goal was to prepare a demo and build new documentation processes to maintain the updated structure and style for the online help.

03

First, I built wireframes and a CSS for the online help for customization within RoboHelp’s templates. Then, I created custom scripts that enhanced functionality on the page for users such as a single page search tool.

Since the goal was to update old content as it is brought into the new project, I created a series of Python scripts to clean the old HTML style from the files, automatically update Unified Modeling Language (UML) diagrams, and spreadsheets to track progress of old content as it was brought into the new project.

04

The proof-of-concept demo shown to stakeholders made the documentation clean, searchable, and navigable for the user.

The processes to review existing content with SMEs made tracking documentation updates systematic and ensured that all parts of the software and its GUI were covered.