501-ops-manual-review

star 1

运维文档评审技能。运维文档编写完成后触发:(1)检查文档完整性与内容准确性, (2)确认操作步骤可操作性与架构一致性, (3)验证应急方案可行性并输出评审结论。

axeon By axeon schedule Updated 6/14/2026

name: 501-ops-manual-review description: 运维文档评审技能。运维文档编写完成后触发:(1)检查文档完整性与内容准确性, (2)确认操作步骤可操作性与架构一致性, (3)验证应急方案可行性并输出评审结论。 alwaysApply: false author: "axeon(23231269@qq.com)" version: "1.0.0"

运维文档评审

项目环境检测

从当前目录向上查找 project-info.md,最多 3 层,找到后记为 PROJECT_ROOT。详见 检测方法与前置检查未找到 → 使用当前工作目录作为 PROJECT_ROOT

角色职责

角色 职责 智能体
主导 运维评审 devops-lead
协作 文档可操作性 devops-engineer
协作 架构准确性 system-architect
协作 应用配置确认 java-developer

源技能引用

评审必须先读取源技能文件获取原始约定,再基于约定进行评审,禁止仅凭模型自身知识评审。

源技能文件 评审时读取的内容
500-ops-manual/SKILL.md 必读全文:运维文档规范、交付物清单、完成标准
500-ops-manual/references/templates.md 文档模板

输入

输入项 来源 说明
运维文档 manual/ops-manual/ 8项运维文档
系统架构 design/architecture/ 架构设计参考
部署配置 实际部署环境 配置参数

输出

输出项 位置 说明
运维文档评审报告 manual/reviews/REVIEW-OPS-MANUAL-YYMMDDHHMM.md 评审结论和问题清单

流转关系

通过 → 进入收尾阶段完成
不通过 → 返回运维文档修改

交付物清单

序号 交付物 评审要点
1 系统架构说明 架构准确性、组件完整性
2 部署手册 可部署性、步骤清晰
3 配置管理手册 配置项完整、变更流程
4 监控手册 指标覆盖、告警有效
5 故障处理手册 方案可行、步骤清晰
6 备份恢复手册 流程完整、可恢复性
7 日常维护手册 操作规范、可执行
8 应急预案 响应及时、可执行

评审维度

维度 检查要点
完整性 必需文档齐全、版本一致
准确性 技术参数正确、步骤验证
可操作性 步骤清晰、命令可执行
架构一致性 架构图与实际一致、配置准确

通过标准

等级 评分 条件
通过 ≥ 95 分 无 Critical 问题,Major ≤ 2,文档 8 项齐全,内容准确,步骤可执行
不通过 < 95 分 存在 Critical 或 Major > 2 或文档不完整

评分 < 95 进入修复循环,无"有条件通过"中间态。

评审流程

1. 准备阶段

  • 获取运维文档
  • 获取系统架构文档
  • 准备检查清单

2. 执行评审

按维度检查,记录问题。评审发现记录格式和评审报告结构详见 评审报告模板。报告中需包含"交付物检查"扩展统计节。

维度: 完整性/准确性/可操作性/架构一致性 评审对象: manual/ops-manual/ 参与人员: @devops-lead @devops-engineer @system-architect 流转方向: 通过 -> 进入收尾阶段完成;不通过 -> 返回运维文档修改

输出要求

报告位置: manual/reviews/REVIEW-OPS-MANUAL-YYMMDDHHMM.md

必须包含:

  • 评审信息(日期、人员、对象)
  • 各维度评审结果和得分
  • 交付物检查清单
  • 问题清单(含严重程度、责任人、状态)
  • 量化评审结论
  • 流转方向说明
  • 下一步行动项

3. 评审结论

计算最终评分后,按以下规则执行:

评分 ≥ 95(通过):

  1. 标记评审状态为「通过」
  2. 输出评审报告,任务结束

评分 < 95(不通过)→ 自动修复循环:

  1. 立即调用 500-ops-manual,传入问题清单
  2. 修复完成后立即重新执行本技能评审
  3. 若仍 < 95,回到步骤 1(最多 5 轮)
  4. 仅在通过或轮次耗尽时输出结果

此流程全自动执行:中间不暂停、不询问、不汇报。 未收到通过确认前,禁止结束本技能任务。

Install via CLI
npx skills add https://github.com/axeon/uw-spec --skill 501-ops-manual-review
Repository Details
star Stars 1
call_split Forks 0
navigation Branch main
article Path SKILL.md
More from Creator