Orrery
A GPU-accelerated N-body gravitational simulator
Loading...
Searching...
No Matches
ADR-0000: Title in the imperative

  • Status: Proposed | Accepted | Superseded by ADR-NNNN, linked to its file
  • Date: YYYY-MM-DD

Context

The situation that forces a decision. State the constraint, the measurement or the requirement that makes the question live. A reader who knows nothing about the project should understand from this section why the decision could not be avoided.

Decision

What was decided, in one or two sentences, in the present tense.

Alternatives considered

Each credible alternative, with the reason it was not taken. An ADR is worth writing precisely because a reviewer might reasonably have expected one of these instead, so this section carries most of the value.

Consequences

What follows from the decision, including what becomes harder. An ADR that lists only benefits is a sales pitch rather than a record.