kyro-ai 3.2.1 → 3.2.3

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 (67) hide show
  1. package/.claude-plugin/plugin.json +4 -2
  2. package/README.md +8 -11
  3. package/WORKFLOW.yaml +1 -1
  4. package/agents/orchestrator.md +3 -3
  5. package/commands/forge.md +22 -44
  6. package/commands/status.md +21 -79
  7. package/commands/wrap-up.md +18 -74
  8. package/dist/cli/adapters/codex.js +1 -1
  9. package/dist/cli/adapters/codex.js.map +1 -1
  10. package/dist/cli/adapters/command-skills.js +1 -1
  11. package/dist/cli/adapters/command-skills.js.map +1 -1
  12. package/dist/cli/app.js +1 -1
  13. package/dist/cli/app.js.map +1 -1
  14. package/dist/cli/commands/doctor.d.ts +2 -1
  15. package/dist/cli/commands/doctor.d.ts.map +1 -1
  16. package/dist/cli/commands/doctor.js +8 -4
  17. package/dist/cli/commands/doctor.js.map +1 -1
  18. package/dist/cli/commands/token-audit.d.ts +3 -0
  19. package/dist/cli/commands/token-audit.d.ts.map +1 -0
  20. package/dist/cli/commands/token-audit.js +263 -0
  21. package/dist/cli/commands/token-audit.js.map +1 -0
  22. package/dist/cli/commands/tui.js +3 -3
  23. package/dist/cli/commands/tui.js.map +1 -1
  24. package/dist/cli/help.d.ts.map +1 -1
  25. package/dist/cli/help.js +3 -0
  26. package/dist/cli/help.js.map +1 -1
  27. package/dist/cli/options.d.ts.map +1 -1
  28. package/dist/cli/options.js +5 -0
  29. package/dist/cli/options.js.map +1 -1
  30. package/dist/cli/types.d.ts +1 -0
  31. package/dist/cli/types.d.ts.map +1 -1
  32. package/docs/HOW-TO-USE-CODEX.md +28 -60
  33. package/docs/HOW-TO-USE-OPENCODE.md +26 -72
  34. package/docs/agent-adapters.md +40 -118
  35. package/docs/architecture.md +7 -2
  36. package/docs/cli.md +25 -2
  37. package/docs/commands-reference.md +22 -32
  38. package/docs/getting-started.md +65 -115
  39. package/package.json +1 -1
  40. package/skills/sprint-forge/SKILL.md +11 -10
  41. package/skills/sprint-forge/assets/README.md +38 -17
  42. package/skills/sprint-forge/assets/fixtures/subcommands-and-reports.sizingDecision.json +17 -0
  43. package/skills/sprint-forge/assets/helpers/analysis/audit.md +18 -0
  44. package/skills/sprint-forge/assets/helpers/analysis/bugfix.md +19 -0
  45. package/skills/sprint-forge/assets/helpers/analysis/feature.md +28 -0
  46. package/skills/sprint-forge/assets/helpers/analysis/new-project.md +18 -0
  47. package/skills/sprint-forge/assets/helpers/analysis/refactor.md +18 -0
  48. package/skills/sprint-forge/assets/helpers/analysis/tech-debt.md +18 -0
  49. package/skills/sprint-forge/assets/helpers/metrics.md +4 -4
  50. package/skills/sprint-forge/assets/helpers/reentry-generator.md +4 -4
  51. package/skills/sprint-forge/assets/modes/INIT.md +45 -177
  52. package/skills/sprint-forge/assets/modes/SPRINT.md +20 -246
  53. package/skills/sprint-forge/assets/modes/STATUS.md +46 -128
  54. package/skills/sprint-forge/assets/modes/close-sprint.md +29 -0
  55. package/skills/sprint-forge/assets/modes/execute-task.md +26 -0
  56. package/skills/sprint-forge/assets/modes/plan-sprint.md +29 -0
  57. package/skills/sprint-forge/assets/modes/recover.md +23 -0
  58. package/skills/sprint-forge/assets/modes/review-task.md +25 -0
  59. package/skills/sprint-forge/assets/templates/DEBT.summary.json +12 -0
  60. package/skills/sprint-forge/assets/templates/PROJECT-README.md +16 -60
  61. package/skills/sprint-forge/assets/templates/REENTRY-PROMPTS.md +18 -87
  62. package/skills/sprint-forge/assets/templates/ROADMAP.md +16 -65
  63. package/skills/sprint-forge/assets/templates/ROADMAP.summary.json +24 -0
  64. package/skills/sprint-forge/assets/templates/SPRINT.summary.json +16 -0
  65. package/skills/sprint-forge/assets/templates/index.json +24 -0
  66. package/skills/sprint-forge/assets/templates/state.json +11 -0
  67. package/skills/sprint-forge/assets/helpers/analysis-guide.md +0 -207
