API Docs
How to write concise endpoints, meaningful examples, and error-handling guidance so engineers can integrate quickly.
Read guide →Make docs people actually use
Practical advice, templates, and examples for writing clear technical documentation — API docs, user guides, runbooks, and more.
About
This is a personal website focused on the craft of creating useful technical documentation. I write about structure, tone, examples, and tooling (Markdown, static site generators, OpenAPI, DITA, and more).
User Guides
Structure user flows, include screenshots, and keep the steps actionable and scannable.
Read guide →Templates
Copy-paste friendly templates for README, changelogs, runbooks, and onboarding docs.
Browse templates →Templates
README — Quick project intro + how to run locally.
API Reference — Endpoint pattern, request/response examples, and status codes.
Runbook — Symptoms, checks, mitigation, post-incident steps.
Contact
Want a template or a doc review? Email your@email.example or open an issue on the repo.