Skip to content

Instantly share code, notes, and snippets.

@Integralist
Last active June 23, 2020 12:33
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Integralist/94474b1d73deeb832f1f22f080f50c8a to your computer and use it in GitHub Desktop.
Save Integralist/94474b1d73deeb832f1f22f080f50c8a to your computer and use it in GitHub Desktop.
[ADR Architecture Decision Record] #architecture #decision #record #adr

1. Title

Date: YYYY-MM-DD

Status

Accepted|Deprecated|Proposed|Superseded

A decision may be "proposed" if the project stakeholders haven't agreed with it yet, or "accepted" once it is agreed. If a later ADR changes or reverses a decision, it may be marked as "deprecated" or "superseded" with a reference to its replacement.

Context

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. Describe the facts in the 'present tense' (i.e. don't detail the facts as if the problems they describe have been solved already).

Decision

This section describes our response to these forces. It is stated in full sentences, with active voice. "We will ..."

Consequences

This section describes the resulting context, after applying the decision. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment