DocsTemplates
Templates
A starting point for each kind of doc. Copy one, or run `npm run new:doc` to create it with the header filled in.
Updated Oct 1, 202611 pages
Documents
Everything in this section.
- ADR templateOne decision per record. Do not edit an accepted record, supersede it with a new one. Delete every template comment before committing.
- API templateDocument every endpoint the same way. Use placeholders for real hosts, tokens and ids. Delete every template comment before committing.
- Architecture templateExplain how the system is built and why. Prefer a diagram plus the reasoning over a list of files. Delete every template comment before committing.
- Changelog templateThis file is normally generated (gitaiflow --changelog). Newest release first. Delete every template comment before committing.
- Deployment templateDescribe how to ship and how to undo it. State the environment each step runs in. Delete every template comment before committing.
- Guide templateA guide helps the reader finish one task. Say who it is for and what they will have at the end. Delete every template comment before committing.
- Overview templateOne short paragraph: what this is and who it is for. Delete every template comment before committing.
- Reference templateReference is looked up, not read top to bottom. Keep every entry in the same shape and keep it complete. Delete every template comment before committing.
- Release Notes templateRelease notes describe one release. `since` is the version this page describes. Delete every template comment before committing.
- Runbook templateA runbook is read under pressure. Put the symptom first, keep steps numbered and copy-pasteable. Delete every template comment before committing.
- System Design templateThe long form of an architecture doc, for a whole system. For one component use the architecture template. Delete every template comment before committing.