Objective

Documenting a software that was in developmental progress. The challenge was to produce an accurate and usable guide that was visually pleasing, while keeping up with potential changes to the functions and interface of the software.

Description

To achieve a Getting Started Guide for SpectrUW, I worked closely with the developer and project lead. I initially wrote the software guide in Microsoft Word, but moved to LaTeX towards the end of the development process. LaTeX has the ability to change the typeset appearance of text extensively and consistently, in addition to automatically generating running numbers in figures and section headers. The result is also a more visually appealing document.
The documentation took six months to complete. Collaboration played an important part since the software was going through changes while I was documenting it. I had to work closely with the team to be on a constant lookout for potential changes to ensure the accuracy and completeness of the software guide.