SuperAPI AI 工具集

doc-cspec-autopilot

编程与开发

查看项目

更新于 10-16 06:06

技能介绍

doc-cspec-autopilot

【用途】

这是一个自动化代码规格(CSPEC,Code Specification)生成流水线,用于处理 REQ 文档(必须附带 CTR)并生成可直接用于源代码交付物实现的 YAML 规格。

层级:9.50(CSPEC - 代码规格)

上游:REQ(第 7 层)、CTR(第 8 层,CSPEC 必需)

下游:TSPEC(第 10 层)、TASKS(第 11 层)

【何时使用】

在以下情况使用 doc-cspec-autopilot:

  • REQ 文档的 deliverable_type 为 code(或未指定,因为 code 是默认值)
  • 存在用于 API/接口定义的 CTR 契约
  • 为源代码实现生成规格
  • 为服务、库、模块创建 YAML 规格

【文档类型契约(强制)】

生成 CSPEC 文档实例时,自动流程必须:

  1. 从模板读取 instance_document_type:

    • 来源:ai_dev_ssd_flow/09_SPEC/CSPEC/CSPEC-MVP-TEMPLATE.yaml
    • 字段:metadata.instance_document_type: "cspec-document"
  2. 在生成的文档 frontmatter 中设置 document_type:

custom_fields: document_type: cspec-document # 不是 "template" artifact_type: CSPEC deliverable_type: code layer: 9 subtype_code: 50

验证:生成的文档必须具有 document_type: cspec-document

【技能依赖】

技能 / 用途 / 阶段:

  • doc-naming:元素 ID 格式(CSPEC.NN.xxxx,编码 50-54),所有阶段
  • doc-req-validator:验证 REQ SPEC-Ready 分数,阶段 2
  • doc-ctr-validator:验证 CTR 契约(CSPEC 必需),阶段 2
  • doc-cspec-validator:使用 CODE-Ready 评分进行验证,阶段 4
  • doc-cspec-reviewer:内容评审、质量评分,阶段 5

【执行阶段】

阶段 1:输入分析

  • 识别 deliverable_type: code 的 REQ 文档
  • 定位对应的 CTR 契约(必需)
  • 从 CTR 提取接口定义

阶段 2:就绪度验证

  • 验证 REQ SPEC-Ready 分数 ≥90%
  • 验证 CTR 契约完整
  • 检查所有依赖是否满足

阶段 3:CSPEC 生成

  • 从模板创建 CSPEC YAML
  • 将 REQ 需求映射到规格元素
  • 包含 CTR 接口定义
  • 添加实现细节(类、方法、算法)

阶段 4:验证

  • 运行 doc-cspec-validator
  • 检查 CODE-Ready 分数 ≥90%
  • 验证 CTR 合规性

阶段 5:评审

  • 运行 doc-cspec-reviewer
  • 生成审计报告
  • 如需,通过 doc-cspec-fixer 应用修复

【输出结构】

09_SPEC/CSPEC/CSPEC-NN_{slug}/ ├── CSPEC-NN_{slug}.yaml # 主要 CSPEC 文档 ├── CSPEC-NN.0_index.md # 索引(如需拆分) └── CSPEC-NN.A_audit_report.md # 审计报告

【CODE-Ready 分数构成】

组件 / 权重 / 目标:

  • 接口完整性:20%,100%
  • CTR 合规性:20%,100%
  • 算法规格:15%,≥90%
  • 错误处理:15%,≥90%
  • 测试映射:15%,≥90%
  • 可追溯性:15%,100%

目标:CODE-Ready ≥90%

【参考】

  • 模板:ai_dev_ssd_flow/09_SPEC/CSPEC/CSPEC-MVP-TEMPLATE.yaml
  • 模式(Schema):ai_dev_ssd_flow/09_SPEC/CSPEC/CSPEC_MVP_SCHEMA.yaml
  • 创建规则:ai_dev_ssd_flow/09_SPEC/CSPEC/CSPEC-MVP-TEMPLATE.md
  • 验证规则:ai_dev_ssd_flow/09_SPEC/CSPEC/CSPEC_MVP_SCHEMA.yaml

【限制】

资料未提供该技能的收费、价格、支持平台、运行环境要求以及具体使用命令等信息,暂未提供。