2.5 KiB
[short title of solved problem and solution]
- Authors: [who wrote the ADR]
- Status: [draft | proposed | rejected | accepted | deprecated | … | superseded by xxx]
- Deciders: [list everyone involved in the decision]
- Date: [YYYY-MM-DD when the decision was last updated]
- Tags: [space and/or comma separated list of tags]
Technical Story: [description | ticket/issue URL]
Summary
Quick description of the problem and the context. Should not take more than 2-3 lines.
Problem Statement
Description of the technical problem to solve or to decision to make. This should be concise but provide all required details and the context related to the technical decision to be taken.
Goals or Decision Drivers
Depending the context define clearly what are the goals or what are the most important decision drivers.
- [driver 1, e.g., a force, facing concern, …]
- [driver 2, e.g., a force, facing concern, …]
- …
Non-goals
Define what's out of the scope of this ADR.
Considered Options
- [option 1]
- [option 2]
- [option 3]
- …
Pros and Cons of the Options
[option 1]
[example | description | pointer to more information | …]
- Good, because [argument a]
- Good, because [argument b]
- Bad, because [argument c]
- …
[option 2]
[example | description | pointer to more information | …]
- Good, because [argument a]
- Good, because [argument b]
- Bad, because [argument c]
- …
Solution or decision outcome
Summarize the solution or decision outcome in one-two lines.
Rationale & discussion
Describe the solution or the decision outcome discussing how decision drivers have been applied and how it matches the declared goals. This section is expected to be concise though providing comprehensive description of the technical solution and covering all uncertainty or ambiguous points.
Links
- [Link type](link to adr)
- …