joelparkerhenderson / architecture-decision-record

Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation
Other
11.53k stars 2.39k forks source link

First ADR should always be about why we introduce ADRs in a project! #51

Open christian-weiss opened 2 years ago

christian-weiss commented 2 years ago

If you introduce ADRs into a project (or organisation), then the decision to introduce ADRs should be recorded as an ADR.

This ADR context should explain:

To collect some examples as inspiration to others: Please attach to this github issue your ADR, that introduces ADRs to your project. (This may help others to put arguments when introducing ADRs) ;-)

Consequences - e.g.:

Or do you think that ADR is not a AD at all?

Funding

Fund with Polar

mgan59 commented 2 years ago

Agree, it is important to indicate in the first ADR what format is being adopted 👍🏻

I use the Homebrew ADR CLI tool (created by Nat Pryce) which by default supports Michael Nygards ADR format. When you run adr init in a new project it creates the default ADR-0001


# 1. Record architecture decisions

Date: 2019-03-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).