@@ -27,45 +27,16 @@ related:
27
27
  > Created: {date}
28
28
  > Codebase: `{codebase_path}`
29
29
 
30
- ---
31
-
32
- ## What Is This
33
-
34
- This directory contains the working artifacts for {description_of_work}. It is managed by the `kyro-ai` skill and follows an adaptive sprint workflow.
35
-
36
- ---
37
-
38
- ## For AI Agents — Mandatory Reading Order
39
-
40
- If you are an AI agent resuming work on this project, read these files in order:
41
-
42
- 1. **This README** — You are here. Understand the project structure.
43
- 2. **ROADMAP.md** — The adaptive roadmap with all planned sprints and execution rules.
44
- 3. **Last completed sprint** — The most recent sprint file in `phases/`. Read its retro, recommendations, and debt table.
45
- 4. **RE-ENTRY-PROMPTS.md** — Pre-written prompts for common actions. Copy the appropriate one.
46
-
47
- ---
48
-
49
- ## Directory Structure
30
+ This directory stores Kyro artifacts for `{scope}`. Use structured summaries first; open Markdown only when a router needs durable evidence.
50
31
 
51
- ```
52
- {output_kyro_dir}/
53
- ├── README.md ← This file
54
- ├── ROADMAP.md ← Adaptive roadmap (living document)
55
- ├── RE-ENTRY-PROMPTS.md ← Context recovery prompts
56
- ├── findings/ ← Analysis findings (one file per area)
57
- │ ├── 01-{slug}.md
58
- │ ├── 02-{slug}.md
59
- │ └── ...
60
- └── phases/ ← Sprint documents (generated one at a time)
61
- ├── SPRINT-1-{slug}.md
62
- ├── SPRINT-2-{slug}.md
63
- └── ...
64
- ```
32
+ ## Quick Resume
65
33
 
66
- ---
34
+ 1. Read `state.json`.
35
+ 2. Read `index.json`.
36
+ 3. Read `ROADMAP.summary.json`.
37
+ 4. Run `kyro-forge`, `kyro-status`, or `kyro-wrap-up`.
67
38
 
68
- ## Absolute Paths
39
+ ## Paths
69
40
 
70
41
  | Resource | Path |
71
42
  |----------|------|
@@ -74,34 +45,19 @@ If you are an AI agent resuming work on this project, read these files in order:
74
45
  | Findings | `{output_kyro_dir}/findings/` |
75
46
  | Sprints | `{output_kyro_dir}/phases/` |
76
47
  | Roadmap | `{output_kyro_dir}/ROADMAP.md` |
77
- | Re-entry Prompts | `{output_kyro_dir}/RE-ENTRY-PROMPTS.md` |
78
-
79
- ---
48
+ | Re-entry | `{output_kyro_dir}/RE-ENTRY-PROMPTS.md` |
80
49
 
