runbook-generator
Installation
SKILL.md
Runbook Generator
Generate a comprehensive operational runbook.md from a system's codebase, infrastructure config, and deployment scripts -- written for on-call engineers working incidents, deployments, and routine operations at 3am.
Contents
references/discovery-patterns.md-- Glob/Grep patterns and config files to inspect during discovery.references/output-template.md-- The full 9-section runbook.md structure to populate.references/writing-style.md-- Clarity, urgency, completeness, formatting, and accuracy rules plus output requirements.
Workflow
- Discover the system. Run the Glob patterns in
references/discovery-patterns.md(Step 1) to identify the stack and infrastructure. - Read key configuration. Open and analyze the config files listed in
references/discovery-patterns.md(Step 2): IaC, containers, CI/CD, app config, deploy scripts, monitoring, migrations, load balancers, docs. - Identify operational behavior. Run the Grep patterns in
references/discovery-patterns.md(Step 3) to surface health checks, metrics, caching, jobs, migrations, rollback, scaling, backups, TLS, secrets, alerting, and more. - Generate the runbook. Produce
runbook.mdfollowing the structure inreferences/output-template.md. Cover all 9 sections; adapt content to what discovery found; never include purely speculative sections. - Apply writing standards. Follow every rule in
references/writing-style.md-- copy-pasteable commands, expected outputs, sequential steps, P1-first ordering, tables for structured data, and the accuracy rules. - Verify and flag gaps. Confirm referenced paths and scripts exist. Mark unverifiable details with
[VERIFY]and missing sections with[ACTION REQUIRED]: ...so the runbook doubles as a gap analysis.