From 8d20932ee1688c8dcdcff6ced4518c06ff244bcf Mon Sep 17 00:00:00 2001 From: Hannes Baum Date: Fri, 5 Jan 2024 11:41:38 +0100 Subject: [PATCH] Differentiation between standards and decision records (#352) Adds a template for decision records and updates the template for standards, since both document types are different from each other. Signed-off-by: Hannes Baum --- .../scs-XXXX-vN-decision-record-template.md | 41 +++++++++++++++++++ ...te.md => scs-XXXX-vN-standard-template.md} | 15 +++++-- 2 files changed, 52 insertions(+), 4 deletions(-) create mode 100644 Standards/scs-XXXX-vN-decision-record-template.md rename Standards/{scs-XXXX-vN-template.md => scs-XXXX-vN-standard-template.md} (76%) diff --git a/Standards/scs-XXXX-vN-decision-record-template.md b/Standards/scs-XXXX-vN-decision-record-template.md new file mode 100644 index 000000000..1a212f481 --- /dev/null +++ b/Standards/scs-XXXX-vN-decision-record-template.md @@ -0,0 +1,41 @@ +--- +title: _Descriptive title_ +type: Decision Record +status: Draft +track: Global # | IaaS | Ops | KaaS | IAM +author: Author +date: DD-MM-YYYY +--- + + + +## Introduction + +Introduction + +## Terminology + +Example (abbr. Ex) + This is the description for an example terminology. + +## Context + +What is the issue that we're seeing that is motivating this decision or change? + +## Decision + +What is the decision that we're proposing and/or doing? +Should also include reasoning for this decision + +## Consequences + +What becomes easier or more difficult to do because of this change? + +## Related Documents + +Related Documents, OPTIONAL diff --git a/Standards/scs-XXXX-vN-template.md b/Standards/scs-XXXX-vN-standard-template.md similarity index 76% rename from Standards/scs-XXXX-vN-template.md rename to Standards/scs-XXXX-vN-standard-template.md index 6a17c0a85..68e376f69 100644 --- a/Standards/scs-XXXX-vN-template.md +++ b/Standards/scs-XXXX-vN-standard-template.md @@ -1,8 +1,10 @@ --- title: _Descriptive title_ -type: Standard # | Decision Record | Procedural +type: Standard # | Procedural status: Draft track: Global # | IaaS | Ops | KaaS | IAM +author: Author +date: DD-MM-YYYY ---