81
- ## Sprint System Rules
82
-
83
- 1. Sprints are generated **one at a time** — never pre-generated
84
- 2. Each sprint feeds from the previous sprint's retro and recommendations
85
- 3. The accumulated debt table passes from sprint to sprint, never losing items
86
- 4. The roadmap adapts based on what execution reveals
87
- 5. Re-entry prompts are updated after each sprint for context persistence
88
-
89
- ---
90
-
91
- ## Current State — Baseline
92
-
93
- <!-- Filled during INIT with baseline metrics -->
50
+ ## Current State
94
51
 
95
52
  | Metric | Value |
96
53
  |--------|-------|
97
- | {metric_name} | {metric_value} |
98
-
99
- ---
54
+ | Work type | {work_type} |
55
+ | Planned sprints | {planned_sprint_count} |
56
+ | Active sprint | {active_sprint} |
57
+ | Next action | {next_action} |
100
58
 
101
59
  ## Sprint Map
102
60
 
103
- <!-- Updated as sprints are completed -->
104
-
105
- | Sprint | Status | Focus | Key Deliverables |
106
- |--------|--------|-------|-----------------|
107
- | 1 | {status} | {focus} | {deliverables} |
61
+ | Sprint | Status | Focus | Proof |
62
+ |--------|--------|-------|-------|
63
+ | 1 | {status} | {focus} | {sprint_proof} |
@@ -27,106 +27,37 @@ related:
27
27
  > Last updated: {date}
28
28
  > Current sprint: {current_sprint_number}
29
29
 
30
- These prompts help you (or a new agent) recover full project context in a new session.
30
+ Use these prompts to resume through summary-first routing. Open long Markdown only when a router asks for it.
31
31
 
32
- ---
33
-
34
- ## Output Directory
35
-
36
- ```
37
- {output_kyro_dir}
38
- ```
39
-
40
- This is where all kyro-ai documents for this project live. All file paths below are relative to this directory.
41
-
42
- ---
43
-
44
- ## Quick Reference
45
-
46
- | Sprint | File | Status |
47
- |--------|------|--------|
48
- | 1 | `phases/SPRINT-1-{slug}.md` | {status} |
49
-
50
- ---
51
-
52
- ## Dynamic Paths
32
+ ## Fast Context
53
33
 
54
34
  | Resource | Path |
55
35
  |----------|------|
56
- | Codebase | `{codebase_path}` |
57
- | Working Directory | `{output_kyro_dir}` |
58
- | Roadmap | `{output_kyro_dir}/ROADMAP.md` |
59
- | Latest Sprint | `{output_kyro_dir}/phases/{latest_sprint_file}` |
60
-
61
- ---
36
+ | State | `{output_kyro_dir}/state.json` |
37
+ | Index | `{output_kyro_dir}/index.json` |
38
+ | Roadmap Summary | `{output_kyro_dir}/ROADMAP.summary.json` |
39
+ | Sprints | `{output_kyro_dir}/phases/` |
62
40
 
63
- ## Scenario 1 — First Sprint (after INIT)
64
-
65
- Use this prompt when INIT has been completed and you need to generate Sprint 1.
41
+ ## Resume Planning
66
42
 
43
+ ```text
44
+ Continue Kyro scope `{scope}`. Read `{output_kyro_dir}/state.json`, `{output_kyro_dir}/index.json`, and `{output_kyro_dir}/ROADMAP.summary.json` first. Then use kyro-forge to plan the next sprint. Open ROADMAP.md or finding Markdown only if the router requests missing details.
67
45
  ```
68
- I'm working on the {scope} project. The analysis and roadmap have been created.
69
46
 
70
- Read these files in order:
71
- 1. {output_kyro_dir}/README.md
72
- 2. {output_kyro_dir}/ROADMAP.md
73
- 3. The finding files in {output_kyro_dir}/findings/
47
+ ## Resume Execution
74
48
 
