agentleFS
madeordinarymadeordinary/serel-memory/.agents/skills/runbook/SKILL.md

runbook

Skill1 starsChanged 18 days agoMITView on GitHub

Generate or update an operational runbook for a service or change. Use when the user asks for a runbook, ops doc, on-call guide, or deployment documentation.

25 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use incident, adr and 6 more.

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.
  • JkudjoSkill

    incident

    Production incident response — structured triage, hypothesis tree, safe remediation, incident record

    Also in 4 projects that use this

  • asterkinSkill

    adr

    Create Architecture Decision Records (ADRs) following project standards. Guides template usage, process, and best practices for documenting architecturally significant decisions.

    Also in 5 projects that use this

  • OpenAISkill

    observability

    Vercel Observability expert guidance — Drains (logs, traces, speed insights, web analytics), Web Analytics, Speed Insights, runtime logs, custom events, OpenTelemetry integration, and monitoring dashboards. Use when instrumenting, debugging, or optimizing application performance and user experience on Vercel.

    Also in 4 projects that use this

  • SentrySkill

    e2e

    Run E2E tests for Sentry JavaScript SDK test applications

    Also in 3 projects that use this

  • OpenAISkill

    audit

    Audit or critique a product flow, journey, workflow, funnel, onboarding path, checkout path, settings path, screen, or multi-step product experience by capturing screenshots first, then reporting UX, design, and accessibility findings inline from that evidence. Use Figma only when the user explicitly asks for a board. Use when the user asks to audit, review, critique, inspect, assess, analyze, evaluate, or give feedback on a product experience.

    Also in 4 projects that use this

  • MicrosoftSkill

    api-design

    Guide for designing and documenting RESTful APIs. Use when asked to design an API, create endpoints, or document an API.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 22 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If the user named a specific service, use that.

    line 15
  2. Very specific:

    Read relevant code, deploy config, and memory-bank/techContext.md for stack/hosting context.

    line 17
  3. Very specific:

    If a runbook already exists at docs/runbooks/<service>.md, read it and propose updates as a diff.

    line 18
  4. Very specific:

    Don't invent details. If you don't know the on-call rotation, write <TBD> rather than guessing.

    line 74

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

Produce an operational runbook entry for the service or change being made. This is for the person on-call at 3am, not for the developer who already knows the codebase.

Scope: resolve which bank this targets per "Resolving scope" in docs/workflow-contract.md — an optional --scope <path> argument selects a project bank when the repo configures scopes; otherwise the root bank, as always.

Workflow

  1. Determine the target:
    • If the user named a specific service, use that.
    • Otherwise, infer from the current branch or changes — what's being deployed?
  2. Read relevant code, deploy config, and memory-bank/techContext.md for stack/hosting context.
  3. If a runbook already exists at docs/runbooks/<service>.md, read it and propose updates as a diff.

Output

Produce a runbook in this structure:

# Runbook: [service name]

## What this is
[one paragraph — what does this service do, who depends on it]

## Where it runs
- Hosting: [e.g., AWS App Runner, Render, ECS]
- Region(s):
- Deploy method: [e.g., GitHub Actions → ECR → App Runner]
- Repo / branch:

## How to run it locally
[exact commands for each step]
```bash
# clone
# install
# env
# start
```

## How to deploy
[steps, prerequisites, who can press the button]

## Health & monitoring
- Healthcheck URL:
- Logs: [where, how to tail — exact commands]
- Metrics dashboard:
- Alerts: [what fires, where it goes]

## Common failure modes
| Symptom | Likely cause | Diagnose | Fix |
|---------|--------------|----------|-----|
|         |              |          |     |

## Rollback procedure
[exact steps to roll back the last deploy, with commands]

## Who to page
[on-call rotation or contact for ownership questions]

## Recent changes
[link to last few deploys / changelog entries]

Save to docs/runbooks/<service>.md. Create the directory if needed. If a runbook already exists there, propose updates as a diff before overwriting.

Rules

  • Be specific. "Check the logs" is useless. aws logs tail /aws/apprunner/foo --follow | grep ERROR_TIMEOUT is a runbook.
  • Don't invent details. If you don't know the on-call rotation, write <TBD> rather than guessing.
  • Failure modes need a real diagnose step, not just "investigate."

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.