UNPKG

@log4brains/init

Version:

Log4brains architecture knowledge base initialization CLI

github.com/thomvaill/log4brains

thomvaill/log4brains

74 lines (47 loc) • 2.38 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# [short title of solved problem and solution] - Status: [draft | proposed | rejected | accepted | deprecated | … | superseded by [xxx](yyyymmdd-xxx.md)] <!-- optional --> - Deciders: [list everyone involved in the decision] <!-- optional --> - Date: [YYYY-MM-DD when the decision was last updated] <!-- optional. To customize the ordering without relying on Git creation dates and filenames --> - Tags: [space and/or comma separated list of tags] <!-- optional --> Technical Story: [description | ticket/issue URL] <!-- optional --> ## 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 -->