mcpField
E
eng-runbook

eng-runbook

github.com/nexu-io云与 DevOps104.6k231 次安装今天更新
代码仓库

关于 eng-runbook

eng-runbook 是用于根据服务 brief 和 DESIGN.md 编写单页工程运行手册的技能，涵盖告警、操作流程、值班安排和事故响应，并按 HTML 格式输出。

主要功能

  1. 01读取 DESIGN.md 并识别服务
  2. 02服务摘要与依赖列表
  3. 03告警级别及初步响应
  4. 04操作流程与值班安排
  5. 05五步事故检查清单
  6. 06HTML 输出格式

适用场景

  1. 01为值班工程师整理服务文档
  2. 02记录告警含义及初步响应
  3. 03展示部署、回滚和密钥轮换流程

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/nexu-io/open-design --skill eng-runbook

安装后在 Claude Code 中输入/eng-runbook确认已加载。

附带文件example.html

详细介绍

工程运维手册技能

生成一份单页工程运维手册。

工作流

  1. 阅读 DESIGN.md。
  2. 根据简介确定服务。
  3. 布局：
    • 页眉：服务名称、负责团队、严重性级别、版本。
    • 服务摘要段落 + 依赖项列表。
    • 告警表格：告警名称 / 严重性 / 含义 / 首要响应措施。
    • 仪表板与链接列表。
    • 常见操作流程块（3–4 个），包含代码块（部署、回滚、轮换密钥）。
    • 值班轮换表格（周 / 主值班人员 / 次值班人员 / 备份人员）。
    • 事件响应清单（5 个编号步骤）。
  4. 使用一个内联 <style>、语义化 HTML，代码块使用等宽字体。

输出约定

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

评论

支持 Markdown