Skip to content
Skillpedia
Documentation101k · #415

eng-runbook

Creates an engineering runbook. Details the service, alerts, dashboards, and how to resolve incidents.

What it does

This agent creates a quick guide for engineering teams, called a 'runbook'. It organizes important information about a service, such as alerts, useful links, and common procedures.

When to use it

  • ✓When you need a guide to understand and manage an engineering service.
  • ✓When looking for information on alerts, dashboards, or how to solve common issues.
  • ✓To have a quick summary of how to handle incidents or who to contact.

Example of what to ask your AI

“Create a runbook for the 'Payment API' service.”

Want more? Open the sections below.

How to use

The easiest way: copy the message below and paste it into Claude, ChatGPT, Cursor or any AI. It reads the skill and follows the instructions.

Skill link

https://github.com/nexu-io/open-design/blob/main/design-templates/eng-runbook/SKILL.md

Ready-to-paste message

Use this skill to help me: https://github.com/nexu-io/open-design/blob/main/design-templates/eng-runbook/SKILL.md Read the SKILL.md file at that link and follow its instructions for my task.
How it works

The agent reads a document called DESIGN.md and extracts information about the service. It organizes this data into sections like summary, alerts, links, procedures, and contacts.

Installation

Easiest way: copy the skill link and paste it into Claude, ChatGPT or Cursor asking it to follow the instructions.

In the terminal (Claude Code, Codex, Cursor), in your project folder:

npx skills add nexu-io/open-design --skill eng-runbook

Or download just the file:

curl -L https://raw.githubusercontent.com/nexu-io/open-design/main/design-templates/eng-runbook/SKILL.md -o SKILL.md
Technical content (original SKILL.md)

Original text by the author, straight from GitHub.

Engineering Runbook Skill

Produce a single-page engineering runbook.

Workflow

  1. Read DESIGN.md.
  2. Identify the service from the brief.
  3. Layout:
    • Header: service name, owner team, severity tier, version.
    • Service summary paragraph + dependency list.
    • Alerts table: alert name / severity / what it means / first response.
    • Dashboards & links list.
    • Common procedures block (3–4) with code blocks (deploy, rollback, rotate keys).
    • On-call rotation table (week / primary / secondary / backup).
    • Incident response checklist (5 numbered steps).
  4. One inline <style>, semantic HTML, monospace for code blocks.

Output contract

<artifact identifier="runbook-name" type="text/html" title="Service Runbook">
<!doctype html>...</artifact>
FAQ

What is a 'runbook'?

It's a document that brings together all essential information for operating and maintaining an engineering service, like an instruction manual.

What kind of information does a runbook contain?

It can include a service summary, alert list, links to dashboards, commands for common procedures, on-call information, and an incident response checklist.

Who is a runbook for?

It's mainly for engineering and operations teams, especially for those on-call or needing to resolve issues quickly.

Details

Original description by the author

An engineering runbook — service overview, alerts table, dashboards links, common procedures with copy-pasteable commands, on-call rotation, and an incident-response checklist. Use when the brief mentions "runbook", "ops doc", "on-call guide", "SRE doc", or "运维手册".

repo: nexu-io/open-design

Popularity

GitHub stars
101k
Ranking position
#415
License
Apache-2.0
Updated
10/16/2026

Is this skill useful?

0

Sign in to vote.

Comments

  • …

More skills from this repository

Similar skills