agentleFS
AsiaOstrichAsiaOstrich/EngramGraph/.agents/skills/runbook-assistant/SKILL.md

runbook

Skill4 starsChanged 29 days agoMITView on GitHub

Guide runbook creation, maintenance, and drill exercises. Use when: writing runbooks, planning drills, auditing runbook coverage, post-incident runbook updates. Not for: responding to an incident already in progress — use /incident; the deployment procedure itself — use /deploy. Keywords: runbook, operations, drill, on-call, procedure.

25 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use ship.

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

    ship

    Finalize dev work on an issue branch — update docs, push, and open a PR.

    Also in 4 projects that use this

The file

Files
SKILL.md

Runbook Assistant | Runbook 助手

Language: English | 繁體中文

Guide runbook writing, maintenance, drill exercises, and coverage reporting.

引導 Runbook 撰寫、維護、演練和覆蓋率報告。

Capabilities | 功能

CapabilityDescription說明
Create RunbookGenerate runbook from standard template (7 sections)從標準範本產生 Runbook
Drill PlanningSchedule and record drill exercises規劃和記錄演練
Coverage ReportCheck runbook coverage for P1-P4 alerts檢查告警的 Runbook 覆蓋率
Quality ReviewVerify runbook quality (6 principles)驗證 Runbook 品質
Staleness CheckIdentify overdue runbook reviews識別過期需審查的 Runbook

Usage | 使用方式

/runbook                              # Show runbook guide
/runbook create "api-latency-high"    # Create runbook for alert
/runbook drill                        # Plan drill exercises
/runbook coverage                     # Generate coverage report

Next Steps Guidance | 下一步引導

Runbook 引導完成。建議下一步:

  • 執行 /observability --alerting 連結告警到 Runbook ⭐ 推薦
  • 執行 /incident --postmortem 從事故更新 Runbook
  • 執行 /checkin 提交變更

Deploy Runbook — Mandatory Rule

Any deploy runbook that includes a destructive-update pattern (stop → swap → start) MUST follow the Defensive Deployment Ordering sequence: extract to staging → verify → only then touch the live install. Skipping the verify step has caused real production outages.

任何包含 destructive-update(stop → swap → start)的部署 runbook 必須遵循 Defensive Deployment Ordering 順序:解壓到 staging → verify → 通過後才動 live install。跳過 verify 步驟已造成真實生產事故。

Reference | 參考

  • Detailed guide: guide.md — runbook creation, organization and validation. Read it when writing runbooks, reviewing operational procedures, planning drills, or assessing coverage.
  • Core standard: runbook-standards.md
  • Related: alerting-standards.md
  • Related: postmortem-standards.md
  • Related: deployment-standards.md § Defensive Deployment Ordering — mandatory ordering for destructive deploys
  • Related: packaging-standards.md § Archive Format Integrity — upstream pair to defensive ordering

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.