Skip to content

Engineering Runbook Writer

Produces a single-page HTML engineering runbook with alerts, procedures, on-call and incident steps

Stars
105,448
Licence
Apache-2.0
Files
2 files

What it does

Once installed, when you ask the agent for an ops doc, on-call guide or runbook for a service, it follows a fixed layout: a header with service name, owner, severity and version, an alerts table, dashboard links, 3-4 common procedures with copy-paste commands, an on-call rotation table, and a five-step incident response checklist. The output is one self-contained HTML page styled to match a design system file (DESIGN.md) if present. It is a template for writing documentation, not a monitoring tool.

Great for

  • Engineers or SRE teams who need a first draft of a service runbook quickly
  • Teams standardising the structure of their on-call documentation
  • Anyone who already has the service details and wants them laid out consistently

Skip it if

  • Live incident response: the skill only writes a document and cannot check real alerts, dashboards or systems
  • Generating commands for production without review: the procedures (deploy, rollback, key rotation) are written by the model and may be wrong for your environment

Try asking

  • “Write a runbook for our auth service covering alerts, dashboards, common procedures and on-call rotation.”
  • “Create an on-call guide for our payments API as a single HTML page.”
  • “Make an SRE doc for the search cluster with a rollback procedure and incident checklist.”
Step-by-step guide: how to use Engineering Runbook WriterInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 2 original files, the Apache-2.0 licence and an attribution note.

    eng-runbook.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip eng-runbook.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip eng-runbook.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Give the agent real service details: owner team, severity tiers, alert names and dashboard URLs, so the page is not filled with invented placeholders.
  • Check every copy-pasteable command and key-rotation step against your own tooling before anyone relies on it during an incident.
  • Keep the generated HTML in version control so runbook changes are reviewed like other code.

What's inside

  • example.html
  • SKILL.md

Redistributed unmodified from nexu-io/open-design under the Apache-2.0 licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.