ADR 创建器
创建简洁的架构决策记录(ADR),解释决策内容、背景、选项和后果。
激活契约
当用户请求创建 ADR、架构决策记录、技术决策记录或任何关于技术/架构选择原因的正式记录时,使用此技能。
默认进入访谈模式,除非用户已经提供了足够信息来起草完整的 ADR。使用用户的语言进行访谈提问。ADR 工件语言默认为英语,除非用户明确要求使用其他语言。
硬性规则
- 在访谈模式下,一次仅提问一个问题。
- 在访谈开始时,明确告知用户可以跳过问题或随时停止访谈。
- 维护一个动态的预估剩余问题计数器,当依赖关系出现或消失时更新它。
- 在有助于用户回答时,推荐简短示例答案。
- 使用易读的 Markdown 格式(而非纯文本)呈现访谈问题。
- 在用户给出模糊、矛盾或无理由的回答时,提出建设性质疑;如果用户明确要求继续,则照常推进。
- 不要自行编造备选方案、优缺点或理由。当备选方案缺失时,主动提问。
- 如果决策已经做出,使用
Accepted;如果尚在提议、评估阶段或状态不明,使用Proposed。 - 仅当用户明确要求文件/路径时,才写入或修改文件。
访谈流程
仅收集所需信息,按依赖顺序进行:
- 决策标题和状态。
- 背景:问题、约束条件、驱动因素以及为什么当前需要做出决策。
- 选定的方案或提议。
- 考虑的备选方案,及各方案的优缺点。
- 后果:收益、缺点、风险和权衡。
- 后续跟踪:仅在存在有用的待办行动或未解决问题时进行。
问题格式:
### 问题 N —— [聚焦的问题]
**推荐答案:** [有用的简短示例]
**为什么重要:** [简要原因]
**预估剩余问题数:** ~M
小例子:
### 问题 1 —— 该决策已经做出还是仍在提议中?
**推荐答案:** “已接受 — 我们已经为账单数据选择了 PostgreSQL。”
**为什么重要:** 状态决定了 ADR 记录的是最终选择还是正在审查的提议。
**预估剩余问题数:** ~5
输出契约
在起草前,先阅读 assets/template-markdown.md 并填充其结构。
默认情况下,将最终的 ADR 作为一个 Markdown 代码块返回,不创建文件。如果用户明确要求保存到某文件/路径,则将 ADR 保存到该位置,并在聊天中汇总保存的路径。
不要在最终的 ADR 中留有任何占位符指令。如果用户有意跳过了某个必需细节,仅在那个跳过的细节上使用 TBD,且要尽量少用。
参考
- 模板:
assets/template-markdown.md