Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,20 @@ docs/TECHNICAL-DESIGN.md
docs/BACKUPS.md # backup, verification and restore runbook
docs/DEPLOYMENT.md # deploy, rollback and operations
docs/HANDOFF.md # next task prompt and backlog
docs/adr/ # one file per irreversible decision
```

## Documentation Policy

Docs capture decisions and current state, never session narration.

- **Allowed:** this file, `README`, `docs/TECHNICAL-DESIGN.md`, `docs/adr/NNN-*.md` (one decision:
context, options, decision, consequences), the runbooks (`BACKUPS`, `DEPLOYMENT`) and
`docs/HANDOFF.md`.
- **Forbidden:** phase reports, progress logs, "what I did" narration and per-session summaries.
When a change needs a durable record, update the design doc or add an ADR — do not create a
report file. This applies to AI output too.

## Commands

| Task | Command |
Expand Down
9 changes: 9 additions & 0 deletions docs/adr/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Architecture Decision Records

One file per irreversible or costly decision: `NNN-title.md` with **Context**, **Options**,
**Decision** and **Consequences**. Written by the human, in a few paragraphs — not generated as a
report.

Use an ADR when a choice is hard to reverse or future-you needs the *why* (money as `long`, money
in exact pesos, ownership enforced twice, history indestructible). For everyday changes, update the
relevant [spec](../specs/) and the code instead.
Loading