-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
878792b
commit 5d8aa98
Showing
1 changed file
with
95 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
# NUMBER. TITLE | ||
|
||
Date: DATE | ||
Status: status <!-- Proposed | Accepted | Rejected | Superceded --> | ||
|
||
## 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 <!-- optional --> | ||
|
||
- [driver 1, e.g., a force, facing concern, …] | ||
- [driver 2, e.g., a force, facing concern, …] | ||
- … <!-- numbers of drivers can vary --> | ||
|
||
## Considered Options | ||
|
||
- [option 1] | ||
- [option 2] | ||
- [option 3] | ||
- … <!-- numbers of options can vary --> | ||
|
||
## 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 <!-- optional --> | ||
|
||
- [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …] | ||
- … | ||
|
||
### Negative Consequences <!-- optional --> | ||
|
||
- [e.g., compromising quality attribute, follow-up decisions required, …] | ||
- … | ||
|
||
## Pros and Cons of the Options <!-- optional --> | ||
|
||
### [option 1] | ||
|
||
[example | description | pointer to more information | …] <!-- optional --> | ||
|
||
- Good, because [argument a] | ||
- Good, because [argument b] | ||
- Bad, because [argument c] | ||
- … <!-- numbers of pros and cons can vary --> | ||
|
||
### [option 2] | ||
|
||
[example | description | pointer to more information | …] <!-- optional --> | ||
|
||
- Good, because [argument a] | ||
- Good, because [argument b] | ||
- Bad, because [argument c] | ||
- … <!-- numbers of pros and cons can vary --> | ||
|
||
### [option 3] | ||
|
||
[example | description | pointer to more information | …] <!-- optional --> | ||
|
||
- Good, because [argument a] | ||
- Good, because [argument b] | ||
- Bad, because [argument c] | ||
- … <!-- numbers of pros and cons can vary --> | ||
|
||
## Code Examples | ||
|
||
[If relevant / it would help the discussion, please provide code examples here that would help in comparing the various options on the table. | ||
|
||
A few possible options for doing this: | ||
|
||
- A link to a gist or proof of concept repository | ||
- A separate code block using [github code fencing](https://help.github.com/articles/creating-and-highlighting-code-blocks/) | ||
- If necessary, you can add a new folder within the `docs/decisions` directory titled `000X-decision-name-files` and add necessary code files there. | ||
Ideally use the same mechanism for storing all files related to a decision - the below examples are meant to show the full set of different options | ||
] | ||
|
||
### Option 1 Code Example <!-- optional --> | ||
|
||
```javascript | ||
console.log('Hello, World!'); | ||
``` | ||
|
||
### Option 2 Code Example <!-- optional --> | ||
|
||
[Link to gist](www.example.com) | ||
|
||
### Option 3 Code Example <!-- optional --> | ||
|
||
[local link to file](000X-decision-name-files/example.js) | ||
|
||
## Links <!-- optional --> | ||
|
||
- [Link type](link to adr) <!-- example: Refined by [xxx](yyyymmdd-xxx.md) --> | ||
- … <!-- numbers of links can vary --> |