agile-context-engineering 0.5.0 → 0.5.1

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 (102) hide show
  1. package/.claude-plugin/marketplace.json +18 -0
  2. package/.claude-plugin/plugin.json +1 -1
  3. package/CHANGELOG.md +7 -1
  4. package/README.md +16 -12
  5. package/agents/ace-code-discovery-analyst.md +245 -245
  6. package/agents/ace-code-integration-analyst.md +248 -248
  7. package/agents/ace-code-reviewer.md +375 -375
  8. package/agents/ace-product-owner.md +365 -361
  9. package/agents/ace-project-researcher.md +606 -606
  10. package/agents/ace-technical-application-architect.md +315 -315
  11. package/bin/install.js +587 -173
  12. package/hooks/ace-check-update.js +15 -14
  13. package/hooks/ace-statusline.js +30 -12
  14. package/hooks/hooks.json +14 -0
  15. package/package.json +3 -2
  16. package/shared/lib/ace-core.js +53 -0
  17. package/shared/lib/ace-core.test.js +308 -308
  18. package/shared/lib/ace-story.test.js +250 -250
  19. package/skills/execute-story/SKILL.md +116 -110
  20. package/skills/execute-story/script.js +13 -27
  21. package/skills/execute-story/script.test.js +261 -261
  22. package/skills/execute-story/story-template.xml +451 -451
  23. package/skills/execute-story/workflow.xml +3 -1
  24. package/skills/help/SKILL.md +71 -69
  25. package/skills/help/script.js +32 -35
  26. package/skills/help/script.test.js +183 -183
  27. package/skills/help/workflow.xml +14 -3
  28. package/skills/init-coding-standards/SKILL.md +91 -72
  29. package/skills/init-coding-standards/coding-standards-template.xml +531 -531
  30. package/skills/init-coding-standards/script.js +50 -59
  31. package/skills/init-coding-standards/script.test.js +70 -70
  32. package/skills/init-coding-standards/workflow.xml +1 -1
  33. package/skills/map-cross-cutting/SKILL.md +126 -89
  34. package/skills/map-cross-cutting/workflow.xml +1 -1
  35. package/skills/map-guide/SKILL.md +126 -89
  36. package/skills/map-guide/workflow.xml +1 -1
  37. package/skills/map-pattern/SKILL.md +125 -89
  38. package/skills/map-pattern/workflow.xml +1 -1
  39. package/skills/map-story/SKILL.md +180 -127
  40. package/skills/map-story/templates/tech-debt-index.xml +125 -125
  41. package/skills/map-story/workflow.xml +2 -2
  42. package/skills/map-subsystem/SKILL.md +155 -111
  43. package/skills/map-subsystem/script.js +51 -60
  44. package/skills/map-subsystem/script.test.js +68 -68
  45. package/skills/map-subsystem/templates/subsystem-architecture.xml +343 -343
  46. package/skills/map-subsystem/templates/subsystem-structure.xml +234 -234
  47. package/skills/map-subsystem/workflow.xml +1173 -1173
  48. package/skills/map-sys-doc/SKILL.md +125 -90
  49. package/skills/map-sys-doc/workflow.xml +1 -1
  50. package/skills/map-system/SKILL.md +103 -85
  51. package/skills/map-system/script.js +75 -84
  52. package/skills/map-system/script.test.js +73 -73
  53. package/skills/map-system/templates/system-structure.xml +177 -177
  54. package/skills/map-system/templates/testing-framework.xml +283 -283
  55. package/skills/map-system/workflow.xml +667 -667
  56. package/skills/map-walkthrough/SKILL.md +140 -92
  57. package/skills/map-walkthrough/workflow.xml +457 -457
  58. package/skills/plan-backlog/SKILL.md +93 -75
  59. package/skills/plan-backlog/script.js +121 -136
  60. package/skills/plan-backlog/script.test.js +83 -83
  61. package/skills/plan-backlog/workflow.xml +1348 -1348
  62. package/skills/plan-feature/SKILL.md +99 -76
  63. package/skills/plan-feature/feature-template.xml +361 -361
  64. package/skills/plan-feature/script.js +131 -148
  65. package/skills/plan-feature/script.test.js +80 -80
  66. package/skills/plan-feature/workflow.xml +1 -1
  67. package/skills/plan-product-vision/SKILL.md +91 -75
  68. package/skills/plan-product-vision/product-vision-template.xml +227 -227
  69. package/skills/plan-product-vision/script.js +51 -60
  70. package/skills/plan-product-vision/script.test.js +69 -69
  71. package/skills/plan-product-vision/workflow.xml +337 -337
  72. package/skills/plan-story/SKILL.md +125 -102
  73. package/skills/plan-story/script.js +18 -49
  74. package/skills/plan-story/story-template.xml +8 -1
  75. package/skills/plan-story/workflow.xml +17 -1
  76. package/skills/research-external-solution/SKILL.md +120 -107
  77. package/skills/research-external-solution/external-solution-template.xml +832 -832
  78. package/skills/research-external-solution/script.js +229 -238
  79. package/skills/research-external-solution/script.test.js +134 -134
  80. package/skills/research-external-solution/workflow.xml +657 -657
  81. package/skills/research-integration-solution/SKILL.md +121 -98
  82. package/skills/research-integration-solution/integration-solution-template.xml +1015 -1015
  83. package/skills/research-integration-solution/script.js +223 -231
  84. package/skills/research-integration-solution/script.test.js +134 -134
  85. package/skills/research-integration-solution/workflow.xml +711 -711
  86. package/skills/research-story-wiki/SKILL.md +101 -92
  87. package/skills/research-story-wiki/script.js +223 -231
  88. package/skills/research-story-wiki/script.test.js +138 -138
  89. package/skills/research-story-wiki/story-wiki-template.xml +194 -194
  90. package/skills/research-story-wiki/workflow.xml +473 -473
  91. package/skills/research-technical-solution/SKILL.md +131 -103
  92. package/skills/research-technical-solution/script.js +223 -231
  93. package/skills/research-technical-solution/script.test.js +134 -134
  94. package/skills/research-technical-solution/technical-solution-template.xml +1025 -1025
  95. package/skills/research-technical-solution/workflow.xml +761 -761
  96. package/skills/review-story/SKILL.md +99 -100
  97. package/skills/review-story/script.js +8 -16
  98. package/skills/review-story/script.test.js +169 -169
  99. package/skills/review-story/story-template.xml +451 -451
  100. package/skills/review-story/workflow.xml +1 -1
  101. package/skills/update/SKILL.md +65 -53
  102. package/skills/update/workflow.xml +21 -5
