Skip to content

Commit

Permalink
Update MADR template, provide short summary, and fix link
Browse files Browse the repository at this point in the history
  • Loading branch information
koppor committed Feb 4, 2018
1 parent f14d224 commit 6df4512
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 29 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ ADR example templates that we have collected on the net:
* [ADR template by Jeff Tyree and Art Akerman](adr_template_by_jeff_tyree_and_art_akerman.md) (more sophisticated)
* [ADR template for Alexandrian pattern](adr_template_for_alexandrian_pattern.md) (simple with context specifics)
* [ADR template for business case](adr_template_for_business_case.md) (more MBA-oriented, with costs, SWOT, and more opinions)
* [ADR template MADR](adr_template_madr)
* [ADR template MADR](adr_template_madr.md) (focuses on considered options)
* [ADR template using Planguage](adr_template_using_planguage.md) (more quality assurance oriented)


Expand Down
62 changes: 34 additions & 28 deletions adr_template_madr.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,48 @@
# *[short title of solved problem and solution]*
# [short title of solved problem and solution]

**User Story:** *[ticket/issue-number]* <!-- optional -->
User Story: [ticket/issue-number] <!-- optional -->

*[context and problem statement]*
*[decision drivers | forces]* <!-- optional -->
[context and problem statement]
[decision drivers | forces | facing] <!-- optional -->

## Considered Alternatives
## Considered Options

* *[alternative 1]*
* *[alternative 2]*
* *[alternative 3]*
* *[...]* <!-- numbers of alternatives can vary -->
* [option 1]
* [option 2]
* [option 3]
* ... <!-- numbers of options can vary -->

## Decision Outcome

* Chosen Alternative: *[alternative 1]*
* *[justification. e.g., only alternative, which meets k.o. criterion decision driver | which resolves force force | ... | comes out best (see below)]*
* *[consequences. e.g., negative impact on quality attribute, follow-up decisions required, ...]* <!-- optional -->
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)].

## Pros and Cons of the Alternatives <!-- optional -->
Positive Consequences: <!-- optional -->
- [e.g., improvement of quality attribute satisfaction, follow-up decisions required, ...]
- ...

### *[alternative 1]*
Negative consequences: <!-- optional -->
- [e.g., compromising quality attribute, follow-up decisions required, ...]
- ...

* `+` *[argument 1 pro]*
* `+` *[argument 2 pro]*
* `-` *[argument 1 con]*
* *[...]* <!-- numbers of pros and cons can vary -->
## Pros and Cons of the Options <!-- optional -->

### *[alternative 2]*
### [option 1]

* `+` *[argument 1 pro]*
* `+` *[argument 2 pro]*
* `-` *[argument 1 con]*
* *[...]* <!-- numbers of pros and cons can vary -->
* Good, because [argument a]
* Good, because [argument b]
* Bad, because [argument c]
* ... <!-- numbers of pros and cons can vary -->

### *[alternative 3]*
### [option 2]

* `+` *[argument 1 pro]*
* `+` *[argument 2 pro]*
* `-` *[argument 1 con]*
* *[...]* <!-- numbers of pros and cons can vary -->
* Good, because [argument a]
* Good, because [argument b]
* Bad, because [argument c]
* ... <!-- numbers of pros and cons can vary -->

### [option 3]

* Good, because [argument a]
* Good, because [argument b]
* Bad, because [argument c]
* ... <!-- numbers of pros and cons can vary -->

0 comments on commit 6df4512

Please sign in to comment.