From 2f4632b594c23fc12b1b0d37e650cc62043b2ad5 Mon Sep 17 00:00:00 2001 From: "A.J. Stein" Date: Mon, 6 Feb 2023 17:42:42 -0500 Subject: [PATCH] Add ADR structure for usnistgov/OSCAL#1408. --- .../0001-record-architecture-decisions.md | 21 +++++++++++++++++++ decisions/adr_template.md | 13 ++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 decisions/0001-record-architecture-decisions.md create mode 100644 decisions/adr_template.md diff --git a/decisions/0001-record-architecture-decisions.md b/decisions/0001-record-architecture-decisions.md new file mode 100644 index 0000000000..44e097d7fa --- /dev/null +++ b/decisions/0001-record-architecture-decisions.md @@ -0,0 +1,21 @@ +# 1. Record architecture decisions + +Date: 2023-02-06 + +## Status + +Feedback Requested + +## Context + +We need to record the architectural decisions made on this project. + +We also need the ability to compare architecture decisions regarding OSCAL artifacts, supporting software, and website material (documentation and otherwise). + +## Decision + +We will use Architecture Decision Records, as described by Michael Nygard in his article ["Documenting Architecture Decisions"](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). + +## Consequences + +See Michael Nygard's article, linked above. diff --git a/decisions/adr_template.md b/decisions/adr_template.md new file mode 100644 index 0000000000..29f2564963 --- /dev/null +++ b/decisions/adr_template.md @@ -0,0 +1,13 @@ +# N. Brief ADR Title + +Date: + +## Status + +Proposed + +## Context + +## Decision + +## Consequences