claude
2684095e2f
Co-authored-by: claude <claude@jpaul.io> Co-committed-by: claude <claude@jpaul.io>
42 lines
1.5 KiB
Markdown
42 lines
1.5 KiB
Markdown
<!--
|
|
ADR template — Architecture Decision Record (lightweight).
|
|
|
|
An ADR captures ONE decision so the reasoning survives the meeting. Copy this file into your repo
|
|
(e.g. docs/adr/0001-some-decision.md), number it, and fill in the sections. Keep it short — an ADR
|
|
that nobody reads because it's long has failed at its only job.
|
|
|
|
In the Module 3 lab you hand this template to the AI and ask it to fill it out for a real decision,
|
|
then review its draft as a diff before merging. Write one sentence per line where you can: it keeps
|
|
future git diffs surgical instead of reflowing whole paragraphs.
|
|
|
|
Delete these HTML comments when you write the real ADR.
|
|
-->
|
|
|
|
# ADR NNNN — <short decision title>
|
|
|
|
- **Status:** proposed | accepted | superseded by ADR-XXXX
|
|
- **Date:** YYYY-MM-DD
|
|
- **Deciders:** <who made the call>
|
|
|
|
## Context
|
|
|
|
<!-- What's the situation that forces a decision? The problem, the constraints, what's at stake.
|
|
One short paragraph. State facts, not the conclusion. -->
|
|
|
|
## Decision
|
|
|
|
<!-- The choice, stated plainly in one or two sentences. "We will ___." -->
|
|
|
|
## Alternatives considered
|
|
|
|
<!-- The options you did NOT pick, and the one-line reason each lost. This is the part that saves a
|
|
future reader from re-litigating the decision. -->
|
|
|
|
- **<option>** — <why not>
|
|
- **<option>** — <why not>
|
|
|
|
## Consequences
|
|
|
|
<!-- What this decision makes easier, harder, or impossible later. Include the downsides you accepted
|
|
with open eyes — an ADR with no negative consequences is hiding something. -->
|