runbook-generator

Runbook 生成器

根据系统的代码库、基础设施配置和部署脚本，生成全面的 runbook.md，供凌晨 3 点处理事件、部署和日常运维的值班工程师使用。

目录

• references/discovery-patterns.md —— 发现阶段需要检查的 Glob/Grep 模式和配置文件。
• references/output-template.md —— 需要填充的完整 runbook.md 九部分结构。
• references/writing-style.md —— 清晰度、紧迫性、完整性、格式和准确性规则，以及输出要求。

工作流

1. 发现系统。运行 references/discovery-patterns.md（步骤 1）中的 Glob 模式，以识别技术栈和基础设施。
2. 阅读关键配置。打开并分析 references/discovery-patterns.md（步骤 2）中列出的配置文件：IaC、容器、CI/CD、应用配置、部署脚本、监控、迁移、负载均衡器和文档。
3. 识别运维行为。运行 references/discovery-patterns.md（步骤 3）中的 Grep 模式，以查找健康检查、指标、缓存、作业、迁移、回滚、扩缩容、备份、TLS、密钥、告警等内容。
4. 生成 runbook。按照 references/output-template.md 中的结构生成 runbook.md。涵盖全部九个部分；根据发现的内容调整；绝不加入纯属推测的部分。
5. 遵循写作标准。遵循 references/writing-style.md 中的所有规则，包括可直接复制粘贴的命令、预期输出、按顺序排列的步骤、优先处理 P1、使用表格整理结构化数据，以及准确性规则。
6. 核实并标记缺口。确认引用的路径和脚本确实存在。无法核实的细节标记为 [VERIFY]，缺失的部分标记为 [ACTION REQUIRED]: ...，以便 runbook 同时作为差距分析。

输出

将 runbook.md 写入项目根目录（或用户指定的目录）。内容必须超过 500 行，涵盖全部九个部分，包含从代码库中提取的真实命令、至少一张架构图和完整目录，并且绝不虚构基础设施细节。完整的输出检查清单请参阅 references/writing-style.md。