Skip to content

Commit ee6b8d0

Browse files
tholorgithub-actions[bot]ZanSara
authoredJan 28, 2022
Add ADR template for transparent architecture decisions (deepset-ai#2072)
* add adr template for decisions * Add latest docstring and tutorial changes * Add latest docstring and tutorial changes Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Sara Zan <sara.zanzottera@deepset.ai>
1 parent 7764b69 commit ee6b8d0

File tree

1 file changed

+74
-0
lines changed

1 file changed

+74
-0
lines changed
 

‎docs/decisions/adr-template.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# {short title of solved problem and solution}
2+
3+
* Status: {proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)} <!-- optional -->
4+
* Deciders: {list everyone involved in the decision} <!-- optional -->
5+
* Date: {YYYY-MM-DD when the decision was last updated} <!-- optional -->
6+
7+
Technical Story: {description | ticket/issue URL} <!-- optional -->
8+
9+
## Context and Problem Statement
10+
11+
{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.}
12+
13+
## Decision Drivers <!-- optional -->
14+
15+
* {driver 1, e.g., a force, facing concern, …}
16+
* {driver 2, e.g., a force, facing concern, …}
17+
*<!-- numbers of drivers can vary -->
18+
19+
## Considered Options
20+
21+
* {option 1}
22+
* {option 2}
23+
* {option 3}
24+
*<!-- numbers of options can vary -->
25+
26+
## Decision Outcome
27+
28+
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)}.
29+
30+
### Positive Consequences <!-- optional -->
31+
32+
* {e.g., improvement of quality attribute satisfaction, follow-up decisions required, …}
33+
*
34+
35+
### Negative Consequences <!-- optional -->
36+
37+
* {e.g., compromising quality attribute, follow-up decisions required, …}
38+
*
39+
40+
## Pros and Cons of the Options <!-- optional -->
41+
42+
### {option 1}
43+
44+
{example | description | pointer to more information | …} <!-- optional -->
45+
46+
* Good, because {argument a}
47+
* Good, because {argument b}
48+
* Bad, because {argument c}
49+
*<!-- numbers of pros and cons can vary -->
50+
51+
### {option 2}
52+
53+
{example | description | pointer to more information | …} <!-- optional -->
54+
55+
* Good, because {argument a}
56+
* Good, because {argument b}
57+
* Bad, because {argument c}
58+
*<!-- numbers of pros and cons can vary -->
59+
60+
### {option 3}
61+
62+
{example | description | pointer to more information | …} <!-- optional -->
63+
64+
* Good, because {argument a}
65+
* Good, because {argument b}
66+
* Bad, because {argument c}
67+
*<!-- numbers of pros and cons can vary -->
68+
69+
## Links <!-- optional -->
70+
71+
* {Link type} {Link to ADR} <!-- example: Refined by [ADR-0005](0005-example.md) -->
72+
*<!-- numbers of links can vary -->
73+
74+
<!-- markdownlint-disable-file MD013 -->

0 commit comments

Comments
 (0)
Please sign in to comment.