SuperAPI AI 工具集

spec-loop-write-adr

编程与开发

查看项目

更新于 10-16 02:15

技能介绍

spec-loop-write-adr 是 spec-loop 技能集中专门负责架构决策记录(ADR)撰写的技能。它的核心职责是在 architecture-decisions/ 目录下创建、更新或取代 ADR。

用途

该技能仅用于撰写 ADR。它不会自行判断是否需要一份 ADR;ADR 工作的启动条件是用户主动要求,或 Spec Loop 工作流将其路由到该任务。正在起草或更新的 ADR 是该技能的治理产物。无论是否存在任务产物,都使用相同的 ADR 格式。

主要能力

  • 在 architecture-decisions/ 路径下创建、更新或取代 ADR。
  • 在开始工作前读取并应用 adr-format.md 的格式规范。
  • 读取并应用项目中存在的指令文件,例如 AGENTS.md。
  • 强制澄清关卡:在把 ADR 作为当前事实起草或修订之前,检查是否仍存在关于决策、其标准、权衡、可信选项或决策边界的重要未决问题。若存在,则先建立足以安全承载主题与当前证据的 ADR 结构,再通过 spec-loop-clarify-task/SKILL.md 与用户交互,而不等待用户显式请求澄清,也不以非结构化的标准讨论或头脑风暴代替这一交接。每当后续起草暴露新的重要未决决策时,重新运行该关卡。
  • 输入分类:撰写或修订前,将每个输入项归类到相应部分。Context(上下文)指在另一种可信替代方案下仍然成立的决策前事实,例如需求、约束、现状发现、范围边界和明确的推迟事项;Alternatives(备选方案)指可信的竞争选项;Analysis(分析)指已澄清的推理、已接受的标准、权衡、选项比较,以及所选方案胜出的简要理由;Decision(决策)指作为 TL;DR 的选定结果,包括属于结果一部分的明确推迟或主要保留边界。
  • Analysis 被视为 ADR 的权威决策与理由台账,不在其他地方以决策与理由的形式重复 Analysis 中的要点。
  • 当存在任务产物时,使用其 Research、Analysis 以及其他与 ADR 相关的章节(如 Constraints、Design,以及相关时的 Scenario)作为 ADR 的主要输入;否则使用已确认的对话澄清和其他当前证据。

使用方式

当用户要求 ADR 工作或 Spec Loop 工作流路由到该任务时触发。技能先读取 adr-format.md 和项目指令,再检查强制澄清关卡,随后按 Context、Alternatives、Analysis、Decision 分类输入并撰写或修订 ADR。

适用场景

适用于需要记录、更新或取代架构决策的场景,尤其是配合 Spec Loop 工作流使用时。

限制

该技能不自行判断是否需要 ADR;缺少项目指令文件、任务产物或已确认澄清时,相关输入暂未提供。技能的收费、价格和具体平台信息暂未提供。