github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/documentation/adr/template.md (about)

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