All work

Technical Writing

I write documentation that helps people get things done, whether they're developers integrating an API or colleagues learning a new process. I've documented APIs with ReadMe and Sphinx, and I've created training guides, manuals, and step-by-step instructions. Whatever the format, I start with the reader's question and work backward to the clearest answer.

API Documentation Example

The Ask

Update a 15-year-old unmanaged developer site, plagued with duplicate information, broken links, and an impossible-to-navigate UI. Improve inconsistent English and tone caused by years of neglect and contributions from non-native speakers. Do it all in a 6-month time frame.

The Strategy

Start by eliminating dead links and duplicate pages. Update the information architecture. Partner with SMEs and stakeholders over dozens of interviews, targeting bad examples and inaccurate information. Apply new writing standards and improved code examples.

The Result

Support tickets reduced by 25%, reduced custom code requests, improved SEO.

API documentation site, screenshot 2
API documentation site, screenshot 3