编程开发 通用 中文 English 架构决策记录 为此仓库中已做出(或正在做出)的决策编写一份 ADR。目标是简短、事实性地记录决定了什么,…… 生成后的提示词 为此仓库中已做出(或正在做出)的决策编写一份 ADR。目标是简短、事实性地记录决定了什么、为什么,以及哪些替代方案被拒绝——让没有背景的人在两分钟内读懂。 ## 步骤 1. **确定决策** - 准确界定决定了什么以及何时决定。先阅读相关代码、配置和文档,使 ADR 符合实际情况,而非意图。 2. **收集背景** - 是什么问题迫使做出此决策?适用了哪些约束(团队、截止日期、技术栈、成本)?引用证据:issue、PR、代码。 3. **列出考虑过的选项** - 至少两个真实替代方案加上所选方案。对每个方案:一行摘要、优点、缺点。 4. **论证选择** - 结合背景说明为什么该选项胜出。要具体:“使用 Postgres,因为我们需要事务且已经在运行它”胜过“它是行业标准”。 5. **记录后果** - 什么变得更容易,什么变得更困难,随之而来哪些新义务(迁移、运行手册、许可成本)。 6. **编号并归档** - 如果仓库已有 ADR 约定(`docs/adr/`、`adr/`),遵循它;否则建议使用下一个空闲编号的 `docs/adr/NNNN-title.md`。 ## 验证 - [ ] 决策以已做出的形式陈述,并带有日期,而不是作为愿望。 - [ ] 记录至少两个真实替代方案,并说明每个为何落选。 - [ ] 论证基于实际迫使该选择的约束。 - [ ] 后果指明什么变得更容易、什么变得更困难。 - [ ] 编号和文件位置遵循仓库现有的 ADR 约定。 - [ ] 关于代码库的每一项声明都已对照实际代码验证。 - [ ] 后续分歧记录为取代性 ADR,而不是重写历史。 ## 规则 - 按决策已做出的方式描述它,而不是按你希望它被做出的方式描述。 - 不重写历史:如果某项决策今天看起来是错的,将其记为取代性 ADR 的候选,而不是编辑旧 ADR。 - 关于代码库的每一项声明都必须对照实际代码验证。 复制提示词 分享提示词 查看示例 发送到 AI 优化器 收藏模板 保存当前版本 示例 关闭 分享 卡片风格 雾面玻璃 暖白纸笺 深夜蓝图 薄荷网格 珊瑚日落 水墨笺 关闭 图片仅展示节选。