Skip to content

Commit

Permalink
Add ADR structure for usnistgov#1408.
Browse files Browse the repository at this point in the history
  • Loading branch information
aj-stein-nist committed Feb 6, 2023
1 parent 5afde6c commit bfb6a35
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
21 changes: 21 additions & 0 deletions decisions/0001-record-architecture-decisions.md
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 13 additions & 0 deletions decisions/adr_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# N. Brief ADR Title

Date:

## Status

Proposed

## Context

## Decision

## Consequences

0 comments on commit bfb6a35

Please sign in to comment.