75
- Then use /kyro:forge to generate Sprint 1. Follow the roadmap's Sprint 1 definition
76
- and the corresponding finding file(s) as input.
49
+ ```text
50
+ Continue active Kyro sprint for `{scope}`. Read state.json and index.json first, then the active SPRINT summary JSON if present. Use kyro-forge to route to execution, review, close, or recover. Open sprint Markdown only when required for the active task.
77
51
  ```
78
52
 
79
- ---
80
-
81
- ## Scenario 2 — Next Sprint (Sprint N)
82
-
83
- Use this prompt when Sprint N-1 is complete and you need to generate Sprint N.
84
-
85
- ```
86
- I'm continuing work on the {scope} project. Sprint {N-1} has been completed.
87
-
88
- Read these files in order:
89
- 1. {output_kyro_dir}/README.md
90
- 2. {output_kyro_dir}/ROADMAP.md
91
- 3. {output_kyro_dir}/phases/{last_sprint_file} (pay attention to Retro, Recommendations, and Debt table)
92
- 4. The finding file(s) for Sprint {N}: {output_kyro_dir}/findings/{next_finding_file}
93
-
94
- Then use /kyro:forge to generate Sprint {N}. Ensure all recommendations from Sprint {N-1}
95
- are addressed in the Disposition table.
96
- ```
97
-
98
- ---
99
-
100
- ## Scenario 3 — Execute Current Sprint
101
-
102
- Use this prompt when a sprint has been generated but not yet executed.
103
-
104
- ```
105
- I'm working on the {scope} project. Sprint {N} has been generated and needs execution.
106
-
107
- Read these files in order:
108
- 1. {output_kyro_dir}/README.md
109
- 2. {output_kyro_dir}/ROADMAP.md
110
- 3. {output_kyro_dir}/phases/{current_sprint_file}
111
-
112
- Then use /kyro:forge to execute Sprint {N}. Work through each phase and task,
113
- marking progress as you go. Add emergent phases if new work is discovered.
114
- ```
115
-
116
- ---
117
-
118
- ## Scenario 4 — Check Project Status
119
-
120
- Use this prompt to get a progress report.
53
+ ## Status
121
54
 
55
+ ```text
56
+ Report Kyro status for `{scope}`. Read state.json, index.json, ROADMAP.summary.json, SPRINT summaries, and DEBT.summary.json first. Use kyro-status brief unless full evidence is requested.
122
57
  ```
123
- I need a status report on the {scope} project.
124
58
 
125
- Read these files:
126
- 1. {output_kyro_dir}/README.md
127
- 2. {output_kyro_dir}/ROADMAP.md
128
- 3. All sprint files in {output_kyro_dir}/phases/
59
+ ## Closeout
129
60
 
130
- Then use /kyro:forge to generate a status report showing: completed sprints,
131
- accumulated debt, metrics, and what's planned next.
61
+ ```text
62
+ Close the Kyro session for `{scope}`. Read state.json and index.json first, then use kyro-wrap-up. Update summaries and re-entry prompts after any Markdown changes.
132
63
  ```
@@ -26,8 +26,6 @@ related:
26
26
 
27
27
  > Generated by `kyro-ai` on {date}
28
28
 
29
- ---
30
-
31
29
  ## Project Paths
32
30
 
33
31
  | Path | Value |
@@ -37,80 +35,32 @@ related:
37
35
  | Findings | `{output_kyro_dir}/findings/` |
38
36
  | Sprints | `{output_kyro_dir}/phases/` |
39
37
 
