Tom Huang
6f6bf31dd2
* Refactor project name from "Open Claude Design" to "Open Design" - Updated project name in package.json, package-lock.json, and README files. - Changed CLI commands and references from "ocd" to "od". - Adjusted file structure references in documentation and code to reflect new naming conventions. - Enhanced .gitignore to include new runtime data files. - Updated metadata in LICENSE file to match new project name. * Add contributing guidelines in English and Chinese - Introduced CONTRIBUTING.md and CONTRIBUTING.zh-CN.md to provide clear instructions for contributors. - Outlined contribution types, local setup instructions, and merging criteria for skills and design systems. - Enhanced README files to reference the new contributing guidelines.
52 lines
1.5 KiB
Markdown
52 lines
1.5 KiB
Markdown
---
|
||
name: eng-runbook
|
||
description: |
|
||
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 "运维手册".
|
||
triggers:
|
||
- "runbook"
|
||
- "ops doc"
|
||
- "on-call"
|
||
- "sre doc"
|
||
- "service runbook"
|
||
- "运维手册"
|
||
od:
|
||
mode: prototype
|
||
platform: desktop
|
||
scenario: engineering
|
||
preview:
|
||
type: html
|
||
entry: index.html
|
||
design_system:
|
||
requires: true
|
||
sections: [color, typography, layout, components]
|
||
example_prompt: "Write a runbook for our auth service — alerts, dashboards, common procedures, on-call rotation."
|
||
---
|
||
|
||
# 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>
|
||
```
|