Templates
Type: ExplanationCreated: Last reviewed: Team: Platform
published
What templates are for
A template per doc type. They're reference examples, not enforcement — copy one when you start a doc to skip the blank-page problem and inherit a valid frontmatter shape and a sensible heading skeleton. The validator enforces the actual rules; templates just show what a conforming doc looks like.
The seven templates
| Template | Doc type |
|---|---|
| Tutorial Template | tutorial — guided learning by doing |
| How-to Template | how-to — task-oriented recipe |
| Reference Template | reference — flat lookup |
| Explanation Template | explanation — narrative context |
| ADR Template | adr — architectural decision (frozen) |
| Runbook Template | runbook — operational playbook |
| Postmortem Template | postmortem — incident retrospective (frozen) |
When templates change
Templates are examples, not enforcement (see above) — editing a template's sections needs no validator change. The one coupling that matters: when you add or remove a doc type, add or remove its template in the same PR as the shared/doc-types.ts entry, so every type has exactly one template.