用途:编写和更新运维手册(runbook)及事故响应流程,让值班与运维人员能快速、一致地行动。适用于用户要求 runbook、事故响应、部署/回滚方法或运维流程时,新增服务或部署流程需文档化时,事故后复盘记录时,以及建立或改进值班与升级机制时。
主要能力:识别流程类型(部署、回滚、故障切换、扩缩容、告警响应或事故流程);从用户或现有脚本文档收集实际步骤、命令、URL 与工具路径;在安全环境(预发、dry-run)测试命令;标注凭据来源(vault、环境变量),但绝不写入真实密钥;按结构组织内容。
手册内容:必需部分包括目的(一句话说明何时使用)、前置条件(访问权限、工具、凭据获取方式)、编号步骤(每步含动作、命令或链接、预期结果、失败处理)、验证(健康检查 URL、仪表盘或冒烟测试命令)、回滚(如何撤销及何时使用)、联系人(升级团队、Slack 频道、PagerDuty)。可选部分包括执行频率、预计耗时、相关手册链接。
事故响应高层流程:检测(告警名、仪表盘、用户报告)、分级(P1/P2 与影响范围)、缓解(回滚、禁用功能、扩缩容、重启,链接具体手册)、沟通(状态页、用户或内部频道更新及负责人)、事后(无责复盘:经过、根因、行动项)。
格式与风格:仓库内 Markdown,如 docs/runbooks/deploy-production.md,尽量一个流程一个文件;命令放代码块并标注语言(bash、powershell)与环境(生产/预发);注明步骤是否幂等;不写真实密钥。
规则与限制:手册中不得出现真实密钥或凭据,只引用 vault、环境变量或获取来源;与项目现有手册风格和工具(PagerDuty、状态页)保持一致;步骤须可执行,避免“确保配置正确”这类模糊表述;事故后若发现遗漏或错误应更新手册并加入复盘行动项。反模式包括模糊的“修复问题”、手册内写密钥、无失败处理、无验证、联系人过时。