SuperAPI AI 工具集

spec-writer

编程与开发

查看项目

更新于 10-16 00:03

技能介绍

用途:当变更已超出探索阶段、需求足够清晰时,spec-writer 负责创建或完善 spec-superflow 的规划产物,包括 proposal.md、specs/、design.md 和 tasks.md。

主要能力:为新请求或 planned 工作流变体同时编写 proposal.md 与 tasks.md;proposal 记录目标、范围(含/不含)、验收与风险,tasks 记录有序交付物与证明命令。仅为需要持久场景的行为添加 specs,仅为未决架构决策添加 design。不创建 execution-contract.md,也不在其他计划中重复任务列表。

使用方式:执行 CLI 前需将行首 SSF 替换为 node "<plugin-root>/scripts/spec-superflow.mjs",<plugin-root> 为本文件上两级绝对目录,禁止直接运行 SSF 或从 PATH 调用 ssf。读取 .spec-superflow.yaml(尤其 dp_0_decisions、dp_0_confirmed),若 dp_0_confirmed 非 true 则停止并回到 workflow-start。运行 SSF runtime config --get artifacts.order 按配置顺序生成(默认 proposal → specs → design → tasks),用 artifacts.skip 跳过指定产物。进入 specifying 状态用 SSF state transition <change-dir> specifying。批准后运行 SSF workflow start <dir> --path planned --confirm --reason "<user decision>"。DP-2 通过后记录 SSF state set <change-dir> dp_2_result "approved: <summary>" 与 SSF state set <change-dir> dp_2_timestamp now,随后移交 contract-builder。

适用场景:需要结构化规划产物的软件变更,尤其是已有 DP-0 决策、需要可测试需求与依赖感知任务拆分的项目。

限制:不得在编写规划产物后直接开始实现;tasks.md 必须使用模板复选框格式(每行一个 - [ ]),否则进入执行时会被守卫拦截;验证失败须先修复再移交;缺失模板时回退到本技能定义的结构;解析失败需报告具体文件与错误,不得从损坏模板生成。