documentation · git:20260428.3e00277 · 2026-04-28 · sha256 34e45616b9f52929
documentation git:20260428.3e00277A
Immutable. This exact content never changes and is served at /api/v1/blob/34e45616b9f52929.
--- name: documentation description: "Create Architecture Decision Records (ADRs) and Runbooks for operational documentation." autoInvoke: false priority: medium triggers: - "ADR" - "runbook" - "architecture decision" user-invocable: false --- # Documentation (ADR & Runbook) ## When to Create - **ADR:** Technology choices, architectural changes, new patterns, deprecations - **Runbook:** Service deployment, common ops tasks, incident response ## ADR Template ```markdown # ADR-[N]: [TITLE] **Status:** Proposed | Accepted | Deprecated | Superseded by ADR-X **Date:** YYYY-MM-DD ## Context — ## Decision — ## Options Considered — ## Consequences ``` Location: `docs/adr/ADR-NNN-description.md`. Keep immutable — supersede, don't edit. ## Runbook Template ```markdown # Runbook: [Service] **Owner:** [Team] | **On-Call:** [Contact] ## Prerequisites — ## Common Operations — ## Troubleshooting — ## Alerts & Escalation ``` Location: `docs/runbooks/service-name.md`. Test commands before documenting. ## Principles - ADR: clear problem, options evaluated, consequences documented - Runbook: commands copy-paste-ready, escalation path defined