Architectural Decision Records¶
This folder contains Architectural Decision Records (ADR's). They provide a lightweight way of documenting the reasons why certain architectural and technological decisions were taken, and more importantly the context which led to these decisions. This allows to revisit them later on in case the context changes or more information becomes available. See Michael Nygard's blog post for more details on ADR's.
ADR's should follow this template:
Title: short present tense imperative phrase, less than 50 characters, like a git commit message.
Date: when was this issue discussed (to give approximate temporal context)
Status: proposed, accepted, rejected, deprecated, superseded, etc.
Context: what is the issue that we're seeing that is motivating this decision or change.
This section describes the forces at play, including technological, political, social, and project local. These forces are probably in tension, and should be called out as such. The language in this section is value-neutral. It is simply describing facts.
Decision: what is the change that we're actually proposing or doing (describes our response to these forces)
Consequences: what becomes easier or more difficult to do because of this change.
All consequences should be listed here, not just the "positive" ones. A particular decision may have positive, negative, and neutral consequences, but all of them affect the team and project in the future.