agentleFS
Sign inStart free
OneWave-AIOneWave-AI/claude-skills/runbook-generator/SKILL.md

runbook-generator

Skill378 starsChanged 52 days agoMITView on GitHub

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.

9 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 9 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read key configuration. Open and analyze the config files listed in references/discovery-patterns.md (Step 2): IaC, containers, CI/CD, app …

    line 20
  2. Very specific:

    Verify and flag gaps. Confirm referenced paths and scripts exist.

    line 24

“Common” is measured: kept by at least 6 in 10 of the 9 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
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

  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.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free