Skip to content

Commit

Permalink
Update 0001-record-architecture-decisions.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HendrikSchmidt committed May 14, 2024
1 parent 015a0a2 commit ddc193b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions packages/dito/doc/adr/0001-record-architecture-decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit ddc193b

Please sign in to comment.