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.
- package/.claude-plugin/marketplace.json +18 -0
- package/.claude-plugin/plugin.json +1 -1
- package/CHANGELOG.md +7 -1
- package/README.md +16 -12
- package/agents/ace-code-discovery-analyst.md +245 -245
- package/agents/ace-code-integration-analyst.md +248 -248
- package/agents/ace-code-reviewer.md +375 -375
- package/agents/ace-product-owner.md +365 -361
- package/agents/ace-project-researcher.md +606 -606
- package/agents/ace-technical-application-architect.md +315 -315
- package/bin/install.js +587 -173
- package/hooks/ace-check-update.js +15 -14
- package/hooks/ace-statusline.js +30 -12
- package/hooks/hooks.json +14 -0
- package/package.json +3 -2
- package/shared/lib/ace-core.js +53 -0
- package/shared/lib/ace-core.test.js +308 -308
- package/shared/lib/ace-story.test.js +250 -250
- package/skills/execute-story/SKILL.md +116 -110
- package/skills/execute-story/script.js +13 -27
- package/skills/execute-story/script.test.js +261 -261
- package/skills/execute-story/story-template.xml +451 -451
- package/skills/execute-story/workflow.xml +3 -1
- package/skills/help/SKILL.md +71 -69
- package/skills/help/script.js +32 -35
- package/skills/help/script.test.js +183 -183
- package/skills/help/workflow.xml +14 -3
- package/skills/init-coding-standards/SKILL.md +91 -72
- package/skills/init-coding-standards/coding-standards-template.xml +531 -531
- package/skills/init-coding-standards/script.js +50 -59
- package/skills/init-coding-standards/script.test.js +70 -70
- package/skills/init-coding-standards/workflow.xml +1 -1
- package/skills/map-cross-cutting/SKILL.md +126 -89
- package/skills/map-cross-cutting/workflow.xml +1 -1
- package/skills/map-guide/SKILL.md +126 -89
- package/skills/map-guide/workflow.xml +1 -1
- package/skills/map-pattern/SKILL.md +125 -89
- package/skills/map-pattern/workflow.xml +1 -1
- package/skills/map-story/SKILL.md +180 -127
- package/skills/map-story/templates/tech-debt-index.xml +125 -125
- package/skills/map-story/workflow.xml +2 -2
- package/skills/map-subsystem/SKILL.md +155 -111
- package/skills/map-subsystem/script.js +51 -60
- package/skills/map-subsystem/script.test.js +68 -68
- package/skills/map-subsystem/templates/subsystem-architecture.xml +343 -343
- package/skills/map-subsystem/templates/subsystem-structure.xml +234 -234
- package/skills/map-subsystem/workflow.xml +1173 -1173
- package/skills/map-sys-doc/SKILL.md +125 -90
- package/skills/map-sys-doc/workflow.xml +1 -1
- package/skills/map-system/SKILL.md +103 -85
- package/skills/map-system/script.js +75 -84
- package/skills/map-system/script.test.js +73 -73
- package/skills/map-system/templates/system-structure.xml +177 -177
- package/skills/map-system/templates/testing-framework.xml +283 -283
- package/skills/map-system/workflow.xml +667 -667
- package/skills/map-walkthrough/SKILL.md +140 -92
- package/skills/map-walkthrough/workflow.xml +457 -457
- package/skills/plan-backlog/SKILL.md +93 -75
- package/skills/plan-backlog/script.js +121 -136
- package/skills/plan-backlog/script.test.js +83 -83
- package/skills/plan-backlog/workflow.xml +1348 -1348
- package/skills/plan-feature/SKILL.md +99 -76
- package/skills/plan-feature/feature-template.xml +361 -361
- package/skills/plan-feature/script.js +131 -148
- package/skills/plan-feature/script.test.js +80 -80
- package/skills/plan-feature/workflow.xml +1 -1
- package/skills/plan-product-vision/SKILL.md +91 -75
- package/skills/plan-product-vision/product-vision-template.xml +227 -227
- package/skills/plan-product-vision/script.js +51 -60
- package/skills/plan-product-vision/script.test.js +69 -69
- package/skills/plan-product-vision/workflow.xml +337 -337
- package/skills/plan-story/SKILL.md +125 -102
- package/skills/plan-story/script.js +18 -49
- package/skills/plan-story/story-template.xml +8 -1
- package/skills/plan-story/workflow.xml +17 -1
- package/skills/research-external-solution/SKILL.md +120 -107
- package/skills/research-external-solution/external-solution-template.xml +832 -832
- package/skills/research-external-solution/script.js +229 -238
- package/skills/research-external-solution/script.test.js +134 -134
- package/skills/research-external-solution/workflow.xml +657 -657
- package/skills/research-integration-solution/SKILL.md +121 -98
- package/skills/research-integration-solution/integration-solution-template.xml +1015 -1015
- package/skills/research-integration-solution/script.js +223 -231
- package/skills/research-integration-solution/script.test.js +134 -134
- package/skills/research-integration-solution/workflow.xml +711 -711
- package/skills/research-story-wiki/SKILL.md +101 -92
- package/skills/research-story-wiki/script.js +223 -231
- package/skills/research-story-wiki/script.test.js +138 -138
- package/skills/research-story-wiki/story-wiki-template.xml +194 -194
- package/skills/research-story-wiki/workflow.xml +473 -473
- package/skills/research-technical-solution/SKILL.md +131 -103
- package/skills/research-technical-solution/script.js +223 -231
- package/skills/research-technical-solution/script.test.js +134 -134
- package/skills/research-technical-solution/technical-solution-template.xml +1025 -1025
- package/skills/research-technical-solution/workflow.xml +761 -761
- package/skills/review-story/SKILL.md +99 -100
- package/skills/review-story/script.js +8 -16
- package/skills/review-story/script.test.js +169 -169
- package/skills/review-story/story-template.xml +451 -451
- package/skills/review-story/workflow.xml +1 -1
- package/skills/update/SKILL.md +65 -53
- 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
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
-
|
|
76
|
-
|
|
77
|
-
-
|
|
78
|
-
|
|
79
|
-
-
|
|
80
|
-
|
|
81
|
-
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
.
|
|
97
|
-
.
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
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-subsystem — for 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
|
-
|
|
29
|
-
Each sub-agent reads the
|
|
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
|
|