Record Decisions as ADRs
Added 2026-10
Record Decisions as ADRs — Chinese original prompt
团队要为一个决定留下记录:[决定内容,比如数据库或消息队列的选型]。请按架构决策记录的格式写一份,包含当时的约束、考虑过的方案及各自代价、最终选择和理由,以及什么情况下应该重新评估。输出:一份可直接入库的短文档(不超过一页)、需要补充的数据、后续变更时怎么更新它。
Site original
Chinese original
Example
Sample input
要为一次选型留记录:消息队列选了自建还是托管,按架构决策记录格式写一份。
The output should include
- 含当时约束、候选方案与代价
- 最终选择与理由都要写具体
- 标出什么情况下应重新评估
Replace these placeholders 1
Swap the bracketed parts for your own details before sending.
[决定内容,比如数据库或消息队列的选型]
How to use
重点写被否掉的方案和原因,那是半年后最想知道的部分。
Try tweaking it
- Have it restate requirements and constraints before writing code.
- Ask for the smallest change plus a rollback path, not a full-file rewrite.
What you should get
- A minimal, runnable change with copy-ready code
- Impact list: which files and call sites must follow
Common mistakes
- Asking it to touch ten files at once, then losing track of what broke what.
- Pasting only the error, with no code or version, and getting an unfixable answer.
How to check the output
- The change runs, can be rolled back, and touches nothing unrelated.
- Edge cases (empty, oversized, concurrent) are covered or explained.
Where it works
- Good for: having it restate requirements and constraints, then propose the smallest runnable change.
- Watch out: include versions and a minimal reproduction with the error, or the fix may look plausible but not fit.