From afdd6c5388cbcce9645342719ee8c256a05a5dd8 Mon Sep 17 00:00:00 2001 From: Alan Zimmerman Date: Mon, 12 Mar 2018 17:32:23 +0200 Subject: [PATCH] Add an architecture decision record directory See https://adr.github.io/ Add lightweight documents defining architectural decisions taken at a point in time, so that the discussion around the decision-making process is not lost. To me this would include changes like deciding to do away with most of the sub-projects, the decision to bring in IdeM and IdeGhcM, and so on. We do not have to retroactively document these, but it gives us a place to capture decisions at least. --- .adr-dir | 1 + .../adr/0001-record-architecture-decisions.md | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 .adr-dir create mode 100644 docs/adr/0001-record-architecture-decisions.md diff --git a/.adr-dir b/.adr-dir new file mode 100644 index 000000000..c73b64aed --- /dev/null +++ b/.adr-dir @@ -0,0 +1 @@ +docs/adr diff --git a/docs/adr/0001-record-architecture-decisions.md b/docs/adr/0001-record-architecture-decisions.md new file mode 100644 index 000000000..589d02c8d --- /dev/null +++ b/docs/adr/0001-record-architecture-decisions.md @@ -0,0 +1,19 @@ +# 1. Record architecture decisions + +Date: 2018-03-12 + +## Status + +Accepted + +## Context + +We need to record the architectural decisions made on this project. + +## Decision + +We will use Architecture Decision Records, as described by Michael Nygard in this article: http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions + +## Consequences + +See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's _adr-tools_ at https://github.com/npryce/adr-tools.