SuperAPI AI 工具集

02-definition-of-done

测试与质量

查看项目

更新于 10-16 07:09

技能介绍

用途

该技能用于建立或修订团队对「完成」增量的质量标准,生成一份全面的「完成定义」(Definition of Done,DoD)清单,以确保每个产品待办项在可被视为完成之前,满足一致且可验证的标准。输出遵循 Scrum Guide。

适用情形包括:为「完成」增量建立或修订团队质量门;在项目中已存在 quality_standards.md 与(可选的)tech_stack.md 上下文文件后使用;在冲刺计划之前使用,确保团队有一份共享的 DoD 参考。

不适用情形:当更具体的上游或下游技能负责该任务时,或所需项目上下文尚未准备时,不应使用。该技能不得用于编造缺失的项目事实、法律结论、测试结果、批准或认证声明。

主要能力

技能按固定八个步骤生成 DoD,涵盖以下标准类别:

  1. 代码质量:要求代码无错误或警告地编译与构建;遵循 quality_standards.md 中定义的项目编码标准;静态分析或 linting 零违规通过;不引入已知安全漏洞。
  2. 测试:所有新增和修改代码的单元测试编写并通过;代码覆盖率满足或超过 quality_standards.md 中的阈值;受影响接口的集成测试通过;现有测试套件无回归;边界情况与错误路径已测试。
  3. 文档:非显而易见逻辑有内联代码注释;新增或变更端点的 API 文档已更新;行为变更时用户文档已更新;为增量添加变更日志条目。
  4. 评审:同行代码评审已完成并批准;所有评审意见已处理或带理由明确推迟;架构变更经设计评审;产品负责人接受验收标准。
  5. 部署:CI/CD 流水线通过所有阶段(构建、测试、扫描);已验证部署到预发布环境;回滚程序已记录或确认;各环境配置变更已记录。
  6. 增量级与发布级 DoD:增量级要求所有选中待办项满足条目级 DoD、冲刺目标已验证、无未关闭的关键缺陷;发布级要求所有增量满足增量级 DoD、发布说明完整、性能基准达成、获得干系人签署。

每个准则需具备可观察的测试判定依据(test oracle),不得使用模糊门禁(如「足够」「安全」「用户友好」)。准则采用「SHALL」语言表述强制性要求,并区分条目级、增量级与发布级三个层次。

使用方式

所需输入:

  • quality_standards.md,位于 projects/<ProjectName>/_context/,必需,提供项目质量要求、编码标准与覆盖率目标。缺失时停止依赖工作,指出缺失项、负责人及决策影响。
  • tech_stack.md,位于 projects/<ProjectName>/_context/,可选,用于针对技术选型(linters、测试框架、CI/CD 工具)定制准则。

执行流程(按顺序执行八步):

  1. 从 projects/<ProjectName>/_context/ 读取上下文文件,记录每个文件的绝对路径;缺失必需文件则停止。
  2. 定义代码质量准则。
  3. 定义测试准则。
  4. 定义文档准则。
  5. 定义评审准则。
  6. 定义部署准则。
  7. 定义增量级与发布级 DoD。
  8. 汇总并写出最终清单文档。

输出文件为 projects/<ProjectName>/<phase>/<document>/Definition_of_Done.md,包含固定顺序的八个部分:文档头(项目名称、日期、版本、标准引用)、代码质量准则、测试准则、文档准则、评审准则、部署准则、增量级 DoD、发布级 DoD。

权限边界:默认只读。需要读取和搜索所提供制品的权限;编辑仅限于明确授权的请求草稿或项目文件。仅在获得授权时执行验证;发布、签名、认证、生产变更、破坏性操作、支出和风险接受均需明确授权。

降级模式:当文件、工具、网络、渲染、字体、执行或证据不可用时,返回最窄范围内的有用合格草稿或发现集;列出每项不可用检查及其后果;未评估的检查绝不视为通过;保留已收集的证据并提供确切的下一步验证动作。

适用场景

  • 团队建立或修订「完成」质量门时。
  • 项目 _context 目录下已提供 quality_standards.md(必需)和 tech_stack.md(可选)后。
  • 冲刺计划之前,确保团队拥有共享的 DoD 参考。
  • 若项目为多租户 SaaS,需额外应用 references/saas-dod-addendum.md。

限制

  • 不得编造缺失的项目事实、法律结论、测试结果、批准或认证声明。
  • 不得将缺失或不可访问的检查视为通过;应标记为未评估、说明影响并阻止依赖声明。
  • 不得在无授权情况下发布、签名、认证、变更生产或接受风险。
  • 没有可观察判定依据的准则须在采用清单前重写。
  • 不得使用未包含产品、控制、角色、版本或司法辖区细节的通用模板。
  • 不得列出无来源或验收结果的证据。
  • 确保输出基于来源上下文、可追溯到所述标准,并具体到可评审或验证;分离事实、推断、假设与批准,不得相互混淆。
  • 编写时应用 28-anti-ai-slop,在主要检查点和发布时应用 29-ai-slop-audit。

参考与集成

引用文件:logic.prompt(包含逐步 DoD 生成逻辑的可执行提示)、README.md(快速入门指南)、Skill notes(本地示例与调用上下文)、Repository operating rules(引擎的路由、证据与发布门禁)、SaaS mode 附加文件 references/saas-dod-addendum.md。

集成关系:上游为项目上下文 quality_standards.md(消费质量阈值与编码标准);横向有 01-sprint-planning(冲刺计划引用 DoD 制品)、03-definition-of-ready(DoR 与 DoD 构成互补质量门);下游为阶段 05 测试计划(DoD 测试准则影响测试计划范围)。

标准合规:遵循 Scrum Guide,管理「完成定义」作为增量在满足质量措施时所处状态的正式描述。