...

Text file src/edge-infra.dev/pkg/tools/dlog/cmd/testdata/template.md

Documentation: edge-infra.dev/pkg/tools/dlog/cmd/testdata

     1---
     2# Required elements
     3#
     4# "proposed | rejected | accepted | deprecated | superseded by [...]
     5status: "proposed"
     6# YYYY-MM-DD of last time the decision was updated
     7date: "1970-01-01"
     8# List of all parties that had a say in the decision, e.g.: @github_handle, @org/team_slug
     9deciders: []
    10# These are optional elements. Feel free to remove any of them.
    11#
    12# List of tags categorizing the decision for sorting / filtering, e.g.: "build", "api"
    13tags: []
    14# List of all parties that were consulted on the decision, typicall subject-matter
    15# experts, e.g.: @github_handle, @org/team_slug
    16consulted: []
    17# List of all parties that should be kept up-to-date
    18informed: []
    19---
    20
    21# {short title of solved problem and solution}
    22
    23## Context and Problem Statement
    24
    25{Describe the context and problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story.
    26 You may want to articulate the problem in form of a question and add links to collaboration boards or issue management systems.}
    27
    28<!-- This is an optional element. Feel free to remove. -->
    29## Decision Drivers
    30
    31* {decision driver 1, e.g., a force, facing concern, …}
    32* {decision driver 2, e.g., a force, facing concern, …}
    33* … <!-- numbers of drivers can vary -->
    34
    35## Considered Options
    36
    37* {title of option 1}
    38* {title of option 2}
    39* {title of option 3}
    40* … <!-- numbers of options can vary -->
    41
    42## Decision Outcome
    43
    44Chosen option: "{title of option 1}", because
    45{justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
    46
    47<!-- This is an optional element. Feel free to remove. -->
    48### Consequences
    49
    50* Good, because {positive consequence, e.g., improvement of one or more desired qualities, …}
    51* Bad, because {negative consequence, e.g., compromising one or more desired qualities, …}
    52* … <!-- numbers of consequences can vary -->
    53
    54<!-- This is an optional element. Feel free to remove. -->
    55## Pros and Cons of the Options
    56
    57### {title of option 1}
    58
    59<!-- This is an optional element. Feel free to remove. -->
    60{example | description | pointer to more information | …}
    61
    62* Good, because {argument a}
    63* Good, because {argument b}
    64<!-- use "neutral" if the given argument weights neither for good nor bad -->
    65* Neutral, because {argument c}
    66* Bad, because {argument d}
    67* … <!-- numbers of pros and cons can vary -->
    68
    69### {title of other option}
    70
    71{example | description | pointer to more information | …}
    72
    73* Good, because {argument a}
    74* Good, because {argument b}
    75* Neutral, because {argument c}
    76* Bad, because {argument d}
    77* …
    78
    79<!-- This is an optional element. Feel free to remove. -->
    80## More Information
    81
    82{You might want to provide additional evidence/confidence for the decision outcome here and/or
    83 document the team agreement on the decision and/or
    84 define when and how this decision should be realized and if/when it should be re-visited and/or
    85 how the decision is validated.
    86 Links to other decisions and resources might appear here as well.}

View as plain text