get-research-done 1.1.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.
- package/LICENSE +21 -0
- package/README.md +560 -0
- package/agents/grd-architect.md +789 -0
- package/agents/grd-codebase-mapper.md +738 -0
- package/agents/grd-critic.md +1065 -0
- package/agents/grd-debugger.md +1203 -0
- package/agents/grd-evaluator.md +948 -0
- package/agents/grd-executor.md +784 -0
- package/agents/grd-explorer.md +2063 -0
- package/agents/grd-graduator.md +484 -0
- package/agents/grd-integration-checker.md +423 -0
- package/agents/grd-phase-researcher.md +641 -0
- package/agents/grd-plan-checker.md +745 -0
- package/agents/grd-planner.md +1386 -0
- package/agents/grd-project-researcher.md +865 -0
- package/agents/grd-research-synthesizer.md +256 -0
- package/agents/grd-researcher.md +2361 -0
- package/agents/grd-roadmapper.md +605 -0
- package/agents/grd-verifier.md +778 -0
- package/bin/install.js +1294 -0
- package/commands/grd/add-phase.md +207 -0
- package/commands/grd/add-todo.md +193 -0
- package/commands/grd/architect.md +283 -0
- package/commands/grd/audit-milestone.md +277 -0
- package/commands/grd/check-todos.md +228 -0
- package/commands/grd/complete-milestone.md +136 -0
- package/commands/grd/debug.md +169 -0
- package/commands/grd/discuss-phase.md +86 -0
- package/commands/grd/evaluate.md +1095 -0
- package/commands/grd/execute-phase.md +339 -0
- package/commands/grd/explore.md +258 -0
- package/commands/grd/graduate.md +323 -0
- package/commands/grd/help.md +482 -0
- package/commands/grd/insert-phase.md +227 -0
- package/commands/grd/insights.md +231 -0
- package/commands/grd/join-discord.md +18 -0
- package/commands/grd/list-phase-assumptions.md +50 -0
- package/commands/grd/map-codebase.md +71 -0
- package/commands/grd/new-milestone.md +721 -0
- package/commands/grd/new-project.md +1008 -0
- package/commands/grd/pause-work.md +134 -0
- package/commands/grd/plan-milestone-gaps.md +295 -0
- package/commands/grd/plan-phase.md +525 -0
- package/commands/grd/progress.md +364 -0
- package/commands/grd/quick-explore.md +236 -0
- package/commands/grd/quick.md +309 -0
- package/commands/grd/remove-phase.md +349 -0
- package/commands/grd/research-phase.md +200 -0
- package/commands/grd/research.md +681 -0
- package/commands/grd/resume-work.md +40 -0
- package/commands/grd/set-profile.md +106 -0
- package/commands/grd/settings.md +136 -0
- package/commands/grd/update.md +172 -0
- package/commands/grd/verify-work.md +219 -0
- package/get-research-done/config/default.json +15 -0
- package/get-research-done/references/checkpoints.md +1078 -0
- package/get-research-done/references/continuation-format.md +249 -0
- package/get-research-done/references/git-integration.md +254 -0
- package/get-research-done/references/model-profiles.md +73 -0
- package/get-research-done/references/planning-config.md +94 -0
- package/get-research-done/references/questioning.md +141 -0
- package/get-research-done/references/tdd.md +263 -0
- package/get-research-done/references/ui-brand.md +160 -0
- package/get-research-done/references/verification-patterns.md +612 -0
- package/get-research-done/templates/DEBUG.md +159 -0
- package/get-research-done/templates/UAT.md +247 -0
- package/get-research-done/templates/archive-reason.md +195 -0
- package/get-research-done/templates/codebase/architecture.md +255 -0
- package/get-research-done/templates/codebase/concerns.md +310 -0
- package/get-research-done/templates/codebase/conventions.md +307 -0
- package/get-research-done/templates/codebase/integrations.md +280 -0
- package/get-research-done/templates/codebase/stack.md +186 -0
- package/get-research-done/templates/codebase/structure.md +285 -0
- package/get-research-done/templates/codebase/testing.md +480 -0
- package/get-research-done/templates/config.json +35 -0
- package/get-research-done/templates/context.md +283 -0
- package/get-research-done/templates/continue-here.md +78 -0
- package/get-research-done/templates/critic-log.md +288 -0
- package/get-research-done/templates/data-report.md +173 -0
- package/get-research-done/templates/debug-subagent-prompt.md +91 -0
- package/get-research-done/templates/decision-log.md +58 -0
- package/get-research-done/templates/decision.md +138 -0
- package/get-research-done/templates/discovery.md +146 -0
- package/get-research-done/templates/experiment-readme.md +104 -0
- package/get-research-done/templates/graduated-script.md +180 -0
- package/get-research-done/templates/iteration-summary.md +234 -0
- package/get-research-done/templates/milestone-archive.md +123 -0
- package/get-research-done/templates/milestone.md +115 -0
- package/get-research-done/templates/objective.md +271 -0
- package/get-research-done/templates/phase-prompt.md +567 -0
- package/get-research-done/templates/planner-subagent-prompt.md +117 -0
- package/get-research-done/templates/project.md +184 -0
- package/get-research-done/templates/requirements.md +231 -0
- package/get-research-done/templates/research-project/ARCHITECTURE.md +204 -0
- package/get-research-done/templates/research-project/FEATURES.md +147 -0
- package/get-research-done/templates/research-project/PITFALLS.md +200 -0
- package/get-research-done/templates/research-project/STACK.md +120 -0
- package/get-research-done/templates/research-project/SUMMARY.md +170 -0
- package/get-research-done/templates/research.md +529 -0
- package/get-research-done/templates/roadmap.md +202 -0
- package/get-research-done/templates/scorecard.json +113 -0
- package/get-research-done/templates/state.md +287 -0
- package/get-research-done/templates/summary.md +246 -0
- package/get-research-done/templates/user-setup.md +311 -0
- package/get-research-done/templates/verification-report.md +322 -0
- package/get-research-done/workflows/complete-milestone.md +756 -0
- package/get-research-done/workflows/diagnose-issues.md +231 -0
- package/get-research-done/workflows/discovery-phase.md +289 -0
- package/get-research-done/workflows/discuss-phase.md +433 -0
- package/get-research-done/workflows/execute-phase.md +657 -0
- package/get-research-done/workflows/execute-plan.md +1844 -0
- package/get-research-done/workflows/list-phase-assumptions.md +178 -0
- package/get-research-done/workflows/map-codebase.md +322 -0
- package/get-research-done/workflows/resume-project.md +307 -0
- package/get-research-done/workflows/transition.md +556 -0
- package/get-research-done/workflows/verify-phase.md +628 -0
- package/get-research-done/workflows/verify-work.md +596 -0
- package/hooks/dist/grd-check-update.js +61 -0
- package/hooks/dist/grd-statusline.js +84 -0
- package/package.json +47 -0
- package/scripts/audit-help-commands.sh +115 -0
- package/scripts/build-hooks.js +42 -0
- package/scripts/verify-all-commands.sh +246 -0
- package/scripts/verify-architect-warning.sh +35 -0
- package/scripts/verify-insights-mode.sh +40 -0
- package/scripts/verify-quick-mode.sh +20 -0
- package/scripts/verify-revise-data-routing.sh +139 -0
|
@@ -0,0 +1,231 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: grd:insights
|
|
3
|
+
description: Generate plain English data insights for business analysts without code or jargon
|
|
4
|
+
allowed-tools:
|
|
5
|
+
- Read
|
|
6
|
+
- Bash
|
|
7
|
+
- Write
|
|
8
|
+
- Task
|
|
9
|
+
- AskUserQuestion
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
<objective>
|
|
13
|
+
|
|
14
|
+
Generate accessible, plain English data insights for business analysts and non-technical stakeholders.
|
|
15
|
+
|
|
16
|
+
Unlike `/grd:explore` (technical) or `/grd:quick-explore` (fast), insights mode produces:
|
|
17
|
+
- **Technical report** saved to file (same rigor as full explore)
|
|
18
|
+
- **Plain English summary** displayed in console with "What This Means" explanations
|
|
19
|
+
- **Actionable recommendations** based on data characteristics
|
|
20
|
+
- **LLM prompts** for further exploration (copy-paste ready)
|
|
21
|
+
|
|
22
|
+
**Creates:**
|
|
23
|
+
- `.planning/DATA_REPORT.md` — full technical analysis (saved, not displayed)
|
|
24
|
+
- `.planning/INSIGHTS_SUMMARY.md` — plain English summary with recommendations
|
|
25
|
+
- Console output with business-friendly insights
|
|
26
|
+
|
|
27
|
+
**Use cases:**
|
|
28
|
+
- Explaining data to business stakeholders
|
|
29
|
+
- Preparing for cross-functional meetings
|
|
30
|
+
- Documenting data characteristics for non-technical team members
|
|
31
|
+
- Getting LLM-powered exploration prompts for deeper analysis
|
|
32
|
+
|
|
33
|
+
**After this command:**
|
|
34
|
+
- Share INSIGHTS_SUMMARY.md with stakeholders
|
|
35
|
+
- Use LLM prompts for further exploration
|
|
36
|
+
- Proceed to `/grd:architect` for hypothesis formation
|
|
37
|
+
|
|
38
|
+
</objective>
|
|
39
|
+
|
|
40
|
+
<execution_context>
|
|
41
|
+
|
|
42
|
+
@~/.claude/get-research-done/templates/data-report.md
|
|
43
|
+
|
|
44
|
+
</execution_context>
|
|
45
|
+
|
|
46
|
+
<process>
|
|
47
|
+
|
|
48
|
+
## Phase 1: Setup and Data Path Resolution
|
|
49
|
+
|
|
50
|
+
**Check if project initialized:**
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
[ ! -f .planning/PROJECT.md ] && echo "ERROR: Project not initialized. Run /grd:new-project first." && exit 1
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**Determine data path:**
|
|
57
|
+
|
|
58
|
+
If [path] argument provided:
|
|
59
|
+
- Use it directly
|
|
60
|
+
- Validate path exists
|
|
61
|
+
|
|
62
|
+
If no argument:
|
|
63
|
+
- Check for common data directories (./data/, ./datasets/, ./raw/)
|
|
64
|
+
- If found, list contents and ask user to select
|
|
65
|
+
- If not found, ask user to provide path interactively
|
|
66
|
+
|
|
67
|
+
## Phase 2: Spawn Explorer Agent (Insights Mode)
|
|
68
|
+
|
|
69
|
+
Display insights banner:
|
|
70
|
+
```
|
|
71
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
72
|
+
GRD ► DATA INSIGHTS
|
|
73
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
74
|
+
|
|
75
|
+
Analyzing: [data_path]
|
|
76
|
+
Mode: Insights (business-friendly output)
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Spawn grd-explorer agent with insights mode context:
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
Task(prompt="
|
|
83
|
+
<data_source>
|
|
84
|
+
Path: [data_path]
|
|
85
|
+
Type: [file | directory]
|
|
86
|
+
</data_source>
|
|
87
|
+
|
|
88
|
+
<profiling_mode>insights</profiling_mode>
|
|
89
|
+
|
|
90
|
+
<insights_mode_instructions>
|
|
91
|
+
Insights mode generates TWO outputs:
|
|
92
|
+
|
|
93
|
+
1. **Technical Report** (DATA_REPORT.md)
|
|
94
|
+
- Full statistical analysis (same as regular explore)
|
|
95
|
+
- Save to .planning/DATA_REPORT.md
|
|
96
|
+
- Do NOT display in console
|
|
97
|
+
|
|
98
|
+
2. **Plain English Summary** (INSIGHTS_SUMMARY.md + Console)
|
|
99
|
+
- Business-friendly language
|
|
100
|
+
- Every statistic includes 'What This Means' explanation
|
|
101
|
+
- Actionable recommendations
|
|
102
|
+
- LLM prompts for further exploration
|
|
103
|
+
|
|
104
|
+
Plain English writing rules:
|
|
105
|
+
- No jargon: 'missing values' not 'null frequency'
|
|
106
|
+
- Context for numbers: '15% missing' → '15% of rows have no value here, which could affect predictions'
|
|
107
|
+
- Severity language: 'critical' / 'concerning' / 'minor' / 'looks good'
|
|
108
|
+
- Action-oriented: 'Consider removing...' not 'High cardinality detected'
|
|
109
|
+
</insights_mode_instructions>
|
|
110
|
+
|
|
111
|
+
<summary_structure>
|
|
112
|
+
# Data Insights Summary
|
|
113
|
+
|
|
114
|
+
## TL;DR (5 bullet points max)
|
|
115
|
+
The most important things a business person needs to know.
|
|
116
|
+
|
|
117
|
+
## 5 Things to Know About This Data
|
|
118
|
+
| Finding | What This Means |
|
|
119
|
+
|---------|-----------------|
|
|
120
|
+
| X rows of data | Enough/not enough for reliable analysis |
|
|
121
|
+
| Y% missing in column Z | May need to collect more data or handle gaps |
|
|
122
|
+
|
|
123
|
+
## Critical Issues (if any)
|
|
124
|
+
Plain English explanation of blocking problems.
|
|
125
|
+
|
|
126
|
+
## Recommendations
|
|
127
|
+
Priority-sorted list with effort estimates:
|
|
128
|
+
1. [High] Fix X before modeling — prevents Y problem
|
|
129
|
+
2. [Medium] Consider Z — improves reliability
|
|
130
|
+
|
|
131
|
+
## Dig Deeper (LLM Prompts)
|
|
132
|
+
Copy-paste prompts for further exploration:
|
|
133
|
+
|
|
134
|
+
```
|
|
135
|
+
Analyze the relationship between [column A] and [column B] in this dataset.
|
|
136
|
+
What patterns do you see?
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
```
|
|
140
|
+
The [column] has [X]% missing values. What strategies would you recommend
|
|
141
|
+
for handling this, given that [context from data]?
|
|
142
|
+
```
|
|
143
|
+
</summary_structure>
|
|
144
|
+
|
|
145
|
+
<project_context>
|
|
146
|
+
@.planning/PROJECT.md
|
|
147
|
+
|
|
148
|
+
Extract:
|
|
149
|
+
- What this project is about
|
|
150
|
+
- Business context for recommendations
|
|
151
|
+
</project_context>
|
|
152
|
+
|
|
153
|
+
<output>
|
|
154
|
+
1. Write .planning/DATA_REPORT.md (full technical analysis)
|
|
155
|
+
2. Write .planning/INSIGHTS_SUMMARY.md (plain English summary)
|
|
156
|
+
3. Print INSIGHTS_SUMMARY.md content to console
|
|
157
|
+
4. Return paths to both files
|
|
158
|
+
</output>
|
|
159
|
+
", subagent_type="grd-explorer", model="sonnet", description="Generate data insights")
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## Phase 3: Present Results
|
|
163
|
+
|
|
164
|
+
After agent completes, display footer:
|
|
165
|
+
|
|
166
|
+
```
|
|
167
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
168
|
+
GRD ► INSIGHTS COMPLETE ✓
|
|
169
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
170
|
+
|
|
171
|
+
**For stakeholders:** .planning/INSIGHTS_SUMMARY.md
|
|
172
|
+
**Technical details:** .planning/DATA_REPORT.md
|
|
173
|
+
|
|
174
|
+
───────────────────────────────────────────────────────────────
|
|
175
|
+
|
|
176
|
+
**Share with team:** Copy INSIGHTS_SUMMARY.md content
|
|
177
|
+
**Deep dive:** Use the LLM prompts in the summary
|
|
178
|
+
**Next step:** /grd:architect — form a hypothesis
|
|
179
|
+
|
|
180
|
+
───────────────────────────────────────────────────────────────
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
</process>
|
|
184
|
+
|
|
185
|
+
<arguments>
|
|
186
|
+
|
|
187
|
+
**[path]** (required)
|
|
188
|
+
- Path to data file or directory
|
|
189
|
+
- Examples: `./data/train.csv`, `./datasets/`
|
|
190
|
+
|
|
191
|
+
</arguments>
|
|
192
|
+
|
|
193
|
+
<examples>
|
|
194
|
+
|
|
195
|
+
**Generate insights for CSV:**
|
|
196
|
+
```
|
|
197
|
+
/grd:insights ./data/train.csv
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
**Generate insights for directory:**
|
|
201
|
+
```
|
|
202
|
+
/grd:insights ./datasets/
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
</examples>
|
|
206
|
+
|
|
207
|
+
<output>
|
|
208
|
+
|
|
209
|
+
**Files created:**
|
|
210
|
+
- `.planning/DATA_REPORT.md` — full technical analysis
|
|
211
|
+
- `.planning/INSIGHTS_SUMMARY.md` — plain English summary
|
|
212
|
+
|
|
213
|
+
**Console output:**
|
|
214
|
+
- Complete INSIGHTS_SUMMARY.md content displayed
|
|
215
|
+
- Business-friendly language throughout
|
|
216
|
+
- LLM prompts for further exploration
|
|
217
|
+
|
|
218
|
+
</output>
|
|
219
|
+
|
|
220
|
+
<success_criteria>
|
|
221
|
+
|
|
222
|
+
- [ ] Data path resolved
|
|
223
|
+
- [ ] grd-explorer spawned with insights mode context
|
|
224
|
+
- [ ] DATA_REPORT.md created with full technical analysis
|
|
225
|
+
- [ ] INSIGHTS_SUMMARY.md created with plain English summary
|
|
226
|
+
- [ ] Every statistic includes "What This Means" explanation
|
|
227
|
+
- [ ] Actionable recommendations provided
|
|
228
|
+
- [ ] LLM prompts generated for further exploration
|
|
229
|
+
- [ ] Summary displayed in console
|
|
230
|
+
|
|
231
|
+
</success_criteria>
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: grd:join-discord
|
|
3
|
+
description: Join the GSD Discord community
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
<objective>
|
|
7
|
+
Display the Discord invite link for the GSD community server.
|
|
8
|
+
</objective>
|
|
9
|
+
|
|
10
|
+
<output>
|
|
11
|
+
# Join the GSD Discord
|
|
12
|
+
|
|
13
|
+
Connect with other GSD users, get help, share what you're building, and stay updated.
|
|
14
|
+
|
|
15
|
+
**Invite link:** https://discord.gg/5JJgD5svVS
|
|
16
|
+
|
|
17
|
+
Click the link or paste it into your browser to join.
|
|
18
|
+
</output>
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: grd:list-phase-assumptions
|
|
3
|
+
description: Surface Claude's assumptions about a phase approach before planning
|
|
4
|
+
argument-hint: "[phase]"
|
|
5
|
+
allowed-tools:
|
|
6
|
+
- Read
|
|
7
|
+
- Bash
|
|
8
|
+
- Grep
|
|
9
|
+
- Glob
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
<objective>
|
|
13
|
+
Analyze a phase and present Claude's assumptions about technical approach, implementation order, scope boundaries, risk areas, and dependencies.
|
|
14
|
+
|
|
15
|
+
Purpose: Help users see what Claude thinks BEFORE planning begins - enabling course correction early when assumptions are wrong.
|
|
16
|
+
Output: Conversational output only (no file creation) - ends with "What do you think?" prompt
|
|
17
|
+
</objective>
|
|
18
|
+
|
|
19
|
+
<execution_context>
|
|
20
|
+
@~/.claude/get-research-done/workflows/list-phase-assumptions.md
|
|
21
|
+
</execution_context>
|
|
22
|
+
|
|
23
|
+
<context>
|
|
24
|
+
Phase number: $ARGUMENTS (required)
|
|
25
|
+
|
|
26
|
+
**Load project state first:**
|
|
27
|
+
@.planning/STATE.md
|
|
28
|
+
|
|
29
|
+
**Load roadmap:**
|
|
30
|
+
@.planning/ROADMAP.md
|
|
31
|
+
</context>
|
|
32
|
+
|
|
33
|
+
<process>
|
|
34
|
+
1. Validate phase number argument (error if missing or invalid)
|
|
35
|
+
2. Check if phase exists in roadmap
|
|
36
|
+
3. Follow list-phase-assumptions.md workflow:
|
|
37
|
+
- Analyze roadmap description
|
|
38
|
+
- Surface assumptions about: technical approach, implementation order, scope, risks, dependencies
|
|
39
|
+
- Present assumptions clearly
|
|
40
|
+
- Prompt "What do you think?"
|
|
41
|
+
4. Gather feedback and offer next steps
|
|
42
|
+
</process>
|
|
43
|
+
|
|
44
|
+
<success_criteria>
|
|
45
|
+
|
|
46
|
+
- Phase validated against roadmap
|
|
47
|
+
- Assumptions surfaced across five areas
|
|
48
|
+
- User prompted for feedback
|
|
49
|
+
- User knows next steps (discuss context, plan phase, or correct assumptions)
|
|
50
|
+
</success_criteria>
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: grd:map-codebase
|
|
3
|
+
description: Analyze codebase with parallel mapper agents to produce .planning/codebase/ documents
|
|
4
|
+
argument-hint: "[optional: specific area to map, e.g., 'api' or 'auth']"
|
|
5
|
+
allowed-tools:
|
|
6
|
+
- Read
|
|
7
|
+
- Bash
|
|
8
|
+
- Glob
|
|
9
|
+
- Grep
|
|
10
|
+
- Write
|
|
11
|
+
- Task
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
<objective>
|
|
15
|
+
Analyze existing codebase using parallel grd-codebase-mapper agents to produce structured codebase documents.
|
|
16
|
+
|
|
17
|
+
Each mapper agent explores a focus area and **writes documents directly** to `.planning/codebase/`. The orchestrator only receives confirmations, keeping context usage minimal.
|
|
18
|
+
|
|
19
|
+
Output: .planning/codebase/ folder with 7 structured documents about the codebase state.
|
|
20
|
+
</objective>
|
|
21
|
+
|
|
22
|
+
<execution_context>
|
|
23
|
+
@~/.claude/get-research-done/workflows/map-codebase.md
|
|
24
|
+
</execution_context>
|
|
25
|
+
|
|
26
|
+
<context>
|
|
27
|
+
Focus area: $ARGUMENTS (optional - if provided, tells agents to focus on specific subsystem)
|
|
28
|
+
|
|
29
|
+
**Load project state if exists:**
|
|
30
|
+
Check for .planning/STATE.md - loads context if project already initialized
|
|
31
|
+
|
|
32
|
+
**This command can run:**
|
|
33
|
+
- Before /grd:new-project (brownfield codebases) - creates codebase map first
|
|
34
|
+
- After /grd:new-project (greenfield codebases) - updates codebase map as code evolves
|
|
35
|
+
- Anytime to refresh codebase understanding
|
|
36
|
+
</context>
|
|
37
|
+
|
|
38
|
+
<when_to_use>
|
|
39
|
+
**Use map-codebase for:**
|
|
40
|
+
- Brownfield projects before initialization (understand existing code first)
|
|
41
|
+
- Refreshing codebase map after significant changes
|
|
42
|
+
- Onboarding to an unfamiliar codebase
|
|
43
|
+
- Before major refactoring (understand current state)
|
|
44
|
+
- When STATE.md references outdated codebase info
|
|
45
|
+
|
|
46
|
+
**Skip map-codebase for:**
|
|
47
|
+
- Greenfield projects with no code yet (nothing to map)
|
|
48
|
+
- Trivial codebases (<5 files)
|
|
49
|
+
</when_to_use>
|
|
50
|
+
|
|
51
|
+
<process>
|
|
52
|
+
1. Check if .planning/codebase/ already exists (offer to refresh or skip)
|
|
53
|
+
2. Create .planning/codebase/ directory structure
|
|
54
|
+
3. Spawn 4 parallel grd-codebase-mapper agents:
|
|
55
|
+
- Agent 1: tech focus → writes STACK.md, INTEGRATIONS.md
|
|
56
|
+
- Agent 2: arch focus → writes ARCHITECTURE.md, STRUCTURE.md
|
|
57
|
+
- Agent 3: quality focus → writes CONVENTIONS.md, TESTING.md
|
|
58
|
+
- Agent 4: concerns focus → writes CONCERNS.md
|
|
59
|
+
4. Wait for agents to complete, collect confirmations (NOT document contents)
|
|
60
|
+
5. Verify all 7 documents exist with line counts
|
|
61
|
+
6. Commit codebase map
|
|
62
|
+
7. Offer next steps (typically: /grd:new-project or /grd:plan-phase)
|
|
63
|
+
</process>
|
|
64
|
+
|
|
65
|
+
<success_criteria>
|
|
66
|
+
- [ ] .planning/codebase/ directory created
|
|
67
|
+
- [ ] All 7 codebase documents written by mapper agents
|
|
68
|
+
- [ ] Documents follow template structure
|
|
69
|
+
- [ ] Parallel agents completed without errors
|
|
70
|
+
- [ ] User knows next steps
|
|
71
|
+
</success_criteria>
|