runbook-generator

---
name: runbook-generator
description: Use when generating operational runbooks for services, standardizing on-call procedures, or documenting deployment and incident response workflows.
category: Engineering
version: 1.0.0
tools: []
---

# Runbook Generator

Generate operational runbooks quickly from a service name, then customize for deployment, incident response, maintenance, and rollback workflows.

## Core Capabilities

- Generate runbook skeleton from a service name
- Include standard sections: start/stop, health checks, rollback procedures
- Provide escalation and incident handling structure
- Support deployment, incident, and maintenance playbooks

## When to Use

- A new service has no runbook and needs baseline documentation immediately
- Existing runbooks are inconsistent across teams
- On-call onboarding requires standardized operations documentation
- Need repeatable scaffolding for similar services

## Recommended Workflow

1. Generate the initial skeleton with service name and owner.
2. Fill in service-specific commands, health check URLs, and contacts.
3. Add verification steps and rollback triggers specific to service.
4. Dry-run procedures in staging environment.
5. Store runbook in version control near service code.
6. Schedule periodic reviews and update after incidents.

## Runbook Structure

Each runbook includes:

**Startup & Health**
- Service startup procedure with expected output checks
- Health check command and success criteria
- Dependencies verification

**Incident Response**
- Recognition: how to detect the problem
- Triage: initial diagnostic steps
- Recovery: step-by-step remediation
- Escalation: when and who to contact

**Rollback**
- Rollback trigger conditions
- Rollback commands (copy-pasteable)
- Verification after rollback

**Maintenance**
- Regular maintenance tasks and frequency
- Configuration changes
- Dependency updates

## Best Practices

1. Every command must be copy-pasteable
2. Include expected output after...