SuperAPI AI 工具集

feature-review

编程与开发

查看项目

更新于 10-16 06:08

技能介绍

Feature Specification Reviewer 是一个专门用于评审特性规格的技能。它的定位是:在开发开始之前,对特性规格文档进行系统性审查,判断其是否足够完整、清晰、可测试,从而降低因需求模糊导致的返工风险。

用途 该技能用于审查特性规格(feature specification)的完整性、清晰度与质量。它只做评审,不修改任何代码,也不修改规格文档本身。评审对象是规格说明,产出是评审报告与改进建议。当规格中已记录的用户流程缺少 Gherkin 场景时,它会生成缺失的 Gherkin 场景。

主要能力

  • 解析规格:读取并解析给定的规格文档。
  • 标准校验:依据核心评审标准逐项检查通过或失败。
  • 缺口识别:找出缺失的需求内容,并按严重级别归类。
  • 内容生成:为缺少验收标准的场景生成 Gherkin 场景,并建议校验规则。
  • 评分与就绪判定:给出总体质量分数与就绪状态。
  • 结构化报告:输出包含执行摘要、完整性清单、详细发现、生成内容与建议汇总的报告。

评审标准 必须项(缺失即阻塞):

  • 清晰度与目的:特性目的明确陈述;目标人物被识别;价值主张得到说明;成功标准可衡量。
  • 用户场景:正常路径以 Gherkin 记录;边界用例至少 3 个并说明预期行为;错误处理已指定;授权场景已覆盖。
  • 验收标准:每条标准可测试(可作是/否验证);不含主观词汇(如“good”“fast”“intuitive”);覆盖所有目标人物。

应选项:

  • 技术细节:列出受影响的模型;为每个输入字段列出校验规则;记录数据库变更;指定授权规则(Pundit policies);识别集成点。
  • UI/UX(如涉及界面):记录加载、错误、空、成功状态;指定响应式行为;考虑无障碍(WCAG 2.1 AA)。

中大型特性的必须项:

  • PR 拆分:定义 3-10 个增量 PR;每个 PR 少于 400 行(理想为 50-200 行);每个 PR 只有一个目标;每个 PR 包含测试;遵循逻辑依赖顺序。

严重级别

  • CRITICAL(P0):缺少基本要求(无用户故事、无验收标准)。
  • HIGH(P1):缺少重要细节(无边界用例、无授权)。
  • MEDIUM(P2):措辞含糊、标准主观。
  • LOW(P3):缺少锦上添花内容(无图表、格式小问题)。

使用方式 工作流为:第一步读取并解析规格;第二步对照核心标准校验;第三步生成缺失内容(Gherkin、边界用例);第四步产出结构化评审报告。 报告结构包括:执行摘要(总体质量分数 X/10、就绪状态、前三大问题)、完整性清单(逐项通过/失败)、详细发现(已通过标准;失败标准按 CRITICAL > HIGH > MEDIUM > LOW 排序,每条包含 What → Where → Why → How to fix 并附代码示例)、生成的 Gherkin 场景(针对缺失的验收标准)、建议校验规则(表格:字段 | 类型 | 必填 | 规则 | 错误信息)、建议汇总(1. 开发前阻塞项 2. 快速改进 3. 可考虑添加项)。 评审结束后:若分数大于等于 7/10 且无 CRITICAL 问题,规格通过,下一步进入实现计划(/feature-plan);若分数低于 7/10 或存在 CRITICAL 问题,规格需要修订,列出问题修复后重新运行 /feature-review。

适用场景 适用于 Rails 项目在开发前评审特性规格,尤其适合需要判断规格是否达到可开发标准的团队流程。它可用于个人开发者自查规格,也可用于团队评审环节,作为开发前的质量门禁。

限制

  • 该技能不修改代码,也不修改规格文档。
  • 它只评审规格,并按标准判定与生成缺失的 Gherkin 场景,不执行具体功能实现。
  • 具体定价、收费、平台支持情况、性能效果等资料未提供。
  • 安装命令与具体运行环境信息暂未提供。