Initial commit
This commit is contained in:
74
skills/documentation-wizard/References/adr-template.md
Normal file
74
skills/documentation-wizard/References/adr-template.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# ADR-{number}: {Short title of solved problem and solution}
|
||||
|
||||
Date: {YYYY-MM-DD}
|
||||
Status: {Proposed | Accepted | Deprecated | Superseded}
|
||||
Deciders: {List everyone involved in the decision}
|
||||
Related: {Links to related ADRs, Oracle entries, Summoner MCDs}
|
||||
|
||||
## 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
|
||||
|
||||
* {decision driver 1, e.g., a force, facing concern, ...}
|
||||
* {decision driver 2, e.g., a force, facing concern, ...}
|
||||
* {etc.}
|
||||
|
||||
## Considered Options
|
||||
|
||||
* {option 1}
|
||||
* {option 2}
|
||||
* {option 3}
|
||||
* {etc.}
|
||||
|
||||
## 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
|
||||
|
||||
* {e.g., improvement of quality attribute satisfaction, follow-up decisions required, ...}
|
||||
* {etc.}
|
||||
|
||||
### Negative Consequences
|
||||
|
||||
* {e.g., compromising quality attribute, follow-up decisions required, ...}
|
||||
* {etc.}
|
||||
|
||||
## 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}
|
||||
* {etc.}
|
||||
|
||||
### {option 2}
|
||||
|
||||
{example | description | pointer to more information | ...}
|
||||
|
||||
* Good, because {argument a}
|
||||
* Good, because {argument b}
|
||||
* Bad, because {argument c}
|
||||
* {etc.}
|
||||
|
||||
### {option 3}
|
||||
|
||||
{example | description | pointer to more information | ...}
|
||||
|
||||
* Good, because {argument a}
|
||||
* Good, because {argument b}
|
||||
* Bad, because {argument c}
|
||||
* {etc.}
|
||||
|
||||
## Links
|
||||
|
||||
* {Link to related Oracle knowledge entries}
|
||||
* {Link to Summoner Mission Control Documents}
|
||||
* {Link to code references}
|
||||
* {Link to related ADRs}
|
||||
* {External references}
|
||||
Reference in New Issue
Block a user