关于 plan-audit
用于将已完成的工作与计划中的工作项、验收标准和测试要求进行核对的代码审查技能。它会通过文件和行号报告实现缺口、逻辑问题及覆盖不足。
主要功能
- 01将计划标准整理为检查清单
- 02把代码和提交对应到工作项
- 03按验收标准核查实际行为
- 04检查逻辑、边界情况和测试覆盖
- 05按文件和行号报告问题
适用场景
- 01按计划审查已完成的实现
- 02查找未落实的验收标准
- 03识别缺失或失败的测试
- 04记录计划质量缺口和风险
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ xiaolai/ vmark --skill plan-audit安装后在 Claude Code 中输入/plan-audit确认已加载。
详细介绍
计划审计
概述
根据计划(WI + 验收标准 + 测试)审计已完成的工作,并报告差距、逻辑错误和测试覆盖缺失,同时附上文件和行号。
工作流(审计)
-
定位计划
- 优先查找
dev-docs/plans/<plan>.md。 - 如果无法确定,请询问计划路径或 WI 列表。
- 优先查找
-
提取审计清单
- 对于每个 WI,列出:
- 目标
- 验收标准
- 必需的测试
- 涉及的区域(文件/符号)
- 对于每个 WI,列出:
-
将实现映射到 WI
- 使用
git log、git show --stat、rg和文件检查。 - 记录满足各 WI 的文件/提交。
- 使用
-
差距与正确性分析
- 对照实际行为检查每一项验收标准。
- 找出逻辑错误、边缘情况失效和流程不完整之处。
- 根据“先写测试”部分验证测试覆盖情况。
- 如果计划引用了规范,验证实现是否符合这些规范。
- 如果计划缺少验收标准/测试,将其记录为计划质量问题。
-
报告发现
- 按严重程度排序:Critical → High → Medium → Low。
- 每项发现必须包含:
- WI 引用
- 文件路径 + 行号
- 违反计划之处及原因
- 计划要求的预期行为
输出格式(必需)
- 发现(按严重程度排序)
文件:行号和 WI 引用- 影响和建议的修复方案
- 计划差距摘要
- WI‑### → 缺失/部分缺失的验收项
- 测试覆盖差距
- 缺失的测试、失效的测试或“未编写测试”
- 备注 / 风险
- 任何假设或未经验证的区域
- 证据
- 为每项发现引用具体证据(文件/行号/提交 ID)。
审计规则
- 除非用户明确要求,否则不要在此处运行测试;这只是一次检查。
- 严格检查规范偏差:如果行为与计划文本不一致,请标记。
- 如果找不到计划,请停止并索取计划。
评论
支持 Markdown