eng-runbook

Generate a structured single-page HTML engineering runbook from a DESIGN.md input.

Updated Aug 27, 2026

Search Tags:#html #engineering #runbook #on-call #incident-response #ops-doc

Ready to run

npx skills add https://github.com/junainfinity/osmDesign --skill eng-runbook

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: eng-runbook
Source: https://github.com/junainfinity/osmDesign/tree/main/skills/eng-runbook
Command: npx skills add https://github.com/junainfinity/osmDesign --skill eng-runbook

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Engineering teams need a ready-to-use, well-structured runbook to quickly respond to incidents and keep service health. This Skill generates a single-page HTML runbook with a consistent layout that covers service overview, alerts, runbooks, on-call rotation, and incident response steps.

Core Features & Use Cases

Structured format: header, service summary, dependency map, alerts table, dashboards links, common procedures, on-call rotation, and incident response checklist.
HTML artifact: produces a portable runbook that can be published in docs or runbooks portals; supports copy-pasteable commands in procedures.
Use Case: Create an op-ready runbook for a new service such as auth-service, including health checks and escalation steps.

Quick Start

Provide DESIGN.md as input and generate a single-page HTML runbook.

Frequently Asked Questions about eng-runbook

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate an HTML runbook for on-call incident response?▼

To generate an HTML runbook for incident response, provide your service design document as input. The Skill outputs a single-page HTML artifact containing structured sections for alerts, dashboards, and escalation procedures.

What sections are included in a structured engineering runbook?▼

A structured engineering runbook includes a header, service summary, dependency map, alerts table, dashboard links, common procedures, on-call rotation, and an incident response checklist. These sections provide a comprehensive operational overview for on-call engineers.

Can I create an operations dashboard guide for a new microservice?▼

Yes, you can create an operations dashboard guide for a new microservice by supplying its design specifications. The Skill generates a portable HTML runbook detailing service health checks, dependencies, and operational dashboards.

What is the best way to document common operational procedures and on-call rotations?▼

The best way to document common operational procedures and on-call rotations is using a standardized HTML runbook. This format supports copy-pasteable commands and clearly outlines rotation schedules alongside incident response steps.

Do I need a specific design document format to generate a service runbook?▼

You need to provide a DESIGN.md file as input to generate the service runbook. The Skill processes this input to automatically produce the multi-section HTML runbook artifact for your service.

Are there limitations to the HTML runbook format for incident response?▼

The HTML runbook is delivered as a single-page artifact, meaning complex dependency mapping is static rather than interactive. It is designed for portable publishing in docs portals rather than dynamic operational execution.