diff options
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 11 |
1 files changed, 11 insertions, 0 deletions
| @@ -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 | |||
| 177 | Architecture and design documents are LIVING DOCUMENTS. When implementation diverges from the documented plan: | ||
| 178 | |||
| 179 | 1. **Update the doc IMMEDIATELY** - Don't wait until "later" | ||
| 180 | 2. **Document what was actually built**, not what was originally planned | ||
| 181 | 3. **Note why decisions changed** - Future readers need this context | ||
| 182 | 4. **Files to watch:** `docs/explanation/architecture.md`, `docs/explanation/decisions.md` | ||
| 183 | |||
| 184 | This 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 |