SuperAPI AI 工具集

doc-dspec-autopilot

写作与研究

查看项目

更新于 10-16 05:44

技能介绍

用途:doc-dspec-autopilot 是自动化文档规格(DSPEC)生成流水线,处理 REQ 文档,为文档交付物生成规格,包括用户指南、API 文档、培训材料与合规文档。适用于 REQ 文档的 deliverable_type 为 document 时,例如创建用户文档规格、生成 API 文档规格、培训材料规格或合规文档规格。

主要能力:按五个阶段执行。阶段一输入分析:识别 deliverable_type 为 document 的 REQ 文档,确定文档类型,提取内容需求。阶段二就绪校验:验证 REQ 的 SPEC-Ready 分数不低于 90%,检查依赖是否满足,确认受众分析完成。阶段三生成:从模板创建 DSPEC YAML,将 REQ 需求映射到文档章节,定义内容结构与大纲,指定风格指南合规要求。阶段四校验:运行 doc-dspec-validator,检查 DOC-Ready 分数不低于 85%,验证内容覆盖。阶段五评审:运行 doc-dspec-reviewer,生成审计报告,必要时通过 doc-dspec-fixer 修复。

文档类型与代码:用户指南 55、API 文档 56、合规文档 57、培训材料 58。

强制文档类型契约:生成 DSPEC 实例时必须从模板 ai_dev_ssd_flow/09_SPEC/DSPEC/DSPEC-MVP-TEMPLATE.yaml 读取 metadata.instance_document_type 为 dspec-document,并在生成文档的 frontmatter 中设置 custom_fields.document_type 为 dspec-document(而非 template),artifact_type 为 DSPEC,deliverable_type 为 document,layer 为 9,subtype_code 为 51;生成文档必须具有 document_type: dspec-document。

依赖技能:doc-naming(元素 ID 格式 DSPEC.NN.xxxx,代码 55-58,全阶段)、doc-req-validator(阶段二)、doc-dspec-validator(阶段四)、doc-dspec-reviewer(阶段五)。

输出结构:09_SPEC/DSPEC/DSPEC-NN_{slug}/ 目录下包含主 DSPEC 文档 DSPEC-NN_{slug}.yaml、索引 DSPEC-NN.0_index.md(如需拆分)与审计报告 DSPEC-NN.A_audit_report.md。

DOC-Ready 评分构成:内容覆盖 25%(目标 100%)、受众对齐 20%(不低于 90%)、结构完整性 20%(不低于 90%)、风格合规 15%(不低于 85%)、可访问性 10%(不低于 85%)、可追溯性 10%(目标 100%),总分目标不低于 85%。

参考文件:模板 ai_dev_ssd_flow/09_SPEC/DSPEC/DSPEC-MVP-TEMPLATE.yaml、模式 ai_dev_ssd_flow/09_SPEC/DSPEC/DSPEC_MVP_SCHEMA.yaml、创建规则 ai_dev_ssd_flow/09_SPEC/DSPEC/DSPEC-MVP-TEMPLATE.md、校验规则 ai_dev_ssd_flow/09_SPEC/DSPEC/DSPEC_MVP_SCHEMA.yaml。

限制:资料未提供安装命令、收费方式、支持平台与具体运行命令;使用前需满足 REQ 就绪分数与依赖条件。