40
- ---
41
-
42
- ## Execution Rules
43
-
44
- These rules govern the entire sprint lifecycle. They are non-negotiable.
45
-
46
- 1. **Sprint-by-Sprint** — Sprints are generated ONE AT A TIME. Never pre-generate all sprints. Each sprint is informed by the results of the previous one.
47
- 2. **Retro Feeds Forward** — The retrospective and recommendations of Sprint N-1 are formal inputs for Sprint N. They cannot be ignored.
48
- 3. **Recommendations are Dispositioned** — Every recommendation from the previous sprint must either become a task or have its deferral justified in the Disposition table.
49
- 4. **Debt is Inherited** — The Accumulated Technical Debt table passes from sprint to sprint in full. Items are never deleted, only resolved.
50
- 5. **Phases are Suggested** — The roadmap defines suggested phases per sprint. During execution, emergent phases MUST be added when new work is discovered.
51
- 6. **Emergent Findings Generate Phases** — If execution reveals issues not covered by the plan, new phases are added to the current sprint.
52
- 7. **Re-entry Prompts are Updated** — After INIT and after each executed sprint, re-entry prompts are refreshed to reflect current state.
53
- 8. **Roadmap Adapts** — If execution reveals that planned sprints need modification, this roadmap is updated. The plan serves execution, not the reverse.
54
- 9. **Definition of Done** — Each sprint has explicit completion criteria. A sprint is not done until all DoD items are checked.
55
-
56
- ---
57
-
58
- ## Task States
59
-
60
- | Symbol | State | Meaning |
61
- |--------|-------|---------|
62
- | `[ ]` | Pending | Not started |
63
- | `[~]` | In Progress | Currently being worked on |
64
- | `[x]` | Done | Completed and verified |
65
- | `[!]` | Blocked | Cannot proceed — blocker documented |
66
- | `[-]` | Skipped | Intentionally skipped with justification |
67
- | `[>]` | Carry-over | Not completed — carried over to next sprint |
68
-
69
- ---
38
+ ## Sprint Sizing Decision
70
39
 
71
- ## Sprint Template
72
-
73
- Each sprint in this roadmap follows this structure:
40
+ ```json
41
+ {sizing_decision_json}
42
+ ```
74
43
 
75
- | Field | Description |
76
- |-------|-------------|
77
- | Sprint # | Sequential number |
78
- | Finding Source | Which finding file(s) this sprint addresses |
79
- | Version Target | Target version after this sprint (if applicable) |
80
- | Type | audit / refactor / feature / bugfix / debt |
81
- | Focus | One-line description of the sprint's primary goal |
82
- | Suggested Phases | Initial phases suggested by this roadmap (may expand during execution) |
83
- | Dependencies | Which sprints must complete before this one |
44
+ Acceptance:
84
45
 
85
- ---
46
+ - `recommendedSprintCount` equals the sprint rows below.
47
+ - Each sprint has exactly one `sprintProofs` entry.
48
+ - Multi-sprint plans include at least one `splitTriggers` entry.
49
+ - `whyNotFewer` and `whyNotMore` are non-empty.
86
50
 
87
51
  ## Dependency Map
88
52
 
89
- <!-- Fill during INIT: show which sprints depend on others -->
90
- <!-- Example:
91
- Sprint 1 → Sprint 2 → Sprint 3
92
- ↘ Sprint 4 → Sprint 5
93
- -->
94
-
95
- ```
53
+ ```text
96
54
  {dependency_diagram}
