galata. GitHub ↗

ADR-0000: Template

Context

What forces are at play? What is true about the world that makes this a decision rather than an obvious step? State the constraints, not the conclusion.

Decision

What was decided, in the imperative. One paragraph if possible.

Alternatives considered

Each alternative gets its honest best case before its cost. An ADR that strawmans the rejected option is worth nothing to the reader who has to revisit it in two years.

Consequences

What becomes easier, what becomes harder, and what is now expensive to reverse. Name the specific things that would have to change if this decision is undone.

Revisit when

The condition under which this decision should be reopened. If there is no such condition, say so.