agentleFS
abevzabevz/devops-skills/skills/runbook-writer/SKILL.md

runbook-writer

Skill0 starsChanged 41 days agoMITView on GitHub

Use when writing or improving an operational runbook for an alert, service, or recurring failure. Mention "write a runbook", "runbook for this alert", "on-call doc" as triggers.

3 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

10 rules. 0 are common, 6 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 3 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read the alert rule, dashboards, logs, and existing recovery instructions.

    line 18
  2. Distinctive:

    Do not offer an invasive command without a condition and a recovery path.

    line 22
  3. Distinctive:

    Follow the Workflow, Safety rules, and Quality checklist below.

    line 26
  4. Distinctive:

    Use when an alert, service, or recurring incident needs a runbook — or when an existing runbook failed the on-call engineer during the last …

    line 36
  5. Very specific:

    Write the diagnosis sequence: ordered, copy-pasteable, read-only commands (kubectl/logs/ PromQL/dashboard links), each with one line saying …

    line 51
  6. Distinctive:

    Write mitigations mapped to diagnoses: "if you saw X in step 3, do Y." Start with the safest effective action (scale up, feature-flag off, …

    line 54
  7. Very specific:

    NOT to run it. Rollbacks/restarts/deletions never appear bare.

    line 57
  8. Very specific:

    Do not run any of the commands while writing the runbook — this skill produces a document, not an intervention.

    line 67
  9. Distinctive:

    Every mutating command must carry an explicit warning and a "when not to do this" note.

    line 70
  10. Very specific:

    Do not invent thresholds, dashboard URLs, or team names — take them from provided context or leave a clearly marked TODO(owner) placeholder.

    line 71

“Common” is measured: kept by at least 6 in 10 of the 3 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 Writer

TL;DR checklist

  • State the triggering alert and user impact.
  • Put ordered read-only diagnosis before action.
  • Map each mitigation to the evidence that justifies it.

Key read-only checks

  • Read the alert rule, dashboards, logs, and existing recovery instructions.

Common pitfalls

  • Do not offer an invasive command without a condition and a recovery path.

Agent procedure

Follow the Workflow, Safety rules, and Quality checklist below.

Quick references

  • Workflow below.

Last verified: unverified

When to use

Use when an alert, service, or recurring incident needs a runbook — or when an existing runbook failed the on-call engineer during the last incident and needs fixing.

Goal

Produce a runbook a half-awake on-call engineer who has never touched this service can follow at 3 AM: what fired, what it means for users, exactly what to check, and exactly what to do — copy-pasteable, in order, with destructive steps unmistakably marked.

Workflow

  1. Identify the trigger: which alert(s) or symptom this runbook covers, and what the alert condition actually means in plain language.
  2. State user impact honestly: what is broken for whom while this fires, and how urgent it really is (drives whether the reader pages someone else or has coffee first).
  3. Write the diagnosis sequence: ordered, copy-pasteable, read-only commands (kubectl/logs/ PromQL/dashboard links), each with one line saying what output means what. Order by likelihood × cheapness — most likely cause checked first.
  4. Write mitigations mapped to diagnoses: "if you saw X in step 3, do Y." Start with the safest effective action (scale up, feature-flag off, shift traffic) before invasive ones.
  5. Mark every mutating command with an explicit warning line stating what it changes and when NOT to run it. Rollbacks/restarts/deletions never appear bare.
  6. Define escalation: when to stop (time-boxed — e.g. "15 minutes without progress"), who to page (team/role, not a person's name), and what context to hand over.
  7. Define verification: how to confirm recovery (the metric/query that should return to normal) — not just "the alert stopped firing."
  8. Link related material: dashboard, recent incidents of this class, architecture doc, the alert rule definition itself.

Safety rules

  • Do not run any of the commands while writing the runbook — this skill produces a document, not an intervention. Verify command syntax against the manifests/config available, and mark anything unverifiable as # UNVERIFIED — check before relying on this.
  • Every mutating command must carry an explicit warning and a "when not to do this" note.
  • Do not invent thresholds, dashboard URLs, or team names — take them from provided context or leave a clearly marked TODO(owner) placeholder.

Output format

# Runbook: <alert or failure name>

## Alert / trigger
## User impact & urgency
## Diagnosis (in order)
1. <command> — <what result means>
## Mitigation
- If <diagnosis result>: <action>   ⚠️ marked if mutating
## Escalation
## Verify recovery
## Links

Quality checklist

  • Every diagnosis command is copy-pasteable and read-only
  • Every mutating command has a warning and a "when not to" note
  • Escalation is time-boxed with a concrete page target
  • Recovery verification is a concrete signal, not "alert resolved"
  • Unknown values are marked TODO, not invented

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.