I wrote and edited Sensu’s documentation, including API documentation, references, and user guides. I also maintained and improved the Hugo docs site and reworked the information architecture.
I worked with Typeform’s developers and managers to document three APIs and one SDK.
I wrote Zendesk help docs to support Pleexy’s users.
Imagine you’re trying to use some new software.
I worked with API consultant James Higginbotham to create a fill-in-the-blanks template for minimum API documentation.
This is example API documentation that I put together as I worked through Tom Johnson’s terrific course on documenting REST APIs.
I worked with another technical writer to create user guides for logging-while-drilling (LWD) software.
Do you ever roll your eyes at manuals?
When I worked at BioScience Writers, I wrote articles to help researchers improve their scientific manuscripts and build rapport with potential clients.
In 2016, I learned of static site generators and spent a lot of time reading the late, great Molly Ivins.
For this project, I wrote assembly procedures using videos as source material.
Sometimes, I run across a document that makes me wonder who is supposed to use it. It doesn’t always seem like the answer is a human being.
This document set is from a process improvement project.
When I was learning Markdown, I practiced by reproducing a work sample that I originally created in Microsoft Word.
This handbook was part of a technical editing project I completed for an offshore oil exploration and production company.
For this project, I worked with subject matter experts (SMEs) in several states to create a manual with 90 work practices.