yadr/templates/yadr-template-bare.yaml at main · adr/yadr · GitHub

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
---
metadata:
  status: TODO
  date: yyyy-mm-dd
  decision-makers: TODO
  consulted: TODO
  informed: TODO

# This is an experimental YAML port of the MADR template adr-template-bare.md (full template, but no explanations/guiding comments)

title: TODO  # short title, representative of solved problem and found solution

context-and-problem-statement: TODO

decision-drivers:
- TODO <!-- decision driver 1 -->
- TODO <!-- decision driver 2 -->

considered-options:
- &id-of-option-1 '{title of option 1}'
- &id-of-option-2 '{title of option 2}'

pros-and-cons-of-the-options:

  # the id/title needs to match the one defined in considered-options
  id-of-option-1:
    description: |
      {example | description | pointer to more information | …}

    pros:
      - &argument-a '{argument a}'
      - '{argument b}'

    neutral:
      - &argument-c '{argument c}'

    cons:
      - &argument-d '{argument d}'

  # same for other options

decision-outcome:

  chosen-option:
    link: "*id-of-option-1"
    justification: "Because ..."

  consequences:
    good:
    - TODO <!-- argument1 -->
    - TODO <!-- argument2 -->
    neutral:
    - TODO <!-- argument1 -->
    - TODO <!-- argument2 -->
    bad:
    - TODO <!-- argument1 -->
    - TODO <!-- argument2 -->

confirmation: TODO

more-information: TODO