Skip to content

Instantly share code, notes, and snippets.

@pietrop

pietrop/adr_template.md

Forked from iaincollins/adr_template.md
Created October 29, 2018 10:25
Show Gist options
  • Save pietrop/e0d9fce89d7d837f0ca01d24e190c48c to your computer and use it in GitHub Desktop.
Save pietrop/e0d9fce89d7d837f0ca01d24e190c48c to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @iaincollins iaincollins renamed this gist Oct 26, 2018. 1 changed file with 0 additions and 0 deletions.
    0 gistfile1.txt → adr_template.md
    View file
    File renamed without changes.
  2. @iaincollins iaincollins created this gist Oct 26, 2018.
    72 changes: 72 additions & 0 deletions gistfile1.txt
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,72 @@
    # [short title of solved problem and solution]

    * Status: [accepted | superseded by [ADR-0005](0005-example.md) | deprecated | …] <!-- optional -->
    * Deciders: [list everyone involved in the decision] <!-- optional -->
    * Date: [YYYY-MM-DD when the decision was last updated] <!-- 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 [ADR-0005](0005-example.md) -->
    * … <!-- numbers of links can vary -->