Runbook Generator
Generates comprehensive operational runbooks for any system or process. Reads codebase, infrastructure config, and deployment scripts to produce structured runbook.md files formatted for on-call engineers. Use when you need operations documentation, incident response guides, deployment procedures, or disaster recovery plans.
What it does
# 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 1. Discover the system. Run the Glob patterns in `references/discovery-patterns.md` (Step 1) to identify the stack and infrastructure. 2. 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. 3. 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. 4. Generate the runbook. Produce `runbook.md` following the structure in `references/output-template.md`. Cover all 9 sections; adapt content to what discovery found; never include purely speculative sections. 5. 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. 6. 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. ## Output Write `runbook.md` to the project root (or a directory the user specifies). It must be 500+ lines, cover all 9 sections, contain real commands derived from the codebase, include at least one architecture diagram, carry a complete table of contents, and never fabricate infrastructure details. See `references/writing-style.md` for the full output checklist.
More engineering skills
API Documentation Writer
Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs. Creates OpenAPI/Swagger specs, REST API docs, and developer-friendly reference materials. Use when users need to document APIs, create technical references, or write developer documentation.
API Endpoint Scaffolder
Generate REST API endpoints with proper structure, validation, error handling, and types. Use when creating new API routes, endpoints, or backend services.
API Load Tester
Load tests API endpoints with progressive concurrency. Measures response times, error rates, throughput, and identifies breaking points. Generates a detailed report with latency percentiles, throughput curves, bottleneck analysis, and optimization recommendations.
Before You Build
Use before starting a product, feature, MVP, agent, automation, or integration build to identify the main pre-build risk and choose the smallest validation step. Trigger when the user asks whether to build, scope, validate, prioritize, or sanity-check an idea before implementation.