| name | docs-runbook |
|---|---|
| description | Use when a change affects operations, support, incident response, rollout, rollback, or recovery workflows. |
Use when the change affects operation, support, incident response, rollout, rollback, or recovery workflows.
docs/runbooks/<slug>.md
- production procedures
- support and troubleshooting flows
- deployment and rollback routines
- incident response and escalation guidance
- Purpose
- Preconditions and required access
- Triggers or symptoms
- Step-by-step actions
- Verification points
- Rollback or escalation path
- Write for action under pressure: concrete steps beat abstract explanation.
- Keep commands, checks, and handoff points easy to scan.
- Update the live runbook before creating a duplicate.
- If the workflow will not be reused, keep it transient instead of promoting it to durable documentation.