agentleFS
Sign inStart free
rpraharajrpraharaj/ai-sdlc/skills/write-runbook/SKILL.md

write-runbook

Skill0 starsChanged 16 days agoMITView on GitHub

Write an operational runbook — diagnose, mitigate, escalate. Use when the user asks for a runbook, ops guide, incident playbook, or /write-runbook. Do not invent dashboards or on-call. Do not perform production changes.

5 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use release-notes.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • Microsoft AzureSkill

    release-notes

    Author and update release notes for Azure App Configuration libraries and providers. USE FOR: write release notes, add release note entry, update release notes, draft release notes, new version release notes, format release notes. DO NOT USE FOR: generating changelogs from git history, writing internal engineering notes.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 4 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 5 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Do not implement product code.

    line 19
  2. Distinctive:

    If there is no named failure mode, stop and ask which one.

    line 37
  3. Very specific:

    Read AGENTS.md if present.

    line 47
  4. Distinctive:

    Read the design, NFR, or incident doc that names this failure mode.

    line 48
  5. Distinctive:

    Never include credentials, tokens, or production data.

    line 55

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

Write runbook

Tell on-call how to recognize, mitigate, and escalate one failure mode. This is not incident command (incident-triage), not a design (write-design), and not a deploy (cut-release).

Do not implement product code. Do not run production commands. Do not invent dashboards, pager rotations, or SLOs.

Is this the right skill?

SignalDo this instead
An incident is happening nowincident-triage
Quality targetswrite-nfr
What to observe on a new featurespec-observability
Spoken rollback for a releaseplan-rollback — may link here
How the system is shapedwrite-architecture

Required inputs

  • The failure mode (from a design, incident, or production-pass note)
  • context/environments.md and context/decision-rights.md if they exist
  • context/systems-of-record.md for the observability and identity systems

If there is no named failure mode, stop and ask which one. Do not write “generic production support.”

Human decisions (do not invent)

  • Who is escalated to
  • Whether a mitigate step may run in production (document only; a human runs it)
  • Any SLO or page threshold not already written

Procedure

  1. Read AGENTS.md if present. Read context/environments.md, context/decision-rights.md, and context/systems-of-record.md if present.
  2. Read the design, NFR, or incident doc that names this failure mode.
  3. Find the home: first existing docs/runbooks/, or offer to create it. Name: docs/runbooks/<slug>.md.
  4. Open references/runbook-template.md. Copy every heading. Write n/a when unused.
  5. Symptoms must be observable with a system in systems-of-record.md or marked unknown.
  6. Diagnose and mitigate steps are commands or console clicks this program already has. If unknown, write unknown — do not invent a vendor UI.
  7. Escalate names a role from decision-rights.md or unassigned.
  8. Rollback is one spoken sentence plus steps, or n/a with why.
  9. Never include credentials, tokens, or production data.

Output

  • Path: docs/runbooks/<slug>.md
  • Template: references/runbook-template.md

Quality bar

  • One failure mode in the title
  • Symptoms are observable or unknown
  • Mitigate does not require unattended prod from an agent
  • Escalate names a role or unassigned
  • No secrets
  • Unused headings are n/a

Done

  1. Path
  2. Failure mode in one sentence
  3. Next skill: plan-rollback, incident-triage if live, or spec-observability if signals are unknown

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