name: 500-ops-manual description: 运维文档编写技能。编写系统运维文档时触发:(1)编写部署手册与监控告警手册, (2)编写故障处理与应急预案文档, (3)编写备份恢复与日常维护手册。 alwaysApply: false author: "axeon(23231269@qq.com)" version: "1.0.0"
运维文档编写
项目环境检测
从当前目录向上查找 project-info.md,最多 3 层,找到后记为 PROJECT_ROOT。详见 检测方法与前置检查。未找到 → 使用当前工作目录作为 PROJECT_ROOT(阶段5文档交付允许独立于项目目录使用)。
角色职责
| 角色 | 职责 | 智能体 |
|---|---|---|
| 主导 | 文档编写 | devops-engineer |
| 协作 | 架构确认 | system-architect |
| 协作 | 配置提供 | java-developer |
交付物清单
| 序号 | 文档名称 | 必需 |
|---|---|---|
| 1 | 系统架构说明 | ✅ |
| 2 | 部署手册 | ✅ |
| 3 | 配置管理手册 | ✅ |
| 4 | 监控手册 | ✅ |
| 5 | 故障处理手册 | ✅ |
| 6 | 备份恢复手册 | ✅ |
| 7 | 日常维护手册 | ✅ |
| 8 | 应急预案 | ✅ |
编写流程
1. 收集信息
- 与架构师确认系统架构
- 收集各组件配置信息
- 整理服务清单和依赖关系
2. 编写文档
- 系统架构说明:组件清单、架构图
- 部署手册:环境要求、部署步骤、验证
- 监控手册:监控指标、告警规则
- 故障处理手册:故障分级、处理流程
3. 验证文档
- 根据文档执行部署验证
- 验证监控配置
- 验证故障处理流程
⚠️ 完成验证(强制,全自动执行)
开发工作完成后,立即按以下顺序自动执行:
- 强制调用
501-ops-manual-review - 如果评审不通过(< 95),自动修复问题,然后回到步骤 1(最多 5 轮)
- 直到评审通过(≥ 95),才向用户报告最终结果
此流程全自动执行:中间不暂停、不询问、不汇报。 未收到通过确认前,禁止结束本技能任务。
输出位置
manual/ops-manual/
├── README.md # 运维文档主文档
├── CHANGELOG.md # 变更历史
├── architecture.md # 系统架构说明
├── deployment.md # 部署手册
├── configuration.md # 配置管理手册
├── monitoring.md # 监控手册
├── troubleshooting.md # 故障处理手册
├── backup-restore.md # 备份恢复手册
├── maintenance.md # 日常维护手册
└── emergency.md # 应急预案