From d5b38ecf3d421ff710121a998cde37c57fde3915 Mon Sep 17 00:00:00 2001 From: Alexander Lorz Date: Tue, 10 Sep 2024 10:01:41 +0200 Subject: [PATCH] Introduce decision record --- .../decisions/001-use_decision_records.md | 18 ++++++++++++++++++ documentation/decisions/_decision_template.md | 15 +++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 documentation/decisions/001-use_decision_records.md create mode 100644 documentation/decisions/_decision_template.md diff --git a/documentation/decisions/001-use_decision_records.md b/documentation/decisions/001-use_decision_records.md new file mode 100644 index 0000000..736ea95 --- /dev/null +++ b/documentation/decisions/001-use_decision_records.md @@ -0,0 +1,18 @@ +# 001 - Use Decisions Records + +## Status: Accepted + +## Context +Gernot and Alex discovered that we should have done this years ago. + +## Decision + +We introduce decision records into the repo. + +## Rationale + +We wont ta keep track of the WHYs of our decisions concerning the curriculum. + +## Consequences: +* Add folder and template in repo. +* Inform other FLWG members \ No newline at end of file diff --git a/documentation/decisions/_decision_template.md b/documentation/decisions/_decision_template.md new file mode 100644 index 0000000..f2ea696 --- /dev/null +++ b/documentation/decisions/_decision_template.md @@ -0,0 +1,15 @@ +# Decision ID: [Unique identifier for the decision] - Title: [Brief, descriptive title of the decision] + +## Status: [Proposed / Accepted / Deprecated / Superseded] + +## Context: +[Describe the current situation and the forces at play. What led to this decision point?]## Decision: +[Clearly state the decision that was made] +## Rationale: +[Explain the reasoning behind the decision. Include pros and cons considered] +## Consequences: +[Describe the resulting context after applying the decision. Include both positive and negative consequences]## Alternatives Considered: +[List other options that were considered and briefly explain why they were not chosen]## Related Decisions: +[List any related decisions, if applicable]## Stakeholders: +[List the stakeholders involved in or affected by this decision]## References: +[Include any relevant sources, research, or external links] \ No newline at end of file