mirror of
https://github.com/DOI-DO/j40-cejst-2.git
synced 2025-02-22 01:31:25 -08:00
Create decision-record.md
Adding a new issue template for architecture decision records - Work in progress, these will shortly be integrated with a dedicated project board
This commit is contained in:
parent
ad72a5014c
commit
be319cbe0b
1 changed files with 75 additions and 0 deletions
75
.github/ISSUE_TEMPLATE/decision-record.md
vendored
Normal file
75
.github/ISSUE_TEMPLATE/decision-record.md
vendored
Normal file
|
@ -0,0 +1,75 @@
|
|||
---
|
||||
name: Architectural Decision Record
|
||||
about: Propose an architectural decision
|
||||
title: 'ADR: [decision here]'
|
||||
labels: 'decision-record'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
# [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 <!-- 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 -->
|
||||
|
||||
## Links <!-- optional -->
|
||||
|
||||
- [Link type](link to adr) <!-- example: Refined by [xxx](yyyymmdd-xxx.md) -->
|
||||
- … <!-- numbers of links can vary -->
|
Loading…
Add table
Reference in a new issue