Runbook Generator
Generates operational runbooks from a service name, producing a structured skeleton with standard sections for deployment, incident response, maintenance, and rollback workflows. It helps standardize on-call documentation and can be customized per environment.
✨ What it does
- Generates runbook skeleton from a CLI.
- Includes standard sections for start/stop/health/rollback.
- Provides structured escalation and incident handling placeholders.
- Offers reference templates for deployment and incident playbooks.
- Supports custom owner and output file options.
🎯 When to use it
- 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.
🚀 How to use
Trigger by running the CLI script with a service name. Optionally specify --owner and --output. The script prints to stdout or writes a file. Example prompts:
python3 scripts/runbook_generator.py payments-api
python3 scripts/runbook_generator.py payments-api --owner platform --output docs/runbooks/payments-api.md
📄 Output: A markdown runbook file (or stdout output) with a structured skeleton for the specified service.
📦 Add this skill to Claude Code
# 1. Get the skills repo
git clone --depth 1 https://github.com/alirezarezvani/claude-skills /tmp/claude-skills
# 2. Copy this skill into your project (or ~/.claude/skills for all projects)
mkdir -p .claude/skills
cp -r /tmp/claude-skills/engineering/skills/runbook-generator .claude/skills/runbook-generatorSkill source: engineering/skills/runbook-generator/SKILL.md
⚠️ Good to know
Requires Python 3 and the script path; the generated skeleton must be customized with service-specific details.
❓ FAQ
How do I generate a runbook for a service?
Run the CLI script with the service name, e.g., python3 scripts/runbook_generator.py payments-api.
Can I specify an owner and output file?
Yes, use the --owner and --output options, e.g., --owner platform --output docs/runbooks/payments-api.md.
What sections are included in the generated runbook?
The runbook includes standard sections for start/stop/health/rollback, plus escalation and incident handling placeholders.
🤖 Overview, features, install steps and FAQ were generated from the project's SKILL.md on Sep 4, 2026. Always check the original source before running commands.