Notes on these samples:

  • These samples are from 2018. Other documentation samples available to be shown privately.

  • I created each of these guides from conception through completion. 
    Note: These documents are as they were when I left the company. If you look at the current versions of these documents at their source, they may be different.

  • I interviewed SMEs and did my own product testing to gain the content for each guide.

  • I also did the information design for each user guide based on existing guides and my own understanding of the audience. 

  • These guides were reviewed by the relevant subject matter experts for content accuracy and were peer reviewed by another technical writer. All of the edits from these reviews were done by me from their comments.

  • The code samples were a mix of developer written code, code I wrote from their examples, and my own testing. 

  • The three SDK guides were all written at the same time because the re-worked SDKs were being released at the same time. The existing SDKs were C SDK wrappers. They weren’t really customized well to the language. Each SDK was reworked. At the time, there was no existing user documentation, so I wrote all three guides in a little more than 3 months.

  • The Data Hauler User’s Guide was written in pieces. It started out as an intern project, and then it was finalized about 6 months later.