@@ -1,127 +1,180 @@
1
- ---
2
- name: map-story
3
- description: Update living knowledge docs — either after a story implementation (git-based, with new subsystem detection) or for existing undocumented code (file-based, called by map-subsystem)
4
- argument-hint: "story-context='.ace/artifacts/...' commits=3 | files='a.ts,b.ts' module-name='User Management' subsystem-name='api'"
5
- disable-model-invocation: true
6
- allowed-tools:
7
- - Read
8
- - Bash
9
- - Glob
10
- - Grep
11
- - Write
12
- - Edit
13
- - Task
14
- - AskUserQuestion
15
- - Agent
16
- model: opus
17
- effort: max
18
- ---
19
-
20
- # Map Story
21
-
22
- Update living knowledge docs after story implementation or for existing undocumented code.
23
-
24
- ## When to Use
25
-
26
- ### Story Mode (invoked by user)
27
- - After a story is implemented and tested
28
- - Analyzes git changes (diff) to determine what was built
29
- - Reads story artifacts for intent context
30
- - Detects affected subsystem(s) from changed file paths
31
- - Creates or updates living knowledge docs to reflect the CURRENT system state
32
- - Detects NEW subsystems not yet in system-structure.md and offers full mapping via map-subsystem
33
-
34
- ### File Mode (invoked by map-subsystem Step 8.7)
35
- - Called automatically during subsystem mapping
36
- - Receives a curated file list + module metadata from module-discovery
37
- - Documents existing undocumented code — no git diff needed
38
- - Receives pre-curated existing documentation as additional context
39
-
40
- ## Input
41
-
42
- ### Mode Detection
43
-
44
- - If `files` is provided → file mode
45
- - If `story-context` is provided → story mode
46
- - If neither is provided → story mode (staged + unstaged changes)
47
-
48
- ### Story Mode Parameters
49
-
50
- **Optional:**
51
-
52
- - **`story-context`** (path) Path to story artifacts folder (in `.ace/artifacts/` or legacy `documentation/features/`). Used to understand WHAT the story intended to build. If not provided, the agent relies solely on git changes.
53
- - **`commits`** (number | comma-separated commit SHAs) — Specifies which commits to analyze. As a number: analyze the N most recent commits (e.g., commits=3). As commit SHAs: analyze specific commits (e.g., commits='abc123,def456'). When not provided: analyze staged + unstaged changes (git diff + git diff --cached).
54
- - **`tech-debt`** (text | path) — Tech debt items discovered during code review. Can be plain text, YAML, or a path to a file containing the items. When provided, the wiki mapper integrates these items into the relevant subsystem wiki docs (## Tech Debt sections) AND updates the system-wide tech-debt-index.md.
55
-
56
- ### File Mode Parameters
57
-
58
- **Required:**
59
-
60
- - **`files`** (comma-separated paths) — Source code files to document. These are the files discovered by module-discovery (Step 8.5) that together form one coherent module.
61
- - **`module-name`** (text) Human-readable name of the module (e.g., "User Management", "Repository Pattern").
62
- - **`subsystem-name`** (text) Name of the subsystem this module belongs to.
63
-
64
- **Optional:**
65
-
66
- - **`existing-docs`** (comma-separated paths or directories) Pre-existing documentation relevant to this module. Accepts file paths, directory paths, or a mix of both. When a directory is provided, recursively discover all files within it. Read these FIRST for additional context about intent, decisions, and history. The actual source code remains the source of truth; existing docs provide the WHY.
67
-
68
- ## Supporting Resources
69
-
70
- Read ALL of these before starting the workflow:
71
-
72
- - **Workflow**: Read [workflow.xml](workflow.xml) — complete orchestration process with all steps
73
- - **System template**: Read [templates/system.xml](templates/system.xml) — system document format
74
- - **Cross-cutting template**: Read [templates/system-cross-cutting.xml](templates/system-cross-cutting.xml) — cross-cutting concern format
75
- - **Pattern template**: Read [templates/pattern.xml](templates/pattern.xml) — pattern document format
76
- - **Guide template**: Read [templates/guide.xml](templates/guide.xml) guide document format
77
- - **Walkthrough template**: Read [templates/walkthrough.xml](templates/walkthrough.xml) — walkthrough format
78
- - **Decisions template**: Read [templates/decizions.xml](templates/decizions.xml) decisions document format
79
- - **Tech debt index template**: Read [templates/tech-debt-index.xml](templates/tech-debt-index.xml) — tech debt index format
80
- - **Questioning guide**: Read `${CLAUDE_SKILL_DIR}/../../shared/utils/questioning.xml` — deep questioning techniques
81
- - **UI formatting**: Read `${CLAUDE_SKILL_DIR}/../../shared/utils/ui-formatting.md` — ACE output formatting rules
82
-
83
- ## Process
84
-
85
- Read all supporting resources listed above, then execute the workflow defined in [workflow.xml](workflow.xml) end-to-end. Preserve all workflow gates (validation, user questions, commits).
86
-
87
- **Objective:** Read the provided source code files (and any existing docs for context), then autonomously create or update living knowledge documents. One call may produce multiple docs across different categories (systems/, patterns/, cross-cutting/, guides/, walkthroughs/, decisions/).
88
-
89
- In story mode: analyze git changes to determine what was built, detect affected subsystem(s), identify NEW subsystems not yet in system-structure.md (offering full map-subsystem mapping with user approval), and update/create docs to reflect the CURRENT system state. Also suggests potential walkthroughs for complex flows discovered in the code — the user can choose to create them.
90
-
91
- In file mode: document existing undocumented code from the provided file list.
92
-
93
- ## Artifacts
94
-
95
- ```
96
- .docs/wiki/subsystems/[subsystem-name]/systems/[system-name].md
97
- .docs/wiki/subsystems/[subsystem-name]/patterns/[pattern-name].md
98
- .docs/wiki/subsystems/[subsystem-name]/cross-cutting/[concern-name].md
99
- .docs/wiki/subsystems/[subsystem-name]/guides/[guide-name].md
100
- .docs/wiki/subsystems/[subsystem-name]/walkthroughs/[flow-name].md (if user approves suggestions)
101
- .docs/wiki/subsystems/[subsystem-name]/decisions/[decision-name].md
102
- .docs/wiki/system-wide/system-structure.md (updated if new subsystem mapped)
103
- .docs/wiki/system-wide/system-architecture.md (updated if new subsystem mapped)
104
- ```
105
-
106
- ## Example Usage
107
-
108
- ```
109
- # After a story implementation (staged + unstaged changes)
110
- /ace:map-story
111
-
112
- # After a story with specific commits
113
- /ace:map-story story-context='.ace/artifacts/product/e1-auth/f2-login/s1-form/s1-form.md' commits=3
114
-
115
- # For existing undocumented code (called by map-subsystem)
116
- /ace:map-story files='a.ts,b.ts' module-name='User Management' subsystem-name='api'
117
-
118
- # With tech debt items from code review
119
- /ace:map-story story-context='.ace/artifacts/...' tech-debt='Missing error handling in auth flow'
120
- ```
121
-
122
- ## Next Steps
123
-
124
- - `/clear` first for a fresh context window
125
- - `/ace:map-story` document another story or module
126
- - `/ace:map-subsystem [subsystem]` map or refresh an entire subsystem
127
- - Review and edit files in `.docs/wiki/subsystems/[subsystem-name]/`
1
+ ---
2
+ name: map-story
3
+ description: Update living knowledge docs — either after a story implementation (git-based, with new subsystem detection) or for existing undocumented code (file-based, called by map-subsystem)
4
+ argument-hint: "story-context='.ace/artifacts/...' commits=3 | files='a.ts,b.ts' module-name='User Management' subsystem-name='api'"
5
+ disable-model-invocation: true
6
+ allowed-tools:
7
+ - Read
8
+ - Bash
9
+ - Glob
10
+ - Grep
11
+ - Write
12
+ - Edit
13
+ - Task
14
+ - AskUserQuestion
15
+ - Agent
16
+ model: opus
17
+ effort: max
18
+ ---
19
+
20
+ ## Supporting Resources (auto-loaded)
21
+
22
+ !`cat "${CLAUDE_SKILL_DIR}/workflow.xml"`
23
+
24
+ !`cat "${CLAUDE_SKILL_DIR}/templates/system.xml"`
25
+
26
+ !`cat "${CLAUDE_SKILL_DIR}/templates/system-cross-cutting.xml"`
27
+
28
+ !`cat "${CLAUDE_SKILL_DIR}/templates/pattern.xml"`
29
+
30
+ !`cat "${CLAUDE_SKILL_DIR}/templates/guide.xml"`
31
+
32
+ !`cat "${CLAUDE_SKILL_DIR}/templates/walkthrough.xml"`
33
+
34
+ !`cat "${CLAUDE_SKILL_DIR}/templates/decizions.xml"`
35
+
36
+ !`cat "${CLAUDE_SKILL_DIR}/templates/tech-debt-index.xml"`
37
+
38
+ !`cat "${CLAUDE_SKILL_DIR}/../../shared/utils/questioning.xml"`
39
+
40
+ !`cat "${CLAUDE_SKILL_DIR}/../../shared/utils/ui-formatting.md"`
41
+
42
+ ```xml
43
+ <command>
44
+
45
+ <execution-time>
46
+ <mode name="story" invoked-by="user">
47
+ <trigger>After a story is implemented and tested</trigger>
48
+ <trigger>Analyzes git changes (diff) to determine what was built</trigger>
49
+ <trigger>Reads story artifacts for intent context</trigger>
50
+ <trigger>Detects affected subsystem(s) from changed file paths</trigger>
51
+ <trigger>Creates or updates living knowledge docs to reflect the CURRENT system state</trigger>
52
+ <trigger>Detects NEW subsystems not yet in system-structure.md and offers full mapping via map-subsystem</trigger>
53
+ </mode>
54
+ <mode name="file" invoked-by="map-subsystem Step 8.7">
55
+ <trigger>Called automatically during subsystem mapping</trigger>
56
+ <trigger>Receives a curated file list + module metadata from module-discovery</trigger>
57
+ <trigger>Documents existing undocumented code — no git diff needed</trigger>
58
+ <trigger>Receives pre-curated existing documentation as additional context</trigger>
59
+ </mode>
60
+ <use-when mode="story">
61
+ <condition>You just finished implementing and testing a story</condition>
62
+ <condition>You want to update docs to reflect recent code changes</condition>
63
+ <condition>You want to capture decisions and patterns from a recent implementation</condition>
64
+ </use-when>
65
+ <use-when mode="file">
66
+ <condition>/ace:map-subsystemfor each module row in module-discovery.md</condition>
67
+ </use-when>
68
+ </execution-time>
69
+
70
+ <input>
71
+ <flags>
72
+ </flags>
73
+
74
+ <parameters>
75
+ <mode-detection>
76
+ <rule>If `files` is provided -> file mode</rule>
77
+ <rule>If `story-context` is provided -> story mode</rule>
78
+ <rule>If neither is provided -> story mode (staged + unstaged changes)</rule>
79
+ </mode-detection>
80
+
81
+ <story-mode>
82
+ <required></required>
83
+ <optional>
84
+ <param name="story-context" type="path">
85
+ Path to story artifacts folder (in `.ace/artifacts/` or legacy `documentation/features/`).
86
+ Used to understand WHAT the story intended to build.
87
+ If not provided, the agent relies solely on git changes.
88
+ </param>
89
+ <param name="commits" type="number | comma-separated commit SHAs">
90
+ Specifies which commits to analyze.
91
+ As a number: analyze the N most recent commits (e.g., commits=3).
92
+ As commit SHAs: analyze specific commits (e.g., commits='abc123,def456').
93
+ When not provided: analyze staged + unstaged changes (git diff + git diff --cached).
94
+ </param>
95
+ <param name="tech-debt" type="text | path">
96
+ Tech debt items discovered during code review.
97
+ Can be plain text, YAML, or a path to a file containing the items.
98
+ When provided, the wiki mapper integrates these items into the
99
+ relevant subsystem wiki docs (## Tech Debt sections) AND updates
100
+ the system-wide tech-debt-index.md.
101
+ </param>
102
+ </optional>
103
+ </story-mode>
104
+
105
+ <file-mode>
106
+ <required>
107
+ <param name="files" type="comma-separated paths">
108
+ Source code files to document. These are the files discovered by
109
+ module-discovery (Step 8.5) that together form one coherent module.
110
+ </param>
111
+ <param name="module-name" type="text">
112
+ Human-readable name of the module (e.g., "User Management", "Repository Pattern").
113
+ </param>
114
+ <param name="subsystem-name" type="text">
115
+ Name of the subsystem this module belongs to.
116
+ </param>
117
+ </required>
118
+ <optional>
119
+ <param name="existing-docs" type="comma-separated paths or directories">
120
+ Pre-existing documentation relevant to this module. Accepts file paths,
121
+ directory paths, or a mix of both. When a directory is provided,
122
+ recursively discover all files within it (including nested subdirectories).
123
+ Typically curated by module-discovery's synthesis agent or passed through
124
+ from map-subsystem. Read these FIRST for additional context about intent,
125
+ decisions, and history. The actual source code remains the source of truth;
126
+ existing docs provide the WHY.
127
+ </param>
128
+ </optional>
129
+ </file-mode>
130
+ </parameters>
131
+ </input>
132
+
133
+ <execution-context>
134
+ <!-- All supporting files are auto-loaded in the Supporting Resources section above.
135
+ The model does NOT need to Read these files — they are already in context. -->
136
+ </execution-context>
137
+
138
+ <output>
139
+ <objective>
140
+ Read the provided source code files (and any existing docs for context),
141
+ then autonomously create or update living knowledge documents.
142
+ One call may produce multiple docs across different categories
143
+ (systems/, patterns/, cross-cutting/, guides/, walkthroughs/, decisions/).
144
+
145
+ In story mode: analyze git changes to determine what was built, detect
146
+ affected subsystem(s), identify NEW subsystems not yet in system-structure.md
147
+ (offering full map-subsystem mapping with user approval), and update/create
148
+ docs to reflect the CURRENT system state. Also suggests potential walkthroughs
149
+ for complex flows discovered in the code — the user can choose to create them.
150
+
151
+ In file mode: document existing undocumented code from the provided file list.
152
+ </objective>
153
+
154
+ <artifacts>
155
+ .docs/wiki/subsystems/[subsystem-name]/systems/[system-name].md
156
+ .docs/wiki/subsystems/[subsystem-name]/patterns/[pattern-name].md
157
+ .docs/wiki/subsystems/[subsystem-name]/cross-cutting/[concern-name].md
158
+ .docs/wiki/subsystems/[subsystem-name]/guides/[guide-name].md
159
+ .docs/wiki/subsystems/[subsystem-name]/walkthroughs/[flow-name].md (if user approves suggestions)
160
+ .docs/wiki/subsystems/[subsystem-name]/decisions/[decision-name].md
161
+ .docs/wiki/system-wide/system-structure.md (updated if new subsystem mapped)
162
+ .docs/wiki/system-wide/system-architecture.md (updated if new subsystem mapped)
163
+ </artifacts>
164
+ </output>
165
+
166
+ <process>
167
+ Execute the map-story workflow from
168
+ `workflow.xml` end-to-end.
169
+ Preserve all workflow gates (validation, user questions, commits).
170
+ </process>
171
+
172
+ <next-steps>
173
+ <step>/clear first for a fresh context window</step>
174
+ <step>/ace:map-story — document another story or module</step>
175
+ <step>/ace:map-subsystem [subsystem] — map or refresh an entire subsystem</step>
176
+ <step>Review and edit files in .docs/wiki/subsystems/[subsystem-name]/</step>
177
+ </next-steps>
178
+
179
+ </command>
180
+ ```
@@ -1,125 +1,125 @@
1
- <tech-debt-index>
2
- <purpose>
3
- Template for `.docs/wiki/system-wide/tech-debt-index.md` — a cross-cutting index of all
4
- known tech debt across the entire codebase. Answers "What quality issues exist, where,
5
- and how severe are they?"
6
-
7
- This is a roll-up document maintained by the wiki mapper after each story execution.
8
- The ace-code-reviewer discovers tech debt during review; the wiki mapper records it here
9
- AND in the relevant subsystem/system wiki docs.
10
-
11
- Complements:
12
- - Subsystem wiki docs (each has its own ## Tech Debt section with local items)
13
- - coding-standards.md (defines what IS a violation; this doc tracks EXISTING violations)
14
- </purpose>
15
-
16
- <template>
17
- <header>
18
- # Tech Debt Index
19
-
20
- **Last updated**: [YYYY-MM-DD]
21
- **Total items**: [N] ([high] high, [medium] medium, [low] low)
22
- </header>
23
-
24
- <summary-table>
25
- ## Summary by Subsystem
26
-
27
- | Subsystem | High | Medium | Low | Total | Wiki Doc |
28
- |-----------|------|--------|-----|-------|----------|
29
- | [name] | [n] | [n] | [n] | [n] | [link to wiki doc] |
30
- | **Total** | [n] | [n] | [n] | [n] | |
31
- </summary-table>
32
-
33
- <by-subsystem>
34
- ## By Subsystem
35
-
36
- ### [subsystem-name] ([N] items)
37
- **Wiki doc**: `.docs/wiki/subsystems/[name]/[relevant-doc].md`
38
-
39
- | # | Severity | Description | File | Discovered |
40
- |---|----------|-------------|------|------------|
41
- | 1 | high | [description] | `[file-path]` | [story-id] |
42
- | 2 | medium | [description] | `[file-path]` | [story-id] |
43
-
44
- ### [subsystem-name] ([N] items)
45
- ...
46
- </by-subsystem>
47
-
48
- <by-severity>
49
- ## By Severity
50
-
51
- ### High ([N] items)
52
- Items that pose security risk, data loss risk, or production instability.
53
-
54
- | # | Subsystem | Description | File | Discovered |
55
- |---|-----------|-------------|------|------------|
56
- | 1 | [name] | [description] | `[file-path]` | [story-id] |
57
-
58
- ### Medium ([N] items)
59
- Quality issues, maintainability concerns, missing safeguards.
60
-
61
- | # | Subsystem | Description | File | Discovered |
62
- |---|-----------|-------------|------|------------|
63
- | 1 | [name] | [description] | `[file-path]` | [story-id] |
64
-
65
- ### Low ([N] items)
66
- Cosmetic issues, minor inefficiencies, style inconsistencies.
67
-
68
- | # | Subsystem | Description | File | Discovered |
69
- |---|-----------|-------------|------|------------|
70
- | 1 | [name] | [description] | `[file-path]` | [story-id] |
71
- </by-severity>
72
- </template>
73
-
74
- <guidelines>
75
-
76
- **Header:**
77
- - Last updated date changes on every update
78
- - Summary counts must be accurate — recalculate on every update
79
-
80
- **Summary Table:**
81
- - One row per subsystem that has tech debt
82
- - Wiki doc link points to the subsystem wiki doc containing the local ## Tech Debt section
83
- - Totals row at the bottom
84
-
85
- **By Subsystem:**
86
- - Grouped by subsystem, sorted alphabetically
87
- - Within each subsystem, sorted by severity (high → medium → low)
88
- - Each item has: severity, short description, file path, discovering story ID
89
- - File paths are relative to project root
90
-
91
- **By Severity:**
92
- - Same items as By Subsystem, but grouped by severity level
93
- - Provides a quick view of highest-priority debt across the codebase
94
-
95
- **Severity Definitions:**
96
- - `high` — security risk, data loss risk, production instability
97
- - `medium` — quality issue, maintainability concern, missing safeguards
98
- - `low` — cosmetic, minor inefficiency, style inconsistency
99
-
100
- **What does NOT belong here:**
101
- - Tech debt that has been fixed (remove it when fixed by a future story)
102
- - Planned work or feature requests (those are stories/features in the backlog)
103
- - Code that violates standards but was just written (that's a blocker, not tech debt)
104
-
105
- </guidelines>
106
-
107
- <evolution>
108
-
109
- This is a LIVING document — updated by the wiki mapper after each story execution.
110
-
111
- **Update triggers:**
112
- - ace-code-reviewer discovers new tech debt during story review
113
- - A story implementation fixes existing tech debt (remove the item)
114
-
115
- **Update rules:**
116
- - ADD new items discovered during code review
117
- - REMOVE items that were fixed by a story
118
- - RECALCULATE summary counts on every update
119
- - PRESERVE item ordering: by subsystem alphabetically, then by severity
120
- - Each item always linked to the discovering story for traceability
121
- - When a subsystem has zero remaining items, remove its section
122
-
123
- </evolution>
124
-
125
- </tech-debt-index>
1
+ <tech-debt-index>
2
+ <purpose>
3
+ Template for `.docs/wiki/system-wide/tech-debt-index.md` — a cross-cutting index of all
4
+ known tech debt across the entire codebase. Answers "What quality issues exist, where,
5
+ and how severe are they?"
6
+
7
+ This is a roll-up document maintained by the wiki mapper after each story execution.
8
+ The ace-code-reviewer discovers tech debt during review; the wiki mapper records it here
9
+ AND in the relevant subsystem/system wiki docs.
10
+
11
+ Complements:
12
+ - Subsystem wiki docs (each has its own ## Tech Debt section with local items)
13
+ - coding-standards.md (defines what IS a violation; this doc tracks EXISTING violations)
14
+ </purpose>
15
+
16
+ <template>
17
+ <header>
18
+ # Tech Debt Index
19
+
20
+ **Last updated**: [YYYY-MM-DD]
21
+ **Total items**: [N] ([high] high, [medium] medium, [low] low)
22
+ </header>
23
+
24
+ <summary-table>
25
+ ## Summary by Subsystem
26
+
27
+ | Subsystem | High | Medium | Low | Total | Wiki Doc |
28
+ |-----------|------|--------|-----|-------|----------|
29
+ | [name] | [n] | [n] | [n] | [n] | [link to wiki doc] |
30
+ | **Total** | [n] | [n] | [n] | [n] | |
31
+ </summary-table>
32
+
33
+ <by-subsystem>
34
+ ## By Subsystem
35
+
36
+ ### [subsystem-name] ([N] items)
37
+ **Wiki doc**: `.docs/wiki/subsystems/[name]/[relevant-doc].md`
38
+
39
+ | # | Severity | Description | File | Discovered |
40
+ |---|----------|-------------|------|------------|
41
+ | 1 | high | [description] | `[file-path]` | [story-id] |
42
+ | 2 | medium | [description] | `[file-path]` | [story-id] |
43
+
44
+ ### [subsystem-name] ([N] items)
45
+ ...
46
+ </by-subsystem>
47
+
48
+ <by-severity>
49
+ ## By Severity
50
+
51
+ ### High ([N] items)
52
+ Items that pose security risk, data loss risk, or production instability.
53
+
54
+ | # | Subsystem | Description | File | Discovered |
55
+ |---|-----------|-------------|------|------------|
56
+ | 1 | [name] | [description] | `[file-path]` | [story-id] |
57
+
58
+ ### Medium ([N] items)
59
+ Quality issues, maintainability concerns, missing safeguards.
60
+
61
+ | # | Subsystem | Description | File | Discovered |
62
+ |---|-----------|-------------|------|------------|
63
+ | 1 | [name] | [description] | `[file-path]` | [story-id] |
64
+
65
+ ### Low ([N] items)
66
+ Cosmetic issues, minor inefficiencies, style inconsistencies.
67
+
68
+ | # | Subsystem | Description | File | Discovered |
69
+ |---|-----------|-------------|------|------------|
70
+ | 1 | [name] | [description] | `[file-path]` | [story-id] |
71
+ </by-severity>
72
+ </template>
73
+
74
+ <guidelines>
75
+
76
+ **Header:**
77
+ - Last updated date changes on every update
78
+ - Summary counts must be accurate — recalculate on every update
79
+
80
+ **Summary Table:**
81
+ - One row per subsystem that has tech debt
82
+ - Wiki doc link points to the subsystem wiki doc containing the local ## Tech Debt section
83
+ - Totals row at the bottom
84
+
85
+ **By Subsystem:**
86
+ - Grouped by subsystem, sorted alphabetically
87
+ - Within each subsystem, sorted by severity (high → medium → low)
88
+ - Each item has: severity, short description, file path, discovering story ID
89
+ - File paths are relative to project root
90
+
91
+ **By Severity:**
92
+ - Same items as By Subsystem, but grouped by severity level
93
+ - Provides a quick view of highest-priority debt across the codebase
94
+
95
+ **Severity Definitions:**
96
+ - `high` — security risk, data loss risk, production instability
97
+ - `medium` — quality issue, maintainability concern, missing safeguards
98
+ - `low` — cosmetic, minor inefficiency, style inconsistency
99
+
100
+ **What does NOT belong here:**
101
+ - Tech debt that has been fixed (remove it when fixed by a future story)
102
+ - Planned work or feature requests (those are stories/features in the backlog)
103
+ - Code that violates standards but was just written (that's a blocker, not tech debt)
104
+
105
+ </guidelines>
106
+
107
+ <evolution>
108
+
109
+ This is a LIVING document — updated by the wiki mapper after each story execution.
110
+
111
+ **Update triggers:**
112
+ - ace-code-reviewer discovers new tech debt during story review
113
+ - A story implementation fixes existing tech debt (remove the item)
114
+
115
+ **Update rules:**
116
+ - ADD new items discovered during code review
117
+ - REMOVE items that were fixed by a story
118
+ - RECALCULATE summary counts on every update
119
+ - PRESERVE item ordering: by subsystem alphabetically, then by severity
120
+ - Each item always linked to the discovering story for traceability
121
+ - When a subsystem has zero remaining items, remove its section
122
+
123
+ </evolution>
124
+
125
+ </tech-debt-index>
@@ -25,8 +25,8 @@
25
25
  </purpose>
26
26
 
27
27
  <mandatory-context>
28
- The orchestrator reads ONLY this workflow it stays lightweight.
29
- Each sub-agent reads the five document templates itself before writing.
28
+ All supporting resource files are auto-loaded in the skill prompt above. Do NOT re-read them.
29
+ Each sub-agent reads the document templates itself before writing.
30
30
  Also read any parameters passed as $ARGUMENTS in the invoking command.
31
31
  </mandatory-context>
32
32