markdowndeeb25a2 | 1 | # Documentation templates |
| 2 | |
| 3 | These templates are meant to be **copied** into a concrete doc (ADR / feature doc / module doc) and then filled in. |
| 4 | |
| 5 | They work together with doc correspondence (ADR 0061 / 0155): |
| 6 | - if a file/feature has **no docs**, the UI can suggest a template to start with; |
| 7 | - an agent can be asked to “fill template X for feature Y” using the correspondence scope. |
| 8 | |
| 9 | ## Templates |
| 10 | |
| 11 | - `feature.md`: feature-level documentation (scope, UX, invariants, knobs, links) |
| 12 | - `module.md`: subsystem/module overview (contracts, responsibilities, dependencies) |
| 13 | - `adr-mini.md`: small ADR skeleton (problem → decision → consequences) |
| 14 | - `runbook.md`: operational runbook (how to debug/operate) |
| 15 | |
| 16 | |
View only · write via MCP/CIDE