agile-context-engineering 0.2.2 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/CHANGELOG.md +82 -0
  2. package/LICENSE +51 -51
  3. package/README.md +324 -323
  4. package/agents/ace-research-synthesizer.md +228 -228
  5. package/agents/ace-technical-application-architect.md +28 -0
  6. package/agents/ace-wiki-mapper.md +445 -334
  7. package/agile-context-engineering/src/ace-tools.test.js +1089 -1089
  8. package/agile-context-engineering/templates/_command.md +53 -53
  9. package/agile-context-engineering/templates/_workflow.xml +16 -16
  10. package/agile-context-engineering/templates/product/product-backlog.xml +231 -231
  11. package/agile-context-engineering/templates/product/story-integration-solution.xml +1 -0
  12. package/agile-context-engineering/templates/product/story-wiki.xml +4 -0
  13. package/agile-context-engineering/templates/wiki/coding-standards.xml +38 -0
  14. package/agile-context-engineering/templates/wiki/decizions.xml +115 -115
  15. package/agile-context-engineering/templates/wiki/guide.xml +137 -137
  16. package/agile-context-engineering/templates/wiki/module-discovery.xml +174 -174
  17. package/agile-context-engineering/templates/wiki/pattern.xml +159 -159
  18. package/agile-context-engineering/templates/wiki/system-architecture.xml +254 -254
  19. package/agile-context-engineering/templates/wiki/system-cross-cutting.xml +197 -197
  20. package/agile-context-engineering/templates/wiki/system.xml +381 -381
  21. package/agile-context-engineering/templates/wiki/walkthrough.xml +255 -0
  22. package/agile-context-engineering/templates/wiki/wiki-readme.xml +297 -276
  23. package/agile-context-engineering/utils/questioning.xml +110 -110
  24. package/agile-context-engineering/workflows/execute-story.xml +1219 -1145
  25. package/agile-context-engineering/workflows/help.xml +540 -540
  26. package/agile-context-engineering/workflows/init-coding-standards.xml +386 -386
  27. package/agile-context-engineering/workflows/map-story.xml +1046 -797
  28. package/agile-context-engineering/workflows/map-subsystem.xml +2 -1
  29. package/agile-context-engineering/workflows/map-walkthrough.xml +457 -0
  30. package/agile-context-engineering/workflows/plan-feature.xml +1495 -1495
  31. package/agile-context-engineering/workflows/plan-story.xml +36 -1
  32. package/agile-context-engineering/workflows/research-integration-solution.xml +1 -0
  33. package/agile-context-engineering/workflows/research-story-wiki.xml +2 -1
  34. package/agile-context-engineering/workflows/research-technical-solution.xml +1 -0
  35. package/agile-context-engineering/workflows/review-story.xml +281 -281
  36. package/agile-context-engineering/workflows/update.xml +238 -207
  37. package/bin/install.js +8 -0
  38. package/commands/ace/execute-story.md +1 -0
  39. package/commands/ace/help.md +93 -93
  40. package/commands/ace/init-coding-standards.md +83 -83
  41. package/commands/ace/map-story.md +165 -156
  42. package/commands/ace/map-subsystem.md +140 -138
  43. package/commands/ace/map-system.md +92 -92
  44. package/commands/ace/map-walkthrough.md +127 -0
  45. package/commands/ace/plan-feature.md +89 -89
  46. package/commands/ace/plan-story.md +15 -1
  47. package/commands/ace/review-story.md +109 -109
  48. package/commands/ace/update.md +56 -54
  49. package/hooks/ace-check-update.js +62 -62
  50. package/hooks/ace-statusline.js +89 -89
  51. package/package.json +4 -3
