SuperAPI AI 工具集

to-spec

编程与开发

查看项目

更新于 11-02 16:13

技能介绍

to-spec 是一个用于把当前对话转化为规格说明(spec)并发布到项目 issue tracker 的技能。其核心定位是「综合」而非「访谈」:它直接利用你已经讨论过的内容和代码库理解来产出规格,不会向用户发起访谈。

用途:将对话中已形成的需求与设计共识固化为可追踪的规格文档,并发布到项目的 issue tracker,便于后续由智能体或开发者按规格实现。

主要能力与使用流程:

  1. 前置条件:issue tracker 与 triage 标签词表应已提供给该技能;若未提供,需提示用户运行 /setup-matt-pocock-skills。
  2. 探索仓库:若尚未了解代码库,先探索仓库以理解当前状态;规格中应使用项目领域词汇表中的术语,并遵守相关区域的 ADR(架构决策记录)。
  3. 划定测试接缝(seams):优先复用已有接缝而非新建,尽量使用最高层级的接缝;若需新建接缝,应在尽可能高的位置提出;接缝越少越好,理想数量为一个。随后与用户确认这些接缝是否符合预期。
  4. 撰写规格:按模板撰写,包括问题陈述(从用户视角描述用户面临的问题)、解决方案(从用户视角描述)、用户故事(一长串编号列表,格式为「作为……,我想要……,以便……」)、实现决策(模块、接口、技术澄清、架构决策、schema 变更、API 契约、具体交互等;不包含具体文件路径或代码片段,例外是能更精确表达决策的原型片段,需注明来自原型并只保留决策关键部分)、测试决策(好测试的标准即只测试外部行为而非实现细节、被测模块、代码库中类似测试的先例)、范围外内容、进一步说明。
  5. 发布:将规格发布到项目 issue tracker,并打上 ready-for-agent 的 triage 标签,无需额外 triage。

适用场景:在对话中已完成需求讨论后,需要快速将共识整理为结构化规格并进入 issue 跟踪流程时使用。

限制:不进行用户访谈;依赖已提供的 issue tracker 与 triage 标签信息;规格中不写具体文件路径或代码片段;具体支持哪些 issue tracker 平台、安装方式及更多技术细节暂未提供。