diff --git a/docs/adr/template.md b/docs/adr/template.md index b07f46e2eb0..b4974469854 100644 --- a/docs/adr/template.md +++ b/docs/adr/template.md @@ -1,73 +1,67 @@ -# \[short title of solved problem and solution\] +# MADR Templae -* Status: \[proposed \| rejected \| accepted \| deprecated \| … \| superseded by [ADR-0005](0005-fully-support-utf8-only-for-latex-files.md)\] -* Deciders: \[list everyone involved in the decision\] -* Date: \[YYYY-MM-DD when the decision was last updated\] +The template of [MADR](https://adr.github.io/madr/) is available at . +You can omit the `<-- optional -->` parts, which lead to a very minimal ADR: -Technical Story: \[description \| ticket/issue URL\] +```markdown +# [short title of solved problem and solution] ## Context and Problem Statement -\[Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.\] - -## Decision Drivers - -* \[driver 1, e.g., a force, facing concern, …\] -* \[driver 2, e.g., a force, facing concern, …\] -* … +[Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.] ## Considered Options -* \[option 1\] -* \[option 2\] -* \[option 3\] -* … +* [option 1] +* [option 2] +* [option 3] +* … ## Decision Outcome -Chosen option: "\[option 1\]", because \[justification. e.g., only option, which meets k.o. criterion decision driver \| which resolves force force \| … \| comes out best \(see below\)\]. - -### Positive Consequences +Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … ]. +``` -* \[e.g., improvement of quality attribute satisfaction, follow-up decisions required, …\] -* … +In case you want to include the pros and cons of the options, the template is as follows: -### Negative Consequences +```markdown +# [short title of solved problem and solution] -* \[e.g., compromising quality attribute, follow-up decisions required, …\] -* … - -## Pros and Cons of the Options +## Context and Problem Statement -### \[option 1\] +[Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.] -\[example \| description \| pointer to more information \| …\] +## Considered Options -* Good, because \[argument a\] -* Good, because \[argument b\] -* Bad, because \[argument c\] -* … +* [option 1] +* [option 2] +* [option 3] +* … -### \[option 2\] +## Decision Outcome -\[example \| description \| pointer to more information \| …\] +Chosen option: "[option 1]", because comes out best (see below). -* Good, because \[argument a\] -* Good, because \[argument b\] -* Bad, because \[argument c\] -* … +## Pros and Cons of the Options -### \[option 3\] +### [option 1] -\[example \| description \| pointer to more information \| …\] +* Good, because [argument a] +* Good, because [argument b] +* Bad, because [argument c] +* … -* Good, because \[argument a\] -* Good, because \[argument b\] -* Bad, because \[argument c\] -* … +### [option 2] -## Links +* Good, because [argument a] +* Good, because [argument b] +* Bad, because [argument c] +* … -* \[Link type\] \[Link to ADR\] -* … +### [option 3] +* Good, because [argument a] +* Good, because [argument b] +* Bad, because [argument c] +* … +```