SuperAPI AI 工具集

validate-spec

测试与质量

查看项目

更新于 10-16 05:29

技能介绍

用途

validate-spec 用于在实现前校验规格文档的质量(--pre),或在实现后验证实现是否符合规格(--post)。它帮助团队在批准规格前发现缺失与模糊之处,并在完成前确认实现与规格一致。

主要能力

模式自动检测

根据规格状态自动选择默认模式:

  • draft、review:默认 --pre,用于批准前校验
  • approved:默认 --pre,实现前的最终检查
  • in_progress、complete:默认 --post,验证实现是否匹配

实现前校验(--pre)

  1. 结构完整性:检查必需章节是否存在,如 Summary、Problem Statement、Acceptance Scenarios、Agent Context、Out of Scope、Dependencies 等。
  2. 验收场景质量:检查场景是否包含 Given/When/Then 子句,是否具体、可测试、完整。对模糊表述给出改进建议。
  3. Agent 上下文校验:检查引用的文件是否存在。
  4. 成功指标可度量性:检查指标是否有阈值、是否可度量,对不可度量的指标给出建议。
  5. 简洁性检查:统计字数并与建议上限对比,提示是否考虑拆分。
  6. 开放问题检查:列出未解决的问题,提示在批准前解决。

实现后校验(--post)

  1. 验收场景覆盖:查找每个场景对应的测试,统计覆盖率。
  2. 成功指标验证:核对指标实际结果是否达标。
  3. 越界违规检查:扫描是否实现了 Out of Scope 中排除的内容。
  4. Agent 约束合规:检查是否遵守约束,如“不新增依赖”“不修改范围外文件”。
  5. Definition of Done:检查完成定义中的各项是否完成。

交互式修复

发现问题时,AI 会与用户交互,逐步确认修复内容,例如询问错误消息应写什么、是否移除不可度量的指标,然后重新校验并给出结论。

使用方式

命令用法:

/validate-spec SPEC-001 # 根据状态自动检测模式 /validate-spec SPEC-001 --pre # 实现前校验 /validate-spec SPEC-001 --post # 实现后合规校验

集成流程:

/spec → /validate-spec --pre → [approval] → /plan → /implement → /validate-spec --post → /complete

适用场景

  • 在规格批准前检查文档是否完整、清晰、可测试。
  • 在实现完成后验证是否满足验收场景、成功指标与约束。
  • 作为规格驱动开发流程中的质量门禁。

限制

资料未提供关于平台支持、收费、价格、具体实现细节或性能效果的信息。