97
55
  ```
98
56
 
99
- ---
100
-
101
57
  ## Sprint Summary
102
58
 
103
- <!-- Fill during INIT: one row per planned sprint -->
104
-
105
- | Sprint | Finding Source | Version | Type | Focus | Dependencies | Status |
106
- |--------|--------------|---------|------|-------|-------------|--------|
107
- | 1 | `{finding_file}` | {version} | {type} | {focus} | — | pending |
108
-
109
- ---
110
-
111
- ## Detailed Sprint Definitions
59
+ | Sprint | Finding Source | Version | Type | Focus | Dependencies | Proof | Status |
60
+ |--------|----------------|---------|------|-------|--------------|-------|--------|
61
+ | 1 | `{finding_file}` | {version} | {type} | {focus} | | {sprint_proof} | pending |
112
62
 
113
- <!-- Fill during INIT: expand each sprint with suggested phases -->
63
+ ## Sprint Definitions
114
64
 
115
65
  ### Sprint 1 — {title}
116
66
 
@@ -119,8 +69,9 @@ Sprint 1 → Sprint 2 → Sprint 3
119
69
  - **Type**: {type}
120
70
  - **Focus**: {focus}
121
71
  - **Dependencies**: None
72
+ - **Proof**: {sprint_proof}
122
73
  - **Suggested Phases**:
123
74
  1. {phase_1_name} — {phase_1_description}
124
75
  2. {phase_2_name} — {phase_2_description}
125
76
 
126
- <!-- Add more sprints as needed. The number of sprints is determined by the analysis. -->
77
+ <!-- Add only justified sprints. Optimize for justified boundaries, not fewer sprints. -->
@@ -0,0 +1,24 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "scope": "{scope}",
4
+ "status": "planned",
5
+ "summary": "{roadmap_summary}",
6
+ "plannedSprintCount": 0,
7
+ "completedSprintCount": 0,
8
+ "adaptationCount": 0,
9
+ "sizingDecision": {
10
+ "recommendedSprintCount": 0,
11
+ "riskLevel": "low",
12
+ "rationale": "{sizing_rationale}",
13
+ "splitTriggers": [],
14
+ "whyNotFewer": "{why_not_fewer}",
15
+ "whyNotMore": "{why_not_more}",
16
+ "sprintProofs": []
17
+ },
18
+ "nextRecommendedAction": "plan_sprint",
19
+ "openDecisions": [],
20
+ "relevantArtifactPaths": [
21
+ ".agents/kyro/scopes/{scope}/ROADMAP.md"
22
+ ],
23
+ "lastUpdated": "{date}"
24
+ }
@@ -0,0 +1,16 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "scope": "{scope}",
4
+ "sprint": "SPRINT-{N}",
5
+ "status": "planned",
6
+ "completedTasks": 0,
7
+ "blockedTasks": 0,
8
+ "carryOverTasks": 0,
9
+ "nextRecommendedAction": "execute_task",
10
+ "nextTask": "{task_id}",
11
+ "openDecisions": [],
12
+ "filesTouched": [],
13
+ "debtDeltas": [],
14
+ "sourceMarkdown": ".agents/kyro/scopes/{scope}/phases/SPRINT-{N}-{slug}.md",
15
+ "lastUpdated": "{date}"
16
+ }
@@ -0,0 +1,24 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "scope": "{scope}",
4
+ "roadmapSummary": "{roadmap_summary}",
5
+ "activeSprintSummary": null,
6
+ "openDebtCount": 0,
7
+ "nextTask": null,
8
+ "sizingDecision": {
9
+ "recommendedSprintCount": 0,
10
+ "riskLevel": "low",
11
+ "rationale": "{sizing_rationale}",
12
+ "splitTriggers": [],
13
+ "whyNotFewer": "{why_not_fewer}",
14
+ "whyNotMore": "{why_not_more}",
15
+ "sprintProofs": []
16
+ },
17
+ "relevantArtifactPaths": {
18
+ "roadmap": ".agents/kyro/scopes/{scope}/ROADMAP.md",
19
+ "roadmapSummary": ".agents/kyro/scopes/{scope}/ROADMAP.summary.json",
20
+ "sprints": ".agents/kyro/scopes/{scope}/phases",
21
+ "reentry": ".agents/kyro/scopes/{scope}/RE-ENTRY-PROMPTS.md"
22
+ },
23
+ "lastUpdated": "{date}"
24
+ }
@@ -0,0 +1,11 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "scope": "{scope}",
4
+ "status": "planning",
5
+ "activeSprint": null,
6
+ "currentPhase": "init",
7
+ "nextAction": "plan_sprint",
8
+ "roadmapPath": ".agents/kyro/scopes/{scope}/ROADMAP.md",
9
+ "sprintsPath": ".agents/kyro/scopes/{scope}/phases",
10
+ "lastUpdated": "{date}"
11
+ }
@@ -1,207 +0,0 @@
1
- # Analysis Guide
2
-
3
- This helper guides the agent through deep analysis for different types of work. The analysis phase is the foundation of the entire sprint workflow — thoroughness here determines the quality of everything that follows.
4
-
5
- ---
6
-
7
- ## Core Principle
8
-
9
- > **The analysis dictates the structure, not the reverse.**
10
- >
11
- > Do NOT start with a fixed list of categories. Explore the project first, then let the findings define the categories. If the project has 3 problem areas, there are 3 finding files. If it has 15, there are 15.
12
-
13
- ---
14
-
15
- ## Step 1 — Detect Work Type
16
-
17
- Before analyzing, identify what kind of work this is:
18
-
19
- | Work Type | Signals | Focus |
20
- |-----------|---------|-------|
21
- | **Audit / Refactor** | "analyze", "audit", "refactor", "review" | Comprehensive codebase exploration |
22
- | **New Feature** | "add", "implement", "create feature" | Current state + gap analysis |
23
- | **Bugfix** | "fix", "broken", "error", "regression" | Root cause analysis |
24
- | **New Project** | "start from scratch", "new project", "build" | Scope definition + planning |
25
- | **Tech Debt** | "clean up", "deprecated", "missing tests" | Debt inventory + prioritization |
26
-
27
- ---
28
-
29
- ## Step 2 — Analysis by Work Type
30
-
31
- ### Audit / Refactor
32
-
33
- This is the most comprehensive analysis type. Explore the **entire** codebase systematically.
34
-
35
- **Exploration Strategy**:
36
- 1. Start with the project root: directory structure, configuration files, entry points
37
- 2. Read key architectural files: main entry, routing, state management, data layer
38
- 3. Explore each major directory/module
39
- 4. Check test coverage and quality
40
- 5. Review dependencies and their versions
41
- 6. Look for patterns and anti-patterns
42
-
43
- **What to look for** (examples — the actual areas emerge from the project):
44
- - Architecture: layer separation, dependency direction, coupling
45
- - API surface: public interfaces, consistency, documentation
46
- - Component quality: reuse, composition, prop drilling, state management
47
- - Type safety: any usage, missing types, type assertions
48
- - Error handling: consistency, coverage, user-facing messages
49
- - Testing: coverage, quality, missing tests, test patterns
50
- - Documentation: inline docs, README, API docs
51
- - Dependencies: outdated, unused, security vulnerabilities
52
- - Performance: obvious bottlenecks, unnecessary re-renders, heavy computations
53
- - Accessibility: semantic HTML, ARIA, keyboard navigation
54
-
55
- **DO NOT** use this list as a checklist. Let the project tell you what matters.
56
-
57
- ### New Feature
58
-
59
- Focus on understanding what exists and what needs to change.
60
-
61
- **Exploration Strategy**:
62
- 1. Understand the current architecture relevant to the feature
63
- 2. Identify where the feature will integrate
64
- 3. Map existing patterns the feature should follow
65
- 4. Identify gaps between current state and requirements
66
-
67
- **What to document**:
68
- - Current state of related functionality
69
- - Integration points (APIs, components, data flows)
70
- - Patterns to follow (existing conventions)
71
- - Requirements and acceptance criteria
72
- - Technical risks and unknowns
73
-
74
- ### Bugfix
75
-
76
- Focus on reproducing, understanding, and scoping the fix.
77
-
78
- **Exploration Strategy**:
79
- 1. Reproduce the bug (or understand the reproduction steps)
80
- 2. Trace the code path involved
81
- 3. Identify the root cause
82
- 4. Assess blast radius (what else could be affected)
83
-
84
- **What to document**:
85
- - Bug description and reproduction steps
86
- - Root cause analysis
87
- - Affected code paths and files
88
- - Related code that may have the same pattern (similar bugs)
89
- - Proposed fix approach
90
- - Testing strategy
91
-
92
- ### New Project
93
-
94
- Focus on defining what will be built and how.
95
-
96
- **Exploration Strategy**:
97
- 1. Understand the requirements / product idea
98
- 2. Research comparable projects or solutions
99
- 3. Define the technical stack
100
- 4. Plan the project structure
101
-
102
- **What to document**:
103
- - Project scope and boundaries
104
- - Technical stack decisions (with justification)
105
- - Proposed architecture
106
- - Key design decisions
107
- - Risks and unknowns
108
- - Initial structure / scaffolding plan
109
-
110
- ### Tech Debt
111
-
112
- Focus on inventorying and prioritizing existing debt.
113
-
114
- **Exploration Strategy**:
115
- 1. Scan the codebase for debt indicators
116
- 2. Categorize debt by type and location
117
- 3. Assess impact of each debt item
118
- 4. Prioritize by impact vs effort
119
-
120
- **What to document**:
121
- - Debt inventory (categorized)
122
- - Impact assessment per item
123
- - Dependency relationships (which debt blocks other work)
124
- - Prioritized resolution order
125
- - Quick wins vs long-term refactors
126
-
127
- ---
128
-
129
- ## Step 3 — Document Findings
130
-
131
- Each finding becomes a separate file. This is important for:
132
- - **Granularity**: Each area can be addressed independently
133
- - **Sprint mapping**: Each finding maps to one or more sprints
134
- - **Progress tracking**: As sprints complete, findings are resolved
135
-
136
- ### Finding File Format
137
-
138
- **Filename**: `NN-descriptive-slug.md` (e.g., `01-architecture-layers.md`, `02-api-inconsistencies.md`)
139
-
140
- **Content**:
141
-
142
- ```
143
- ---
144
- title: "Finding: {Title}"
145
- date: "{date}"
146
- updated: "{date}"
147
- scope: "{scope}"
148
- type: "analysis"
149
- status: "active"
150
- version: "1.0"
151
- severity: "{critical | high | medium | low}"
152
- agents:
153
- - "{agent_model}"
154
- tags:
155
- - "{scope}"
156
- - "analysis"
157
- - "finding"
158
- changelog:
159
- - version: "1.0"
160
- date: "{date}"
161
- changes: ["Finding documented"]
162
- related:
163
- - "[[ROADMAP]]"
164
- ---
165
-
166
- # Finding: {Title}
167
-
168
- ## Summary
169
-
170
- {2-3 sentence summary of the finding}
171
-
172
- ## Severity / Impact
173
-
174
- {critical | high | medium | low} — {Why this level}
175
-
176
- ## Details
177
-
178
- {Detailed description of the finding. Include specific examples from the code.}
179
-
180
- ## Affected Files
181
-
182
- - `path/to/file1.dart`
183
- - `path/to/file2.dart`
184
-
185
- ## Recommendations
186
-
187
- 1. {Specific, actionable recommendation}
188
- 2. {Another recommendation}
189
- ```
190
-
191
- ### Numbering
192
-
193
- - Use sequential numbering: `01-`, `02-`, `03-`, ...
194
- - The number determines the default sprint order (finding 01 → Sprint 1)
195
- - This is a suggestion, not a rule — the roadmap may reorder based on dependencies
196
-
197
- ---
198
-
199
- ## Step 4 — Determine Sprint Count
200
-
201
- The number of sprints emerges from the number of distinct finding areas:
202
-
203
- - **Small project / bugfix**: 1-3 findings → 1-3 sprints
204
- - **Medium refactor**: 5-8 findings → 5-8 sprints
205
- - **Major audit**: 10-20 findings → 10-20 sprints
206
-
207
- Some findings may be grouped into a single sprint if they are small and related. Some large findings may be split across multiple sprints. The roadmap makes these decisions.