SuperAPI AI 工具集

workflow-code-to-spec

办公与效率

查看项目

更新于 10-15 21:35

技能介绍

用途:从既有代码反向生成并维护唯一的规范文档(Feature Spec),让规范、实现、测试与项目文档保持同步。规范为无技术细节的 8 节结构,位于 docs/specs/{Bucket}/README.{Feature}.md,代码是技术事实来源,不另建工程规范树。

主要能力:提供三种模式。init-full 用于目标范围尚无规范时,依次执行 scout、规模评估、plan、plan-review、plan-validate、spec [mode=init]、spec [mode=tests]、artifact-review、docs-update、workflow-end、watzup。update 用于代码变更或新需求,先 workflow-review-changes,再更新受影响章节并同步测试。audit 用于定期检查文档新鲜度。规范含 §1 概述、§2 术语、§3 用户故事与验收标准、§4 业务规则、§5 领域模型(Mermaid ERD)、§6 流程、§7 权限角色、§8 测试规范。

使用方式:在 Codex 中以 $skill-name 调用;执行前必须先确认模式(Step 0 不可跳过),按声明顺序逐步执行并报告每步证据,4 个以上能力需在同一消息中并行派生子代理。多桶或全项目范围需维护可恢复的 Coverage Ledger(plans/reports/code-to-spec-coverage-{date}.md),并在 workflow-end 前通过完整性门禁。若共享技能或同步工具变更,需运行 npm run codex:sync。

适用场景:从零建立规范、代码变更后增量同步、季度文档健康检查。

限制:§1-7 必须严格无技术术语;§5 Mermaid ERD 必须内嵌于规范文件;缺少或过期的项目上下文需先运行 $project-init 或相应初始化路由;环境无法执行某步骤时应停止并询问用户,不得擅自调整。具体收费、平台支持等信息暂未提供。