From ddc193b6362e3ed5c8bebe7601e93ce129808749 Mon Sep 17 00:00:00 2001 From: Hendrik Schmidt Date: Tue, 14 May 2024 18:27:55 +0200 Subject: [PATCH] Update 0001-record-architecture-decisions.md --- packages/dito/doc/adr/0001-record-architecture-decisions.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/packages/dito/doc/adr/0001-record-architecture-decisions.md b/packages/dito/doc/adr/0001-record-architecture-decisions.md index 5211a691..2cf02cf7 100644 --- a/packages/dito/doc/adr/0001-record-architecture-decisions.md +++ b/packages/dito/doc/adr/0001-record-architecture-decisions.md @@ -17,3 +17,9 @@ We will use Architecture Decision Records, as [described by Michael Nygard](http ## 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). + +Furthermore, some additional clarification on how we use the sections of an ADR: + +- The `Context` provides information about the requirements of the decision topic and describes the considerations made, like pros and cons of different competing options. +- The `Decision` clearly states what we will do and can contain a short reasoning that lead to the decision. +- The `Consequences` lay out the resulting context; mentioning specific benefits, drawbacks and derived actions/mitigations.