Runbook generator
Generate operational runbooks from a service name — deployment, incident response, maintenance, and rollback workflows.
How to use it
Claude Code
- Run the line below. It pulls the whole folder into
~/.claude/skills/runbook-generator. - Describe your job in plain words. Claude Code follows the skill from there.
Claude Code — installs the whole folder, not just SKILL.md
npx degit alirezarezvani/claude-skills/engineering/skills/runbook-generator#main ~/.claude/skills/runbook-generatorFor one project only, change the path to .claude/skills/runbook-generator.
Claude (web or desktop app)
- On this page open ⋯ → Download .md.
- Save it as SKILL.md in a folder, zip the folder, then Customize → Skills → + → Create skill → Upload a skill.
- Pick the file and Save. Claude shows the name and description and runs a security scan.
- Check the skill is switched on.
- Start a new chat and describe your job in plain words. The AI follows the skill from there.
ChatGPT or another app
- ChatGPT: make a Project and paste it into Instructions.
- Neither? Paste it at the top of a new chat — it works for that chat.
Not working?
- Check which app you pasted it into — the steps above name the right one.
- Some skills need the paid tier of Claude or ChatGPT.
Paste into Claude, ChatGPT or Cursor.
Source of Runbook generator
Show the full text77 lines
| name | description |
|---|---|
| runbook-generator | Generate operational runbooks from a service name — deployment, incident response, maintenance, and rollback workflows. Templated structure customizable per environment. Use when documenting on-call procedures for a new service, standardizing incident response across teams, or producing runbooks before launching to production. |
Runbook Generator
Tier: POWERFUL
Category: Engineering
Domain: DevOps / Site Reliability Engineering
Overview
Generate operational runbooks quickly from a service name, then customize for deployment, incident response, maintenance, and rollback workflows.
Core Capabilities
- Runbook skeleton generation from a CLI
- Standard sections for start/stop/health/rollback
- Structured escalation and incident handling placeholders
- Reference templates for deployment and incident playbooks
When to Use
- A service has no runbook and needs a baseline immediately
- Existing runbooks are inconsistent across teams
- On-call onboarding requires standardized operations docs
- You need repeatable runbook scaffolding for new services
Quick Start
# Print runbook to stdout
python3 scripts/runbook_generator.py payments-api
# Write runbook file
python3 scripts/runbook_generator.py payments-api --owner platform --output docs/runbooks/payments-api.md
Recommended Workflow
- Generate the initial skeleton with
scripts/runbook_generator.py. - Fill in service-specific commands and URLs.
- Add verification checks and rollback triggers.
- Dry-run in staging.
- Store runbook in version control near service code.
Reference Docs
references/runbook-templates.md
Common Pitfalls
- Missing rollback triggers or rollback commands
- Steps without expected output checks
- Stale ownership/escalation contacts
- Runbooks never tested outside of incidents
Best Practices
- Keep every command copy-pasteable.
- Include health checks after every critical step.
- Validate runbooks on a fixed review cadence.
- Update runbook content after incidents and postmortems.
| 1 | |
| 2 | name "runbook-generator" |
| 3 | description "Generate operational runbooks from a service name — deployment, incident response, maintenance, and rollback workflows. Templated structure customizable per environment. Use when documenting on-call procedures for a new service, standardizing incident response across teams, or producing runbooks before launching to production." |
| 4 | |
| 5 | |
| 6 | # Runbook Generator |
| 7 | |
| 8 | **Tier:** POWERFUL |
| 9 | **Category:** Engineering |
| 10 | **Domain:** DevOps / Site Reliability Engineering |
| 11 | |
| 12 | |
| 13 | |
| 14 | ## Overview |
| 15 | |
| 16 | Generate operational runbooks quickly from a service name, then customize for deployment, incident response, maintenance, and rollback workflows. |
| 17 | |
| 18 | ## Core Capabilities |
| 19 | |
| 20 | Runbook skeleton generation from a CLI |
| 21 | Standard sections for start/stop/health/rollback |
| 22 | Structured escalation and incident handling placeholders |
| 23 | Reference templates for deployment and incident playbooks |
| 24 | |
| 25 | |
| 26 | |
| 27 | ## When to Use |
| 28 | |
| 29 | A service has no runbook and needs a baseline immediately |
| 30 | Existing runbooks are inconsistent across teams |
| 31 | On-call onboarding requires standardized operations docs |
| 32 | You need repeatable runbook scaffolding for new services |
| 33 | |
| 34 | |
| 35 | |
| 36 | ## Quick Start |
| 37 | |
| 38 | |
| 39 | # Print runbook to stdout |
| 40 | python3 scripts/runbook_generator.py payments-api |
| 41 | |
| 42 | # Write runbook file |
| 43 | python3 scripts/runbook_generator.py payments-api --owner platform --output docs/runbooks/payments-api.md |
| 44 | |
| 45 | |
| 46 | |
| 47 | |
| 48 | ## Recommended Workflow |
| 49 | |
| 50 | Generate the initial skeleton with `scripts/runbook_generator.py`. |
| 51 | Fill in service-specific commands and URLs. |
| 52 | Add verification checks and rollback triggers. |
| 53 | Dry-run in staging. |
| 54 | Store runbook in version control near service code. |
| 55 | |
| 56 | |
| 57 | |
| 58 | ## Reference Docs |
| 59 | |
| 60 | `references/runbook-templates.md` |
| 61 | |
| 62 | |
| 63 | |
| 64 | ## Common Pitfalls |
| 65 | |
| 66 | Missing rollback triggers or rollback commands |
| 67 | Steps without expected output checks |
| 68 | Stale ownership/escalation contacts |
| 69 | Runbooks never tested outside of incidents |
| 70 | |
| 71 | ## Best Practices |
| 72 | |
| 73 | Keep every command copy-pasteable. |
| 74 | Include health checks after every critical step. |
| 75 | Validate runbooks on a fixed review cadence. |
| 76 | Update runbook content after incidents and postmortems. |
| 77 |
Discussion
Systematic debuggingUse when encountering any bug, test failure, or unexpected behavior, before proposing fixesVerification before completionUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysDebugging strategiesMaster systematic debugging techniques, profiling tools, and root cause analysis to efficiently track down bugs across any codebase or technology stack. Use when investigating bugs, performance issues, or unexpected behavior.Error handling patternsMaster error handling patterns across languages including exceptions, Result types, error propagation, and graceful degradation to build resilient applications. Use when implementing error handling, designing APIs, or improving application reliability.
Browse more free Claude skills or everything in Development.