Runbook Generator
Generate clear operational runbooks — step-by-step procedures for deployments, incident response, disaster recovery, and routine maintenance tasks.
What this skill does
Create clear, standardized procedures for deployments, incident response, and routine maintenance without starting from scratch. You receive reliable documentation for critical tasks, ensuring everyone follows the same steps during an incident. Use this whenever onboarding new services or when existing documentation needs consistency across your engineering team.
name: “runbook-generator” description: “Runbook Generator”
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.
Install this Skill
Skills give your AI agent a consistent, structured approach to this task — better output than a one-off prompt.
npx skills add alirezarezvani/claude-skills --skill engineering/runbook-generator Community skill by @alirezarezvani. Need a walkthrough? See the install guide →
Works with
Prefer no terminal? Download the ZIP and place it manually.
Details
- Category
- Development
- License
- MIT
- Author
- @alirezarezvani
- Source
- GitHub →
- Source file
-
show path
engineering/runbook-generator/SKILL.md
People who install this also use
Incident Commander
Lead incident response from detection to resolution — coordinate teams, run war rooms, draft status updates, and produce postmortems.
@alirezarezvani
Senior DevOps Engineer
CI/CD pipeline design, Infrastructure as Code, containerization with Docker and Kubernetes, and deployment automation from a senior DevOps perspective.
@alirezarezvani
Observability Designer
Design comprehensive observability for distributed systems — metrics, logs, traces, alerting rules, and dashboards that surface real problems fast.
@alirezarezvani