代码评审(对齐需求、设计文档):用 Skill 把实现与需求、概要设计对齐

前言

功能开发收尾后,常见情况是:需求文档、澄清记录和概要设计都在,但代码 diff 与文档是否一一对应,往往要靠人工逐条对照。漏做功能点、实现偏离模块划分、边界条件未覆盖,这些问题在合并前若未系统检查,容易进入主干后再返工。

下面介绍 SkillHub 上的「代码评审(对齐需求、设计文档)」:在开发完成后,让 Agent 结合功能点文档、需求/澄清文档与概要设计文档,对代码实现做结构化评审,而不是只做泛泛的「代码风格审查」。

这是什么

「代码评审(对齐需求、设计文档)」是社区来源(community)的 Agent Skill,坐标为 @user_377751ac/wenwei-code-review,当前版本 1.0.0,分类为 dev-programming,发布者为 user_377751ac。SkillHub 页面标注作者为 诺头-wenwei。标签标明 requires_api_key=false,安装后无需额外 API Key 配置即可按 Skill 说明使用。

它解决的是开发后验收:评估需求完成度,检查改动是否按概要设计落地,并识别未完成项、BUG 与偏离设计的问题。官方说明中强调:此技能与「设计评审」不同——设计评审在开发前审查设计方案的合理性;本技能在开发后审查代码实现的正确性与完整性。

核心功能

依据 SkillHub 简介,已核实的能力包括:

  1. 对照多类文档评审代码:结合功能点文档、需求/澄清文档与概要设计文档,而不是仅阅读源码。
  2. 评估需求完成度:判断功能点是否在实现中得到覆盖。
  3. 核对与概要设计的一致性:检查代码改动是否严格按概要设计落地。
  4. 问题归类:识别未完成项、BUG,以及实现偏离设计之处。

适合在用户明确提出代码评审、代码审查、检查代码实现、验证开发完成度、核对代码与设计是否一致,或在开发完成后需要验收代码质量时,由 Agent 加载本 Skill 并按其流程执行。

安装与启用

SkillHub 提供两种常见方式:用 CLI 安装到当前 Agent 的 skills 目录,或把安装提示词发给 AI 由其按官方安装文档操作。

方式一:SkillHub CLI

先确认是否已安装 CLI:

command -v skillhub && skillhub --version

未安装时可执行完整安装(CLI + 默认 Skill):

curl -fsSL https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/install.sh | bash

安装本技能时,必须用 --dir 指向当前 Agent 的 skills 目录;默认装到 ./skills/ 可能不会被识别。坐标使用完整包名:

skillhub install user_377751ac/wenwei-code-review --dir <skills 目录>

各客户端常用 skills 目录(以 SkillHub 安装文档为准):

  • Cursor:~/.cursor/skills/
  • Claude Code:~/.claude/skills/
  • Codex:~/.codex/skills/ 或项目下的 .agents/skills/

装到对应目录后,按你所用客户端的要求重启或刷新 Agent,使 Skill 生效。

方式二:让 AI 按官方安装说明安装

SkillHub 技能页给出的提示词为:请根据 SkillHub 安装与优先源配置,安装 @user_377751ac/wenwei-code-review。

将上述说明与你的目标环境(例如 Cursor)一并交给 Agent,由其在联网前提下按文档完成 CLI 检查、--dir 安装等步骤。

典型用法

本 Skill 基于通用 SKILL.md 格式;公开页面未附带完整 SKILL.md 正文,典型用法应以安装后本地 Skill 目录中的说明为准。从官方简介可复现的使用前提与触发方式如下。

  1. 准备材料:将功能点文档、需求/澄清文档、概要设计文档放在 Agent 可访问的工作区或上下文中;代码改动(分支、PR 或本地 diff)应可被读取。
  2. 明确任务类型:在对话中说明要进行「代码评审」或「验收代码实现」,并强调需要对齐需求与设计文档,以区别于开发前的设计评审。
  3. 让 Agent 执行评审:Agent 加载 @user_377751ac/wenwei-code-review 后,应围绕完成度、与设计一致性、缺陷与偏离项给出结构化结论;你可根据项目习惯要求输出检查清单或按模块汇总。

示例意图(表述可依项目调整,不必逐字照搬):

请使用代码评审技能:对照功能点文档、需求澄清和概要设计,评审当前分支上的代码实现,
列出未完成项、疑似 BUG,以及偏离概要设计的改动。

适用场景与注意

适合谁:在迭代末尾需要验收、或 Code Review 希望同时覆盖「文档—实现」一致性的团队与个人;已有功能点列表与概要设计文档时收益更明显。

使用注意:

  • 评审质量依赖你提供的文档与代码范围是否完整;Skill 不能替代缺失的需求或设计依据。
  • 与「设计评审」分工不同:不要在开发前误用本 Skill 替代方案评审;开发后再用本 Skill 查落地情况。
  • SkillHub 页面展示的统计(截至抓取时:评分 100000,下载 4701)会随时间变化,以 SkillHub 技能页 为准。

结尾

「代码评审(对齐需求、设计文档)」把开发后的验收焦点放在需求完成度与概要设计一致性上,适合在合并前做一轮文档驱动的实现检查。安装与详情见 SkillHub:

  • 技能页:https://www.skillhub.cn/skills/user_377751ac/wenwei-code-review
  • API 坐标页:https://api.skillhub.cn/user_377751ac/wenwei-code-review
羽毛球分组比赛记分
小程序二维码

欢迎使用《羽毛球分组比赛记分》微信小程序

小夜