infra-monitoring-kuma/docs/decisions/template.md

42 lines
1.3 KiB
Markdown
Raw Normal View History

---
# status and date are the only required elements. Feel free to remove the rest.
status: {[proposed | rejected | approved | deprecated | … | superceded by [2021-01-01 Example](2021-01-01-example.md)]}
date: {YYYY-MM-DD when the decision was last updated}
builds-on: {[Short Title](2021-05-15-short-title.md)}
story: {description or link to contextual issue}
---
# {short title of solved problem and solution}
## Context & Problem Statement
2-3 sentences explaining the problem, and what are the forces influencing the decision.
<!-- The language in this section is value-neutral. It is simply describing facts. -->
## Priorities & Constraints <!-- optional -->
* {list of concerns}
* {that are influencing the decision}
## Considered Options
* Option 1: Thing
* Option 2: Another
## Decision Outcome
Chosen option [Option 1: Thing]
[justification]
### Expected Consequences <!-- optional -->
* List of unrelated outcomes this decision creates.
<!-- Positive, negative, and/or neutral consequences, as lll of them affect the team and project in the future. -->
## More Information <!-- optional -->
<!-- * Resources reviewed as part of making this decision -->
<!-- * Links to any supporting documents or resources -->
<!-- * Related PRs -->
<!-- * Related User Journeys -->