By name: 521-user-manual-review description: 用户手册评审技能。用户文档编写完成后触发：(1)检查文档完整性与内容准确性, (2)评估文档易懂性与操作步骤可操作性, (3)检查截图示例准确性并输出评审结论。 alwaysApply: false author: "axeon(23231269@qq.com)" version: "1.0.0"
用户手册评审
项目环境检测
从当前目录向上查找 project-info.md，最多 3 层，找到后记为 PROJECT_ROOT。详见 检测方法与前置检查。未找到 → 提示用户先执行 0-init。
角色职责
| 角色 | 职责 | 智能体 |
|---|---|---|
| 主导 | 文档评审 | project-manager |
| 协作 | 功能描述准确性 | product-manager |
| 协作 | 操作步骤准确性 | test-engineer |
| 协作 | 界面描述准确性 | js-developer |
源技能引用
评审必须先读取源技能文件获取原始约定，再基于约定进行评审，禁止仅凭模型自身知识评审。
| 源技能文件 | 评审时读取的内容 |
|---|---|
| 520-user-manual/SKILL.md | 必读全文：文档规范、交付物清单、完成标准 |
| 520-user-manual/references/templates.md | 文档模板 |
输入
| 输入项 | 来源 | 说明 |
|---|---|---|
| 用户文档 | manual/user-manual/ |
6项用户文档 |
| 系统界面 | 实际系统 | 界面截图验证 |
| 功能清单 | PROJECT_ROOT/requirement/ |
功能覆盖参考 |
输出
| 输出项 | 位置 | 说明 |
|---|---|---|
| 用户手册评审报告 | manual/reviews/REVIEW-USERS-MANUAL-YYMMDDHHMM.md |
评审结论和问题清单 |
报告格式详见 评审报告模板。
交付物清单
| 序号 | 交付物 | 评审要点 |
|---|---|---|
| 1 | 用户使用手册 | 易懂性、完整性、准确性 |
| 2 | 快速入门指南 | 简洁性、可操作性 |
| 3 | 功能操作指南 | 步骤清晰、截图准确 |
| 4 | 常见问题(FAQ) | 问题覆盖、解答准确 |
| 5 | 故障排除指南 | 方案可行、步骤清晰 |
| 6 | 版本更新说明 | 变更清晰、影响明确 |
评审维度
| 维度 | 检查要点 |
|---|---|
| 完整性 | 必需文档齐全、版本一致 |
| 准确性 | 功能描述一致、步骤验证、截图准确 |
| 易懂性 | 语言通俗、无歧义、有背景说明 |
| 可操作性 | 步骤具体、有预期结果、异常处理 |
通过标准
| 等级 | 评分 | 条件 |
|---|---|---|
| 通过 | ≥ 95 分 | 无 Critical 问题，Major ≤ 2，文档 6 项齐全，内容准确，易懂可操作 |
| 不通过 | < 95 分 | 存在 Critical 或 Major > 2 或文档不完整 |
评分 < 95 进入修复循环，无"有条件通过"中间态。
评审流程
开始评审前，先按"源技能引用"读取源技能，按"输入"读取所有评审对象。
1. 执行评审
按维度检查，记录问题。评审发现记录格式和评审报告结构详见 评审报告模板。报告中需包含"交付物检查"扩展统计节。
详细的评审检查清单见 checklist.md。
维度: 完整性/准确性/易懂性/可操作性 评审对象: manual/user-manual/ 参与人员: @test-engineer @product-manager @js-developer
2. 评审结论
计算最终评分后，按以下规则执行：
评分 ≥ 95（通过）：
- 标记评审状态为「通过」
- 输出评审报告，任务结束
评分 < 95（不通过）→ 自动修复循环：
- 立即调用
520-user-manual，传入问题清单 - 修复完成后立即重新执行本技能评审
- 若仍 < 95，回到步骤 1（最多 5 轮）
- 仅在通过或轮次耗尽时输出结果
此流程全自动执行：中间不暂停、不询问、不汇报。 未收到通过确认前，禁止结束本技能任务。