New Runbook
Create a reusable procedure under the active knowledge root, normally ~/docs/runbooks/.
Boundary
- Do not execute the procedure while authoring it.
- Do not infer steps that were never verified.
- Do not commit or push the artifact.
- Do not copy secrets, tokens, raw logs, or ephemeral identifiers into the runbook.
Sources
Read the knowledge-base contract and the narrowest relevant evidence:
- completed maintenance logs;
- code-session logs;
- accepted ADRs;
- standards and enforcement docs;
- current version-controlled configuration;
- official upstream documentation.
A runbook derived from one maintenance event must generalize carefully. Preserve host-specific constraints only when they are genuinely required.
Frontmatter
Use title, created, updated, status, kind: runbook, scope, validated-on, sources, and related as flat values.
Required sections
- Purpose
- Scope and exclusions
- Preconditions
- Required access and tools
- Safety and backup checks
- Procedure
- Verification
- Rollback
- Known failure modes
- Escalation or stop conditions
- References and source logs
- Revision triggers
Mark the runbook draft until its procedure and rollback have been observed or deliberately rehearsed. Print the final path and stop.