代码评审:对齐需求与设计文档
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_377751ac/wenwei-code-review。
技能介绍
解决什么问题
开发完成后,代码评审往往依赖经验判断:某个需求“看起来实现了”,某个设计改动“应该没问题”,但缺少逐条证据。该技能面向工程评审场景,把代码实现与功能点文档、需求/澄清文档、概要设计文档放到同一基线上核对,帮助识别需求遗漏、边界条件缺失和偏离设计的改动。
工作方式
- 材料门控:先列出已识别输入;如果缺少关键文档,会停止后续流程,说明影响并询问是否继续。
- 建立评审基线:从需求条目提取功能项、业务规则、边界条件;从概要设计提取接口、数据流、逻辑改动和改动范围。
- 定位代码审查:基于文档中的代码位置定位实现,逐条核对需求完成度与设计一致性,并关注
空指针、边界值、异常处理、并发安全、硬编码、资源释放等常见风险。 - 结论输出:给出
评审通过或评审未通过,问题按未完成、BUG、偏离设计分类,且每个问题应能落到具体代码位置。
适用边界
适合已有需求、设计和代码位置说明的评审;如果输入只有口头描述、需求未澄清或设计文档缺失,结论可信度会明显下降。
使用场景
- 功能开发完成后,需要核对代码是否覆盖需求条目、业务规则和边界条件。
- 概要设计评审后,需要检查接口、数据流和逻辑改动是否按设计落地。
- 重构或跨模块改动后,需要基于功能点文档定位代码并识别偏离设计的实现。
- 联调测试发现缺陷后,需要逐条区分未完成、BUG 与偏离设计的问题。
适合人员
- 负责核心模块交付的工程师,需要在上线前把代码与需求、设计逐条对齐。
- 担任技术负责人的人,需要在评审会前获得可追溯的问题清单和通过结论。
- 参与后端或前端重构的工程师,需要确认改动没有偏离概要设计。
- 负责质量把关的测试工程师,需要把缺陷归类为未完成、BUG 或设计偏离。