SuperAPI AI 工具集

to-spec

编程与开发

查看项目

更新于 10-15 10:24

技能介绍

用途

to-spec 用于将当前对话上下文与对代码库的理解综合成一份规格说明(spec),并发布到项目的 issue 跟踪器。它明确不进行用户访谈,只综合已经讨论过的内容。

主要能力

  • 从当前对话和代码库理解中生成规格,无需额外访谈。
  • 探索仓库以了解代码库当前状态。
  • 在规格中贯穿使用项目领域词汇,并遵守所涉及区域的 ADR。
  • 勾勒测试接缝(seam):优先使用现有接缝,使用尽可能高的接缝;如需新接缝,在尽可能高的位置提出;接缝越少越好,理想数量为一个。
  • 与用户确认这些接缝是否符合预期。
  • 按模板撰写规格并发布到项目 issue 跟踪器。
  • 应用 ready-for-agent triage 标签,无需额外 triage。

使用方式

该技能依赖已提供的 issue 跟踪器和 triage 标签词汇。如果尚未提供,需告知用户运行 /setup-matt-pocock-skills。

流程:

  1. 如果尚未进行,探索仓库以了解代码库当前状态。
  2. 在规格中贯穿使用项目领域词汇,并遵守所涉及区域的 ADR。
  3. 勾勒将要测试该功能的接缝。优先使用现有接缝,使用尽可能高的接缝。如需新接缝,在尽可能高的位置提出。接缝越少越好,理想数量为一个。
  4. 与用户确认这些接缝是否符合预期。
  5. 使用下方模板撰写规格,然后发布到项目 issue 跟踪器。
  6. 应用 ready-for-agent triage 标签,无需额外 triage。

规格模板包含以下部分:

  • Problem Statement:从用户视角描述用户面临的问题。
  • Solution:从用户视角描述问题的解决方案。
  • User Stories:一个很长的、编号的用户故事列表,每条格式为“As an , I want a , so that ”。该列表应极其详尽,覆盖功能的所有方面。
  • Implementation Decisions:已做出的实现决策列表,可包括将构建/修改的模块、这些模块将被修改的接口、来自开发者的技术澄清、架构决策、schema 变更、API 契约、具体交互。不要包含具体文件路径或代码片段,因为它们可能很快过时。例外:如果原型产出的片段比文字更精确地编码了某个决策(状态机、reducer、schema、类型形状),可将其内联在相关决策中,并简要注明来自原型;只保留决策密集的部分,而非可运行 demo。
  • Testing Decisions:已做出的测试决策列表,包括对什么是好测试的描述(只测试外部行为,不测试实现细节)、将测试哪些模块、测试的既有先例(即代码库中类似类型的测试)。
  • Out of Scope:描述本规格范围之外的内容。
  • Further Notes:关于该功能的任何补充说明。

适用场景

适用于已经就某个功能进行过讨论、需要把讨论结果固化为规格并发布到 issue 跟踪器的工作流。

限制

  • 不进行用户访谈,只综合已有内容。
  • 需要预先提供 issue 跟踪器和 triage 标签词汇,否则需先运行 /setup-matt-pocock-skills。
  • 实现决策中不应包含具体文件路径或代码片段(原型片段例外)。
  • 关于收费、价格、平台、效果等具体信息暂未提供。