SuperAPI AI 工具集

corpus-spec

写作与研究

查看项目

更新于 11-05 01:28

技能介绍

用途

corpus-spec 用于在实现之前编写、修订或检查一份可验证的变更契约(spec)。其核心主张是:spec 是“经过决定、有待检验的意图”,除此之外不应包含别的内容。当意图或会产生后果的行为需要变成带验收标准的需求时,使用该技能。

主要能力

  • 规定规格文件的结构:frontmatter(type、id、status、sources)、标题,以及非空的 ## Intent 与 ## Requirements。## Non-goals、## Open questions、## Affected areas 仅在有信息量时才添加。
  • 规定每条需求的固定写法:### AC-001 - 短名称 下必须且只能有三个条目,按顺序为 When(一个具体条件,或表示不变式的 always)、Then(行为者必须做一个可观察的动作,且只能使用 MUST、MUST NOT、SHOULD、SHOULD NOT、MAY 之一)、Verify with(确切命令或具名人工检查)。
  • 对结构性变更(重构、迁移、重写、升级、模式变更、性能变更)额外要求:## Baseline(当前结构与行为,附 file:line、测试或命令证据)、以 When: always 表达的被保留行为需求及防漂移验证、## Waves(每步都保持构建与测试通过的最小有序步骤,含影响面、验证与回滚点)、## Cutover(进入、完成、中止、恢复条件)。兼容性垫片需给出路径与移除条件;旧调用点计数目标为具名垫片之外为零;性能需在同一协议下前后测量。
  • 并行拆分:仅当独立工作者并行实现时,添加 ## Split,每个切片一行,含需求 ID、允许写入路径、排除路径、Starts after、May run with。每条需求只属于一个切片;只有写入互斥且不共享接口、模式、生成文件或构建配置时才可并行;接口定义工作优先排序。
  • 交接前验证清单:frontmatter 有效且 AC ID 唯一、Intent 非空、每条需求三要素块与一个强度词、status: ready 时无 TBD/TODO/??? 或阻塞性问题、本地来源可解析、每个 wave 有验证、每个切片写入互斥且需求恰好覆盖一次。
  • 仅检查模式:报告确切错误而不编辑。
  • 实现者需在 ## Execution 下记录变更文件、每条验证命令的退出状态与决定性输出、范围漂移与阻塞问题;缺失输出即视为未验证;实现者不能验收自己的工作,需由非实现者在原生 pull request 上评审。

使用方式

先阅读项目规则、当前代码、测试、相关决策与开放 issue;可自行确定可发现的事实与可逆约定,仅在涉及实质性行为、公开契约、安全、成本或不可逆选择时询问人类,且先给建议、两三个真实选项及各自代价。若一句精确的话即可约束工作,则内联写明并附验证,不写文件;否则写出 spec。存在未解决的阻塞性选择时保持 status: draft 并阻塞相关工作。

产物写入 ~/.agents/artifacts/<workspace>/<ID>.md(~ 展开),<workspace> 为仓库或工作目录的基名;旁车文件(如证据回执、运行笔记)放在旁边并链接。不得覆盖,冲突时询问名称;目录不可写时提供授权重试、换用户目录或取消,绝不回退到仓库、厂商目录或临时路径。本地来源引用相对产物路径,交接用绝对路径。输出仅返回指向产物及旁车的可点击链接,标注 ~/.agents/... 并用绝对目标;只解释阻塞、写入失败、验证不完整或不可逆操作确认。当无下游步骤需要该集合时,向人类询问一次:Delete、Leave 或 Promote 进项目自有记录;Delete 后确认每个路径都已消失。

适用场景

需要把意图固化为带验收标准的规格、对结构性变更做基线保护与分波推进、在多个独立工作者之间安全拆分实现任务,或在交接前做规格自检时。

限制

该技能是一套流程与格式规范,不提供自动化代码生成或执行能力;其效果依赖人工按清单执行与评审。资料未说明具体平台支持范围、安装命令、收费方式或性能指标,暂未提供。