docs: add initial adr

machshev · Apr 19, 2024 · 305676d · 305676d
1 parent e270a4b
commit 305676d
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/.adr-dir b/.adr-dir
@@ -0,0 +1 @@
+doc/adr
diff --git a/doc/adr/0001-record-architecture-decisions.md b/doc/adr/0001-record-architecture-decisions.md
@@ -0,0 +1,20 @@
+# 1. Record architecture decisions
+
+Date: 2024-04-19
+
+## 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](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](https://github.com/npryce/adr-tools).
+