Writing samples from 7 years of API and developer documentation. All samples are production-style — they reflect the format, depth, and voice I use in real documentation.
Author: Tyra Miles — Portfolio · LinkedIn
| File | Type | What it demonstrates |
|---|---|---|
openapi.yaml | OpenAPI 3.1 spec | Full API spec authorship — schemas, parameters, reusable components, response examples, error documentation |
quickstart-nodejs.md | Developer quickstart | Step-by-step onboarding guide with working code, inline explanations, and troubleshooting |
subscription-state-transitions.md | Conceptual guide | State machine documentation with diagrams, integration gotchas, and code examples |
payment-gateway-errors.md | Error reference | Structured error taxonomy with resolution paths, code samples in 2 languages, and customer-facing copy |
changelog-q2-2024.md | Changelog | Developer-facing release notes covering new features, breaking changes, and deprecations |
These samples are based on my work at Chargebee, where I owned developer documentation for the billing API from 2022 to present. The outcomes from this work:
- 58% reduction in developer support tickets after the API reference rebuild
- 88% faster time-to-first-API-call (from 3.2 days to under 4 hours)
- 3× increase in documentation coverage across the developer hub
I write documentation that reduces developer support load, shortens integration time, and gives engineers the context they need to make decisions — not just the syntax.
If you're hiring for a senior technical writer or developer documentation engineer, I'd like to talk.