runbook-generator

What This Skill Does

The Runbook Generator is a powerful SRE and DevOps automation tool designed to transform raw codebases into professional, production-grade operational documentation. By programmatically scanning repository configurations—such as CI/CD workflows, database schemas, and hosting manifests—it auto-detects your specific infrastructure stack. It then synthesizes this data into structured, step-by-step runbooks. Each runbook includes critical components like copy-paste CLI commands, verification checks, rollback procedures, and multi-tier escalation paths. Furthermore, it manages the lifecycle of your documentation through staleness detection, which monitors source configuration file modification dates to flag when your operational procedures might be out of sync with your actual environment.

Installation

To integrate this skill into your environment, use the OpenClaw command-line interface. Ensure you have the necessary repository permissions to pull from the skill source. Execute the following command in your terminal:

clawhub install openclaw/skills/skills/alirezarezvani/runbook-generator

Once installed, the agent will have the permissions required to traverse your repository file system and analyze your infrastructure-as-code files.

Use Cases

• Rapid Onboarding: Quickly generate a comprehensive "Getting Started" operational manual for new engineers, covering deployments, log access, and database maintenance.
• Disaster Recovery Preparedness: Generate and rehearse incident response runbooks to ensure that every team member knows how to execute a rollback or failover during an outage.
• Audit & Compliance: Use the generator to create standardized documentation for existing services that lack formal runbooks, helping meet industry compliance standards like SOC2 or ISO 27001.

Example Prompts

1. "Generate a deployment runbook for this repo. Detect my hosting stack and include a clear rollback procedure in case the new version fails health checks."
2. "Review the current database configuration in this repo and write an incident response runbook for handling a high-latency PostgreSQL spike."
3. "Create an escalation path for our CI/CD pipeline, detailing the L1 through L3 criteria based on our current GitHub Actions workflow."

Tips & Limitations

To get the best results, ensure your configuration files (e.g., docker-compose.yml, terraform/, or vercel.json) are well-maintained. The skill relies heavily on these files to detect your stack correctly. If your environment uses non-standard file naming conventions, the auto-detection may require manual overrides or additional context provided by the user. Note that while the tool generates excellent foundations, it should not replace human verification of destructive commands like database truncations or infrastructure tear-downs; always treat generated commands as suggestions that require expert validation.