SuperAPI AI 工具集

doc-tasks

编程与开发

查看项目

更新于 10-16 02:02

技能介绍

用途

doc-tasks 用于在 SDD(规范驱动开发)工作流中创建任务分解文档(TASKS),即第 11 层工件。它的核心作用是把第 10 层的 SPEC 技术规范拆解为可执行、面向 AI 编码智能体的结构化 TODO 任务,为后续第 12 层的代码实现做准备。

主要能力

  • 将 SPEC 分解为按阶段组织的任务,每个任务包含:任务 ID、标题、动作(命令式)、需创建/修改的文件、依赖关系、工作量估算、SPEC 引用、成功标准,可选 CTR 引用。
  • 任务 ID 采用统一元素 ID 格式:TASKS.{SPEC-ID}.18.{SEQ},例如 TASKS.01.1803 表示来自 SPEC-01 的第 3 个任务。
  • 支持实现契约(Implementation Contracts):第 8 节为必填,分为 8.1 提供的契约、8.2 消费的契约、8.3 无契约三种情况,用于支持依赖型 TASKS 文件的并行开发。
  • 使用 Mermaid 图生成依赖关系图(禁止文本式图表)。
  • 提供工作量汇总表,按阶段统计任务数与总工时。
  • 支持累积标签(Cumulative Tags):第 11 层需包含第 1-10 层的标签,共 8-10 个(@brd、@prd、@ears、@bdd、@adr、@sys、@req、@impl、@ctr、@spec)。
  • 提供校验脚本与手动检查清单,覆盖文件名格式、YAML frontmatter、文档控制表、必需章节、可追溯性标签、元素 ID 格式等。

使用方式

  1. 阅读上游 SPEC(第 10 层)作为主要来源。
  2. 在 docs/11_TASKS/ 中预留 ID 编号(如 TASKS-01,通常与 SPEC ID 对应)。
  3. 创建 TASKS 文件,必须使用嵌套文件夹:docs/11_TASKS/TASKS-NN_{slug}/TASKS-NN_{slug}.md。
  4. 依次填写文档控制、概览、阶段划分、详细任务、依赖图、工作量汇总、累积标签、可追溯性矩阵、实现契约。
  5. 运行校验: ./ai_dev_flow/scripts/validate_tasks.sh docs/TASKS/TASKS-01_*.md python ai_dev_flow/scripts/validate_tags_against_docs.py --artifact TASKS-01 --expected-layers brd,prd,ears,bdd,adr,sys,req,impl,contracts,spec --strict
  6. 提交 TASKS 文件与可追溯性矩阵。

适用场景

  • 已完成 BRD 至 SPEC(第 1-10 层),准备将 SPEC 拆解为可执行任务。
  • 为 AI 编码智能体准备结构化 TODO 格式。
  • 进入实现规划阶段(第 12 层)之前。
  • 需要支持多个实现会话并行开发、共享接口或复杂状态机/异常层次时。

限制

  • 创建前必须验证上游工件是否存在,只能引用真实存在的文档,不得使用 BRD-XXX、TBD 等占位符,也不得创建缺失的上游工件。
  • 保留 ID 为 000 的文档(如 TASKS-00_index.md、TASKS-00_TRACEABILITY_MATRIX-TEMPLATE.md、TASKS-00_IMPLEMENTATION_CONTRACTS_CHECKLIST.md)完全豁免校验。
  • 禁止使用旧式任务 ID(如 TASK-XXX、T-XXX),必须使用 TASKS.NN.18.SS。
  • 依赖图必须使用 Mermaid,禁止文本式图表。
  • 第 8 节实现契约章节为必填。
  • 第 11 层必须包含 8-10 个累积标签。
  • 文档需通过 Tier 1 错误检查(文件名格式、YAML frontmatter、文档控制表、8 个必需章节、第 8 节、8 个可追溯性标签、父 SPEC 引用、元素 ID 格式)。

典型阶段划分

Phase 1 项目搭建、Phase 2 数据模型、Phase 3 业务逻辑、Phase 4 API 层、Phase 5 错误处理、Phase 6 配置、Phase 7 测试、Phase 8 部署。

上游与下游

上游来源:BRD、PRD、EARS、BDD、ADR、SYS、REQ、IMPL(可选)、CTR(可选)、SPEC(主要来源)。下游工件:代码(第 12 层)、测试(第 13 层)。