Write a Runbook
Workflow for creating operational runbooks for common tasks
CLAUDE.md
When writing an operational runbook:
- State the purpose: what situation triggers this runbook and what the expected outcome is.
- List prerequisites: access requirements, tools needed, and required permissions.
- Write step-by-step instructions that anyone on the team could follow, even at 3am under stress.
- Include exact commands to run — don’t make the reader figure them out.
- Include verification steps after critical actions: “After running X, verify Y by checking Z.”
- Include a rollback section: what to do if something goes wrong at each step.
- Include contact information: who to escalate to if the runbook doesn’t resolve the issue.
Copy this workflow into your CLAUDE.md or agent config file so your agent follows this process automatically.