Concept Template
Template for explanation docs — understanding-oriented documentation that covers the "what" and "why" of a system behavior, mechanism, or domain concept.
Scaffold this template with ciderpress draft --type explanation.
Rules
- H1 is a single noun or short phrase — the concept name
- One-liner immediately after H1 — what this concept is and what role it plays
- One concept per document — if you're covering two ideas, split into two docs
- Inverted pyramid — start broad (definition, scope), narrow into detail
- Answer "why" — rationale, design reasoning, tradeoffs, alternatives considered
- Use analogies and concrete examples to bridge abstract ideas
- Diagrams encouraged — place near the top, under the overview
- No step-by-step instructions — link to how-to guides
- No API signatures or field tables — link to reference docs
- No marketing or persuasive language — explain, don't sell
- Lead with a definition — the first sentence of Overview should complete the phrase "X is..."
- Max 5 links per group in References
Structure
Template
References
- Types — the seven doc types
- Diataxis — Explanation — framework reference
- The Good Docs Project — Concept — community template patterns