Use authoritative ADR directory
This commit is contained in:
@@ -1,8 +1,8 @@
|
|||||||
# ADR Format
|
# ADR Format
|
||||||
|
|
||||||
ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.
|
ADRs live in `docs/authoritative/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.
|
||||||
|
|
||||||
Create the `docs/adr/` directory lazily — only when the first ADR is needed.
|
Create the `docs/authoritative/adr/` directory lazily — only when the first ADR is needed.
|
||||||
|
|
||||||
## Template
|
## Template
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ Only include these when they add genuine value. Most ADRs won't need them.
|
|||||||
|
|
||||||
## Numbering
|
## Numbering
|
||||||
|
|
||||||
Scan `docs/adr/` for the highest existing number and increment by one.
|
Scan `docs/authoritative/adr/` for the highest existing number and increment by one.
|
||||||
|
|
||||||
## When to offer an ADR
|
## When to offer an ADR
|
||||||
|
|
||||||
|
|||||||
@@ -15,9 +15,10 @@ Most repos have a single context:
|
|||||||
/
|
/
|
||||||
├── CONTEXT.md
|
├── CONTEXT.md
|
||||||
├── docs/
|
├── docs/
|
||||||
│ └── adr/
|
│ └── authoritative/
|
||||||
│ ├── 0001-event-sourced-orders.md
|
│ └── adr/
|
||||||
│ └── 0002-postgres-for-write-model.md
|
│ ├── 0001-event-sourced-orders.md
|
||||||
|
│ └── 0002-postgres-for-write-model.md
|
||||||
└── src/
|
└── src/
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -27,17 +28,18 @@ If a `CONTEXT-MAP.md` exists at the root, the repo has multiple contexts. The ma
|
|||||||
/
|
/
|
||||||
├── CONTEXT-MAP.md
|
├── CONTEXT-MAP.md
|
||||||
├── docs/
|
├── docs/
|
||||||
│ └── adr/ ← system-wide decisions
|
│ └── authoritative/
|
||||||
|
│ └── adr/ ← system-wide decisions
|
||||||
├── src/
|
├── src/
|
||||||
│ ├── ordering/
|
│ ├── ordering/
|
||||||
│ │ ├── CONTEXT.md
|
│ │ ├── CONTEXT.md
|
||||||
│ │ └── docs/adr/ ← context-specific decisions
|
│ │ └── docs/authoritative/adr/ ← context-specific decisions
|
||||||
│ └── billing/
|
│ └── billing/
|
||||||
│ ├── CONTEXT.md
|
│ ├── CONTEXT.md
|
||||||
│ └── docs/adr/
|
│ └── docs/authoritative/adr/
|
||||||
```
|
```
|
||||||
|
|
||||||
Create files lazily — only when you have something to write. If no `CONTEXT.md` exists, create one when the first term is resolved. If no `docs/adr/` exists, create it when the first ADR is needed.
|
Create files lazily — only when you have something to write. If no `CONTEXT.md` exists, create one when the first term is resolved. If no `docs/authoritative/adr/` exists, create it when the first ADR is needed.
|
||||||
|
|
||||||
## During the session
|
## During the session
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user