Back to Details

eng-runbook

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Engineering Runbook Skill

工程运行手册 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.
  1. 阅读DESIGN.md。
  2. 从需求中识别服务。
  3. 布局：
    • 页眉：服务名称、负责团队、严重等级、版本。
    • 服务摘要段落 + 依赖列表。
    • 告警表格：告警名称 / 严重程度 / 含义 / 初步响应措施。
    • 仪表盘与链接列表。
    • 常用操作流程模块（3–4个），包含代码块（部署、回滚、密钥轮换）。
    • 值班轮换表格（周数 / 主值班 / 副值班 / 备用值班）。
    • 事故响应检查清单（5个编号步骤）。
  4. 嵌入一个
    <style>
    标签，使用语义化HTML，代码块使用等宽字体。

Output contract

输出合约

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