- Authors: [who wrote the ADR]
- Status: [draft | proposed | rejected | accepted | deprecated | … | superseded by xxx]
- Date: [YYYY-MM-DD when the decision was last updated]
Quick description of the problem and the context. Should not take more than 2-3 lines.
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.
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, …]
- …
Define what's out of the scope of this ADR.
[example | description | pointer to more information | …]
- Good, because [argument a]
- Good, because [argument b]
- Bad, because [argument c]
- …
[example | description | pointer to more information | …]
- Good, because [argument a]
- Good, because [argument b]
- Bad, because [argument c]
- …
Summarize the solution or decision outcome in one-two lines.
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.
- [Link type](link to adr)
- …