upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorDanConwayDev <DanConwayDev@protonmail.com>2025-12-04 15:45:48 +0000
committerDanConwayDev <DanConwayDev@protonmail.com>2025-12-04 15:45:48 +0000
commit8c129a4aeab3288f8193ccb820adf00860c50d74 (patch)
treec7ac3ca0b408fe3a03c37e7dbfa93a902f33700c /AGENTS.md
parent819866330c7e2f535a155d1d7efaf2e12dc15dc2 (diff)
docs: add guidance to keep architecture docs updated
- Added CRITICAL warning section to AGENTS.md about treating architecture docs as living documents - Mark 'Keep Architecture Docs Updated' item as fixed in grasp-01 learnings - Mark 'Document actual architecture' technical debt item as fixed This addresses a key learning from GRASP-01 where docs described plans rather than implementation, causing confusion.
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md
index 236602b..6fbec69 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -172,6 +172,17 @@ fn test_audit_tags_automatically_added() {
172 172
173## Documentation 173## Documentation
174 174
175**⚠️ CRITICAL: Keep Architecture Docs Updated**
176
177Architecture and design documents are LIVING DOCUMENTS. When implementation diverges from the documented plan:
178
1791. **Update the doc IMMEDIATELY** - Don't wait until "later"
1802. **Document what was actually built**, not what was originally planned
1813. **Note why decisions changed** - Future readers need this context
1824. **Files to watch:** `docs/explanation/architecture.md`, `docs/explanation/decisions.md`
183
184This was a key learning from GRASP-01: docs described plans, not implementation, causing confusion.
185
175**Diátaxis Framework Used:** 186**Diátaxis Framework Used:**
176 187
177- `docs/tutorials/` - Learning-oriented 188- `docs/tutorials/` - Learning-oriented