@@ -1,381 +1,381 @@
1
- <system>
2
- <purpose>
3
- Template for `.docs/wiki/subsystems/[subsystem-name]/systems/<system-name>.md` — a coherent
4
- domain system within a codebase subsystem. Answers "How does this system work RIGHT NOW?"
5
-
6
- Each system doc describes WHAT exists, HOW it works, and WHERE things live for one
7
- domain concern. It is the primary document an AI agent reads before implementing a
8
- related story.
9
-
10
- A "system" is a logical grouping of components that together deliver one domain capability
11
- (e.g., Drawing System, User Management, Order Processing). A codebase subsystem may
12
- contain multiple systems.
13
-
14
- Complements:
15
- - patterns/ docs (HOW to apply reusable implementation patterns)
16
- - cross-cutting/ docs (concerns spanning multiple systems)
17
- - guides/ docs (step-by-step recipes combining multiple patterns)
18
- - decisions/ docs (WHY significant choices were made)
19
- </purpose>
20
-
21
- <template>
22
- <overview>
23
- # [System Name]
24
-
25
- ## Overview
26
- One paragraph: what this system does, why it exists.
27
- </overview>
28
-
29
- <file-tree>
30
- ## File Tree
31
-
32
- All files belonging to this system with purpose annotations.
33
- Update when new files are added by a story.
34
-
35
- ```
36
- src/[layer]/[area]/
37
- |-- FileA.ts # Brief purpose
38
- |-- FileB.ts # Brief purpose
39
- `-- subfolder/
40
- |-- FileC.ts # Brief purpose
41
- `-- FileD.ts # Brief purpose
42
- ```
43
- </file-tree>
44
-
45
- <system-boundary>
46
- ## System Boundary
47
-
48
- Mermaid diagram showing what is INSIDE this system vs what it connects to OUTSIDE.
49
- Helps agents understand scope — what to touch, what NOT to touch.
50
-
51
- ```mermaid
52
- graph TB
53
- subgraph "System Name"
54
- A[Component A]
55
- B[Component B]
56
- C[Component C]
57
- end
58
- External[External System]
59
- B --&gt; External
60
- ```
61
- </system-boundary>
62
-
63
- <class-and-interface-hierarchy>
64
- ## Class and Interface Hierarchy
65
-
66
- Inheritance chains and interface implementations.
67
-
68
- ```mermaid
69
- classDiagram
70
- class IExample {
71
- &lt;&lt;interface&gt;&gt;
72
- }
73
- class BaseClass {
74
- &lt;&lt;abstract&gt;&gt;
75
- }
76
- IExample &lt;|.. BaseClass
77
- BaseClass &lt;|-- ConcreteA
78
- BaseClass &lt;|-- ConcreteB
79
- ```
80
-
81
- Key contracts INLINE (only interfaces/types that define the API shape):
82
-
83
- ```typescript
84
- export interface IExample {
85
- // Only the contract shape — not implementation code
86
- }
87
- ```
88
- </class-and-interface-hierarchy>
89
-
90
- <entry-points>
91
- ## Entry Points
92
-
93
- Where flows begin. Each entry point is a "front door" into this system.
94
- - User action: Click on chart -&gt; `file:MouseHandler.onClick`
95
- - API endpoint: POST /api/resource -&gt; `file:ResourceController.create`
96
- - Event handler: onTimeframeChange -&gt; `file:VisibilityManager.handleTimeframeChange`
97
- </entry-points>
98
-
99
- <data-flow-and-sequence-diagrams required="true">
100
- ## Data Flow and Sequence Diagrams
101
-
102
- **MANDATORY — every system doc MUST have at least one mermaid sequenceDiagram.**
103
- This is the most critical section. Without E2E flow diagrams, an agent cannot
104
- understand how data moves through the system.
105
-
106
- How data moves through this system for each key behavior.
107
- Use mermaid sequence diagrams showing the complete flow through all layers.
108
-
109
- ### Flow: [Behavior Name]
110
-
111
- ```mermaid
112
- sequenceDiagram
113
- participant User
114
- participant Entry as EntryPoint
115
- participant Svc as Service
116
- participant Domain as DomainEntity
117
- participant Repo as Repository
118
- participant DB as DataStore
119
-
120
- User-&gt;&gt;Entry: action
121
- Entry-&gt;&gt;Svc: command/query
122
- Svc-&gt;&gt;Domain: business logic
123
- Domain--&gt;&gt;Svc: result
124
- Svc-&gt;&gt;Repo: persist/retrieve
125
- Repo-&gt;&gt;DB: SQL/query
126
- DB--&gt;&gt;Repo: result
127
- Repo--&gt;&gt;Svc: domain object
128
- Svc--&gt;&gt;Entry: response
129
- Entry--&gt;&gt;User: feedback
130
- ```
131
- </data-flow-and-sequence-diagrams>
132
-
133
- <components>
134
- ## Components
135
-
136
- ### [Component A]
137
- - **Location**: `src/infrastructure/primitives/trend-line/TrendLine.ts:TrendLine`
138
- - **Purpose**: One line
139
- - **Key interface**: `src/domain/interfaces/IDrawing.ts:IDrawing`
140
- - **Implements**: ISeriesPrimitive, IDrawing
141
-
142
- ### [Component B]
143
- ...
144
- </components>
145
-
146
- <key-behaviors>
147
- ## Key Behaviors
148
-
149
- ### [Behavior 1]
150
- - **Trigger**: What causes this behavior
151
- - **Logic**: Where the logic lives (`file:ClassName.method`), brief description
152
- - **Effect**: What happens as a result
153
-
154
- ### [Behavior 2]
155
- ...
156
- </key-behaviors>
157
-
158
- <state-management>
159
- ## State Management
160
-
161
- What state this system owns, where it lives, how it flows.
162
- - **State location**: Redux store at `file:drawingSlice` / local state in `file:DrawingManager`
163
- - **Key state shape**: (inline only if non-obvious)
164
- - **State transitions**: What actions/events cause state changes
165
- </state-management>
166
-
167
- <error-propagation>
168
- ## Error Propagation
169
-
170
- What errors this system throws/handles and how they propagate through layers.
171
- - `DrawingValidationError` at `file:Path.validate` -&gt; caught by `file:DrawingFactory` -&gt; user notification
172
- - `RepositoryError` at `file:ResourceRepository.save` -&gt; propagates to controller -&gt; HTTP 500
173
- </error-propagation>
174
-
175
- <constants-and-enums>
176
- ## Constants and Enums
177
-
178
- Where constants and enums for this system are defined. Agent MUST use these, never hardcode.
179
- - **Constants**: `src/domain/constants/DrawingConstants.ts:DrawingConstants`
180
- - **Enums**: `src/domain/enums/DrawingType.ts:DrawingType`
181
- - **Config lookup**: `src/domain/configs/DrawingConfigLookup.ts:DrawingConfigLookup`
182
- </constants-and-enums>
183
-
184
- <related-systems>
185
- ## Related Systems
186
-
187
- What other systems this one interacts with. Agent should read these docs before modifying.
188
- - [Event System](../cross-cutting/event-system.md) — publishes/subscribes to events
189
- - [Settings System](./settings-system.md) — configuration modal
190
- </related-systems>
191
-
192
- <integration-points>
193
- ## Integration Points
194
-
195
- - Connects to: [other system] via [mechanism] at `file:ClassName.method`
196
- - Consumed by: [component] at `file:ClassName.method`
197
- </integration-points>
198
-
199
- <configuration-and-options>
200
- ## Configuration and Options
201
-
202
- Options interface shape and defaults. Agent needs this to implement new variants.
203
-
204
- ```typescript
205
- export interface ISystemOptions {
206
- // Contract shape — what options this system accepts
207
- }
208
- ```
209
-
210
- Default values: `file:SystemDefaults.ts:SYSTEM_DEFAULTS`
211
- </configuration-and-options>
212
-
213
- <database>
214
- ## Database
215
-
216
- Include ONLY if this system has database interactions. Omit entirely for pure frontend systems.
217
-
218
- - **Table**: `table_name` — migration at `file:migrations/20240101_CreateTable.sql`
219
- - **Key columns**: id, type, data (jsonb), created_at
220
- - **Indexes**: `idx_table_column` on `column`
221
- </database>
222
-
223
- <gotchas>
224
- ## Gotchas
225
-
226
- Things that commonly go wrong or are easy to forget when working with this system.
227
- - Constructor timing: factory methods called from `super()` BEFORE subclass fields initialize
228
- - Button IDs have NO hyphens, registry types DO have hyphens
229
- </gotchas>
230
-
231
- <tech-debt>
232
- ## Tech Debt
233
-
234
- Known quality issues in this system discovered during story code reviews.
235
- Items are added by the wiki mapper and removed when fixed by a future story.
236
- Include ONLY if this system has known tech debt items. Omit section entirely if clean.
237
-
238
- ### [Short descriptive title of the issue]
239
- - **Severity:** high | medium | low
240
- - **File:** `[file-path:SymbolName]`
241
- - **Description:** What the issue is, why it matters, and what could go wrong
242
- if left unfixed. Reference specific code constructs where applicable.
243
- - **Discovered during:** [story-id] — [story title]
244
-
245
- ### [Another issue]
246
- - **Severity:** ...
247
- - **File:** ...
248
- - **Description:** ...
249
- - **Discovered during:** ...
250
- </tech-debt>
251
- </template>
252
-
253
- <guidelines>
254
-
255
- **Documentation Style:**
256
- - EXTREMELY SUCCINCT — every word must add value
257
- - NO FLUFF — direct, actionable information only
258
- - Bullet points over paragraphs
259
- - File trees: ASCII only (`|--`, backtick-dash-dash) — never Unicode box-drawing characters
260
- - **ALL visual representations of architecture, dependencies, flows, or relationships MUST be ```mermaid fenced code blocks. NO ASCII arrows (->), NO dependency trees, NO PlantUML. Only mermaid. The ONLY ASCII exception is file trees (directory listings).**
261
- - Code references as `file-path:ClassName.methodName` or `file-path:functionName` (not line numbers)
262
- - Inline snippets ONLY for interfaces, types, and short patterns that define contracts
263
- - When referencing a whole class/module: `file-path:ClassName`
264
- - When referencing a specific method: `file-path:ClassName.methodName`
265
- - When referencing a standalone function: `file-path:functionName`
266
- - When referencing a type/interface: `file-path:InterfaceName`
267
-
268
- **Overview:**
269
- - ONE paragraph. If you need more, the system boundary is too large — split it.
270
- - State what the system DOES, not what it IS.
271
-
272
- **File Tree:**
273
- - List ALL files belonging to this system, grouped by directory.
274
- - Every file gets a `# Brief purpose` comment.
275
- - Use ASCII only: `|--` for branches, backtick-dash-dash for last item, `|` for continuation.
276
- - Paths relative to subsystem root.
277
-
278
- **System Boundary:**
279
- - The mermaid diagram must clearly separate INSIDE from OUTSIDE.
280
- - An agent reading this knows: "If my change touches something inside, I'm in scope.
281
- If it touches something outside, I need to read that system's doc too."
282
-
283
- **Class and Interface Hierarchy:**
284
- - Use mermaid `classDiagram` for inheritance and interface implementation.
285
- - Inline code snippets ONLY for interface/type contracts — never implementation code.
286
- - If the hierarchy is trivial (1 class, no inheritance), omit this section.
287
-
288
- **Entry Points:**
289
- - Every "front door" into this system. An agent needs to know WHERE flows start.
290
- - Use `file:ClassName.methodName` references.
291
-
292
- **Data Flow and Sequence Diagrams (MANDATORY — never skip):**
293
- - Every system doc MUST have at least one ```mermaid sequenceDiagram.
294
- - One sequence diagram per key behavior (1-5 behaviors typically).
295
- - Show COMPLETE E2E flow through all layers — entry to data store and back.
296
- - Participants = components, not files. Keep it at the right abstraction level.
297
- - If you cannot trace the flow, read more source files until you can. Do NOT skip.
298
-
299
- **Components:**
300
- - One subsection per major component. Location + Purpose + Key interface.
301
- - Skip trivial components (DTOs, simple value objects) unless they define important contracts.
302
-
303
- **Key Behaviors:**
304
- - Trigger -&gt; Logic -&gt; Effect format. Concise.
305
- - Reference code locations with `file:ClassName.method`.
306
-
307
- **State Management:**
308
- - Where state lives (Redux, local, database) and what causes transitions.
309
- - Omit if the system is stateless or state is trivial.
310
-
311
- **Error Propagation:**
312
- - How errors flow through layers. What gets caught where.
313
- - Omit if error handling follows a system-wide pattern documented in cross-cutting.
314
-
315
- **Constants and Enums:**
316
- - CRITICAL for AI agents — they must NEVER hardcode values.
317
- - Always list the exact file paths where constants and enums are defined.
318
-
319
- **Related Systems:**
320
- - Cross-reference with markdown links to other docs.
321
- - Agent should read these before modifying this system.
322
-
323
- **Tech Debt:**
324
- - One `###` subsection per known issue — NOT a table. Each issue needs enough context
325
- for an agent to understand the problem without reading the code.
326
- - Severity: `high` (security, data loss, production instability), `medium` (quality,
327
- maintainability), `low` (cosmetic, minor inefficiency).
328
- - Always link to the discovering story for traceability.
329
- - REMOVE items when fixed by a future story.
330
- - Omit the entire section if no tech debt exists in this system.
331
-
332
- **Section Inclusion:**
333
- - Include ALL sections that are relevant to the system.
334
- - OMIT sections that genuinely don't apply (e.g., no Database for pure frontend).
335
- - **NEVER omit Data Flow and Sequence Diagrams** — this section is always required.
336
- - When updating, ADD or expand sections — don't rewrite sections that haven't changed.
337
-
338
- **What does NOT belong here:**
339
- - Story numbers, sprint context, or agile artifacts
340
- - Planned vs Actual comparisons
341
- - Acceptance criteria checklists
342
- - Revision history (git handles this)
343
- - Duplicated implementation code (reference it, don't copy it)
344
- - Line numbers in references (they go stale)
345
- - Testing docs, coverage metrics, test code
346
- - Performance benchmarks
347
- - Debugging utilities
348
- - ASCII arrows or dependency trees (use mermaid; exception: file trees use ASCII)
349
-
350
- </guidelines>
351
-
352
- <evolution>
353
-
354
- This is a LIVING document — updated after each story that touches this system.
355
-
356
- **Update triggers:**
357
- - New component added to this system
358
- - New behavior or entry point introduced
359
- - Existing behavior changed significantly
360
- - New integration point or dependency added
361
- - Class hierarchy changed (new subclass, interface change)
362
- - State management approach changed
363
- - New constants or enums added
364
- - File tree changed (new files, removed files, moved files)
365
- - Tech debt discovered or resolved in this system's files
366
-
367
- **NOT an update trigger:**
368
- - Bug fixes that don't change system behavior
369
- - Internal refactoring within existing components
370
- - New test files
371
- - Style/formatting changes
372
-
373
- **Update rules:**
374
- - ADD new sections or expand existing ones — don't rewrite unchanged sections
375
- - UPDATE file tree to reflect current state
376
- - REMOVE references to deleted files or components
377
- - The document must always reflect the CURRENT state, not history
378
-
379
- </evolution>
380
-
381
- </system>
1
+ <system>
2
+ <purpose>
3
+ Template for `.docs/wiki/subsystems/[subsystem-name]/systems/<system-name>.md` — a coherent
4
+ domain system within a codebase subsystem. Answers "How does this system work RIGHT NOW?"
5
+
6
+ Each system doc describes WHAT exists, HOW it works, and WHERE things live for one
7
+ domain concern. It is the primary document an AI agent reads before implementing a
8
+ related story.
9
+
10
+ A "system" is a logical grouping of components that together deliver one domain capability
11
+ (e.g., Drawing System, User Management, Order Processing). A codebase subsystem may
12
+ contain multiple systems.
13
+
14
+ Complements:
15
+ - patterns/ docs (HOW to apply reusable implementation patterns)
16
+ - cross-cutting/ docs (concerns spanning multiple systems)
17
+ - guides/ docs (step-by-step recipes combining multiple patterns)
18
+ - decisions/ docs (WHY significant choices were made)
19
+ </purpose>
20
+
21
+ <template>
22
+ <overview>
23
+ # [System Name]
24
+
25
+ ## Overview
26
+ One paragraph: what this system does, why it exists.
27
+ </overview>
28
+
29
+ <file-tree>
30
+ ## File Tree
31
+
32
+ All files belonging to this system with purpose annotations.
33
+ Update when new files are added by a story.
34
+
35
+ ```
36
+ src/[layer]/[area]/
37
+ |-- FileA.ts # Brief purpose
38
+ |-- FileB.ts # Brief purpose
39
+ `-- subfolder/
40
+ |-- FileC.ts # Brief purpose
41
+ `-- FileD.ts # Brief purpose
42
+ ```
43
+ </file-tree>
44
+
45
+ <system-boundary>
46
+ ## System Boundary
47
+
48
+ Mermaid diagram showing what is INSIDE this system vs what it connects to OUTSIDE.
49
+ Helps agents understand scope — what to touch, what NOT to touch.
50
+
51
+ ```mermaid
52
+ graph TB
53
+ subgraph "System Name"
54
+ A[Component A]
55
+ B[Component B]
56
+ C[Component C]
57
+ end
58
+ External[External System]
59
+ B --&gt; External
60
+ ```
61
+ </system-boundary>
62
+
63
+ <class-and-interface-hierarchy>
64
+ ## Class and Interface Hierarchy
65
+
66
+ Inheritance chains and interface implementations.
67
+
68
+ ```mermaid
69
+ classDiagram
70
+ class IExample {
71
+ &lt;&lt;interface&gt;&gt;
72
+ }
73
+ class BaseClass {
74
+ &lt;&lt;abstract&gt;&gt;
75
+ }
76
+ IExample &lt;|.. BaseClass
77
+ BaseClass &lt;|-- ConcreteA
78
+ BaseClass &lt;|-- ConcreteB
79
+ ```
80
+
81
+ Key contracts INLINE (only interfaces/types that define the API shape):
82
+
83
+ ```typescript
84
+ export interface IExample {
85
+ // Only the contract shape — not implementation code
86
+ }
87
+ ```
88
+ </class-and-interface-hierarchy>
89
+
90
+ <entry-points>
91
+ ## Entry Points
92
+
93
+ Where flows begin. Each entry point is a "front door" into this system.
94
+ - User action: Click on chart -&gt; `file:MouseHandler.onClick`
95
+ - API endpoint: POST /api/resource -&gt; `file:ResourceController.create`
96
+ - Event handler: onTimeframeChange -&gt; `file:VisibilityManager.handleTimeframeChange`
97
+ </entry-points>
98
+
99
+ <data-flow-and-sequence-diagrams required="true">
100
+ ## Data Flow and Sequence Diagrams
101
+
102
+ **MANDATORY — every system doc MUST have at least one mermaid sequenceDiagram.**
103
+ This is the most critical section. Without E2E flow diagrams, an agent cannot
104
+ understand how data moves through the system.
105
+
106
+ How data moves through this system for each key behavior.
107
+ Use mermaid sequence diagrams showing the complete flow through all layers.
108
+
109
+ ### Flow: [Behavior Name]
110
+
111
+ ```mermaid
112
+ sequenceDiagram
113
+ participant User
114
+ participant Entry as EntryPoint
115
+ participant Svc as Service
116
+ participant Domain as DomainEntity
117
+ participant Repo as Repository
118
+ participant DB as DataStore
119
+
120
+ User-&gt;&gt;Entry: action
121
+ Entry-&gt;&gt;Svc: command/query
122
+ Svc-&gt;&gt;Domain: business logic
123
+ Domain--&gt;&gt;Svc: result
124
+ Svc-&gt;&gt;Repo: persist/retrieve
125
+ Repo-&gt;&gt;DB: SQL/query
126
+ DB--&gt;&gt;Repo: result
127
+ Repo--&gt;&gt;Svc: domain object
128
+ Svc--&gt;&gt;Entry: response
129
+ Entry--&gt;&gt;User: feedback
130
+ ```
131
+ </data-flow-and-sequence-diagrams>
132
+
133
+ <components>
134
+ ## Components
135
+
136
+ ### [Component A]
137
+ - **Location**: `src/infrastructure/primitives/trend-line/TrendLine.ts:TrendLine`
138
+ - **Purpose**: One line
139
+ - **Key interface**: `src/domain/interfaces/IDrawing.ts:IDrawing`
140
+ - **Implements**: ISeriesPrimitive, IDrawing
141
+
142
+ ### [Component B]
143
+ ...
144
+ </components>
145
+
146
+ <key-behaviors>
147
+ ## Key Behaviors
148
+
149
+ ### [Behavior 1]
150
+ - **Trigger**: What causes this behavior
151
+ - **Logic**: Where the logic lives (`file:ClassName.method`), brief description
152
+ - **Effect**: What happens as a result
153
+
154
+ ### [Behavior 2]
155
+ ...
156
+ </key-behaviors>
157
+
158
+ <state-management>
159
+ ## State Management
160
+
161
+ What state this system owns, where it lives, how it flows.
162
+ - **State location**: Redux store at `file:drawingSlice` / local state in `file:DrawingManager`
163
+ - **Key state shape**: (inline only if non-obvious)
164
+ - **State transitions**: What actions/events cause state changes
165
+ </state-management>
166
+
167
+ <error-propagation>
168
+ ## Error Propagation
169
+
170
+ What errors this system throws/handles and how they propagate through layers.
171
+ - `DrawingValidationError` at `file:Path.validate` -&gt; caught by `file:DrawingFactory` -&gt; user notification
172
+ - `RepositoryError` at `file:ResourceRepository.save` -&gt; propagates to controller -&gt; HTTP 500
173
+ </error-propagation>
174
+
175
+ <constants-and-enums>
176
+ ## Constants and Enums
177
+
178
+ Where constants and enums for this system are defined. Agent MUST use these, never hardcode.
179
+ - **Constants**: `src/domain/constants/DrawingConstants.ts:DrawingConstants`
180
+ - **Enums**: `src/domain/enums/DrawingType.ts:DrawingType`
181
+ - **Config lookup**: `src/domain/configs/DrawingConfigLookup.ts:DrawingConfigLookup`
182
+ </constants-and-enums>
183
+
184
+ <related-systems>
185
+ ## Related Systems
186
+
187
+ What other systems this one interacts with. Agent should read these docs before modifying.
188
+ - [Event System](../cross-cutting/event-system.md) — publishes/subscribes to events
189
+ - [Settings System](./settings-system.md) — configuration modal
190
+ </related-systems>
191
+
192
+ <integration-points>
193
+ ## Integration Points
194
+
195
+ - Connects to: [other system] via [mechanism] at `file:ClassName.method`
196
+ - Consumed by: [component] at `file:ClassName.method`
197
+ </integration-points>
198
+
199
+ <configuration-and-options>
200
+ ## Configuration and Options
201
+
202
+ Options interface shape and defaults. Agent needs this to implement new variants.
203
+
204
+ ```typescript
205
+ export interface ISystemOptions {
206
+ // Contract shape — what options this system accepts
207
+ }
208
+ ```
209
+
210
+ Default values: `file:SystemDefaults.ts:SYSTEM_DEFAULTS`
211
+ </configuration-and-options>
212
+
213
+ <database>
214
+ ## Database
215
+
216
+ Include ONLY if this system has database interactions. Omit entirely for pure frontend systems.
217
+
218
+ - **Table**: `table_name` — migration at `file:migrations/20240101_CreateTable.sql`
219
+ - **Key columns**: id, type, data (jsonb), created_at
220
+ - **Indexes**: `idx_table_column` on `column`
221
+ </database>
222
+
223
+ <gotchas>
224
+ ## Gotchas
225
+
226
+ Things that commonly go wrong or are easy to forget when working with this system.
227
+ - Constructor timing: factory methods called from `super()` BEFORE subclass fields initialize
228
+ - Button IDs have NO hyphens, registry types DO have hyphens
229
+ </gotchas>
230
+
231
+ <tech-debt>
232
+ ## Tech Debt
233
+
234
+ Known quality issues in this system discovered during story code reviews.
235
+ Items are added by the wiki mapper and removed when fixed by a future story.
236
+ Include ONLY if this system has known tech debt items. Omit section entirely if clean.
237
+
238
+ ### [Short descriptive title of the issue]
239
+ - **Severity:** high | medium | low
240
+ - **File:** `[file-path:SymbolName]`
241
+ - **Description:** What the issue is, why it matters, and what could go wrong
242
+ if left unfixed. Reference specific code constructs where applicable.
243
+ - **Discovered during:** [story-id] — [story title]
244
+
245
+ ### [Another issue]
246
+ - **Severity:** ...
247
+ - **File:** ...
248
+ - **Description:** ...
249
+ - **Discovered during:** ...
250
+ </tech-debt>
251
+ </template>
252
+
253
+ <guidelines>
254
+
255
+ **Documentation Style:**
256
+ - EXTREMELY SUCCINCT — every word must add value
257
+ - NO FLUFF — direct, actionable information only
258
+ - Bullet points over paragraphs
259
+ - File trees: ASCII only (`|--`, backtick-dash-dash) — never Unicode box-drawing characters
260
+ - **ALL visual representations of architecture, dependencies, flows, or relationships MUST be ```mermaid fenced code blocks. NO ASCII arrows (->), NO dependency trees, NO PlantUML. Only mermaid. The ONLY ASCII exception is file trees (directory listings).**
261
+ - Code references as `file-path:ClassName.methodName` or `file-path:functionName` (not line numbers)
262
+ - Inline snippets ONLY for interfaces, types, and short patterns that define contracts
263
+ - When referencing a whole class/module: `file-path:ClassName`
264
+ - When referencing a specific method: `file-path:ClassName.methodName`
265
+ - When referencing a standalone function: `file-path:functionName`
266
+ - When referencing a type/interface: `file-path:InterfaceName`
267
+
268
+ **Overview:**
269
+ - ONE paragraph. If you need more, the system boundary is too large — split it.
270
+ - State what the system DOES, not what it IS.
271
+
272
+ **File Tree:**
273
+ - List ALL files belonging to this system, grouped by directory.
274
+ - Every file gets a `# Brief purpose` comment.
275
+ - Use ASCII only: `|--` for branches, backtick-dash-dash for last item, `|` for continuation.
276
+ - Paths relative to subsystem root.
277
+
278
+ **System Boundary:**
279
+ - The mermaid diagram must clearly separate INSIDE from OUTSIDE.
280
+ - An agent reading this knows: "If my change touches something inside, I'm in scope.
281
+ If it touches something outside, I need to read that system's doc too."
282
+
283
+ **Class and Interface Hierarchy:**
284
+ - Use mermaid `classDiagram` for inheritance and interface implementation.
285
+ - Inline code snippets ONLY for interface/type contracts — never implementation code.
286
+ - If the hierarchy is trivial (1 class, no inheritance), omit this section.
287
+
288
+ **Entry Points:**
289
+ - Every "front door" into this system. An agent needs to know WHERE flows start.
290
+ - Use `file:ClassName.methodName` references.
291
+
292
+ **Data Flow and Sequence Diagrams (MANDATORY — never skip):**
293
+ - Every system doc MUST have at least one ```mermaid sequenceDiagram.
294
+ - One sequence diagram per key behavior (1-5 behaviors typically).
295
+ - Show COMPLETE E2E flow through all layers — entry to data store and back.
296
+ - Participants = components, not files. Keep it at the right abstraction level.
297
+ - If you cannot trace the flow, read more source files until you can. Do NOT skip.
298
+
299
+ **Components:**
300
+ - One subsection per major component. Location + Purpose + Key interface.
301
+ - Skip trivial components (DTOs, simple value objects) unless they define important contracts.
302
+
303
+ **Key Behaviors:**
304
+ - Trigger -&gt; Logic -&gt; Effect format. Concise.
305
+ - Reference code locations with `file:ClassName.method`.
306
+
307
+ **State Management:**
308
+ - Where state lives (Redux, local, database) and what causes transitions.
309
+ - Omit if the system is stateless or state is trivial.
310
+
311
+ **Error Propagation:**
312
+ - How errors flow through layers. What gets caught where.
313
+ - Omit if error handling follows a system-wide pattern documented in cross-cutting.
314
+
315
+ **Constants and Enums:**
316
+ - CRITICAL for AI agents — they must NEVER hardcode values.
317
+ - Always list the exact file paths where constants and enums are defined.
318
+
319
+ **Related Systems:**
320
+ - Cross-reference with markdown links to other docs.
321
+ - Agent should read these before modifying this system.
322
+
323
+ **Tech Debt:**
324
+ - One `###` subsection per known issue — NOT a table. Each issue needs enough context
325
+ for an agent to understand the problem without reading the code.
326
+ - Severity: `high` (security, data loss, production instability), `medium` (quality,
327
+ maintainability), `low` (cosmetic, minor inefficiency).
328
+ - Always link to the discovering story for traceability.
329
+ - REMOVE items when fixed by a future story.
330
+ - Omit the entire section if no tech debt exists in this system.
331
+
332
+ **Section Inclusion:**
333
+ - Include ALL sections that are relevant to the system.
334
+ - OMIT sections that genuinely don't apply (e.g., no Database for pure frontend).
335
+ - **NEVER omit Data Flow and Sequence Diagrams** — this section is always required.
336
+ - When updating, ADD or expand sections — don't rewrite sections that haven't changed.
337
+
338
+ **What does NOT belong here:**
339
+ - Story numbers, sprint context, or agile artifacts
340
+ - Planned vs Actual comparisons
341
+ - Acceptance criteria checklists
342
+ - Revision history (git handles this)
343
+ - Duplicated implementation code (reference it, don't copy it)
344
+ - Line numbers in references (they go stale)
345
+ - Testing docs, coverage metrics, test code
346
+ - Performance benchmarks
347
+ - Debugging utilities
348
+ - ASCII arrows or dependency trees (use mermaid; exception: file trees use ASCII)
349
+
350
+ </guidelines>
351
+
352
+ <evolution>
353
+
354
+ This is a LIVING document — updated after each story that touches this system.
355
+
356
+ **Update triggers:**
357
+ - New component added to this system
358
+ - New behavior or entry point introduced
359
+ - Existing behavior changed significantly
360
+ - New integration point or dependency added
361
+ - Class hierarchy changed (new subclass, interface change)
362
+ - State management approach changed
363
+ - New constants or enums added
364
+ - File tree changed (new files, removed files, moved files)
365
+ - Tech debt discovered or resolved in this system's files
366
+
367
+ **NOT an update trigger:**
368
+ - Bug fixes that don't change system behavior
369
+ - Internal refactoring within existing components
370
+ - New test files
371
+ - Style/formatting changes
372
+
373
+ **Update rules:**
374
+ - ADD new sections or expand existing ones — don't rewrite unchanged sections
375
+ - UPDATE file tree to reflect current state
376
+ - REMOVE references to deleted files or components
377
+ - The document must always reflect the CURRENT state, not history
378
+
379
+ </evolution>
380
+
381
+ </system>