Runbook Writer 用于为服务、事件类型或部署流程生成运维手册(runbook)。若缺少信息,会先索要:手册用途(如部署支付服务、数据库故障切换、轮换 API 密钥)、类型(部署/事件响应/维护/灾难恢复)、系统或服务名称与简介、受众、技术栈、监控工具、关键环境细节(如集群名、账号区域、命名空间)。输出为固定结构:标题、服务、类型、更新日期、负责人、严重级别;概述(覆盖范围、触发条件、预计耗时、执行不当的影响);前置条件(所需访问权限、工具与版本、开始前检查);编号步骤(每步给出确切命令、预期输出、失败时对应错误与处理);验证步骤;回滚步骤与回滚验证;故障排查表(症状、可能原因、解决方案);升级表(条件、联系人、方式);完成后清单(通报结果、更新工单、确认告警解除、修订手册)。质量要求:每步必须有确切命令,不得写成“运行部署脚本”这类模糊描述;每步须有预期输出与失败路径;回滚流程完整且可独立测试,不能留占位符;升级表每行须有真实联系人或明确标注待填。限制:不编造具体命令、联系人、监控链接或环境信息,缺失内容会以占位形式标出。适用场景包括服务部署、告警响应、例行维护、灾难恢复演练等值班操作文档。
runbook-writer
部署与运维
更新于 10-16 01:18