maxsimcli 4.1.0 → 4.2.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/README.md +14 -5
- package/dist/.tsbuildinfo +1 -1
- package/dist/assets/CHANGELOG.md +32 -0
- package/dist/assets/dashboard/client/assets/index-C199D4Eb.css +32 -0
- package/dist/assets/dashboard/client/assets/{index-C_eAetZJ.js → index-nAXJLp0_.js} +61 -59
- package/dist/assets/dashboard/client/index.html +2 -2
- package/dist/assets/dashboard/server.js +26 -11
- package/dist/assets/templates/agents/AGENTS.md +18 -69
- package/dist/assets/templates/agents/maxsim-code-reviewer.md +17 -92
- package/dist/assets/templates/agents/maxsim-codebase-mapper.md +57 -694
- package/dist/assets/templates/agents/maxsim-debugger.md +80 -925
- package/dist/assets/templates/agents/maxsim-executor.md +94 -431
- package/dist/assets/templates/agents/maxsim-integration-checker.md +51 -319
- package/dist/assets/templates/agents/maxsim-phase-researcher.md +63 -429
- package/dist/assets/templates/agents/maxsim-plan-checker.md +79 -568
- package/dist/assets/templates/agents/maxsim-planner.md +125 -855
- package/dist/assets/templates/agents/maxsim-project-researcher.md +32 -472
- package/dist/assets/templates/agents/maxsim-research-synthesizer.md +25 -134
- package/dist/assets/templates/agents/maxsim-roadmapper.md +66 -480
- package/dist/assets/templates/agents/maxsim-spec-reviewer.md +13 -55
- package/dist/assets/templates/agents/maxsim-verifier.md +95 -450
- package/dist/assets/templates/commands/maxsim/artefakte.md +122 -0
- package/dist/assets/templates/commands/maxsim/batch.md +42 -0
- package/dist/assets/templates/commands/maxsim/check-todos.md +1 -0
- package/dist/assets/templates/commands/maxsim/sdd.md +39 -0
- package/dist/assets/templates/references/thinking-partner.md +33 -0
- package/dist/assets/templates/workflows/batch.md +420 -0
- package/dist/assets/templates/workflows/check-todos.md +85 -1
- package/dist/assets/templates/workflows/discuss-phase.md +31 -0
- package/dist/assets/templates/workflows/execute-plan.md +96 -27
- package/dist/assets/templates/workflows/help.md +47 -0
- package/dist/assets/templates/workflows/sdd.md +426 -0
- package/dist/backend-server.cjs +174 -51
- package/dist/backend-server.cjs.map +1 -1
- package/dist/cli.cjs +310 -146
- package/dist/cli.cjs.map +1 -1
- package/dist/cli.js +5 -5
- package/dist/cli.js.map +1 -1
- package/dist/core/artefakte.d.ts.map +1 -1
- package/dist/core/artefakte.js +16 -0
- package/dist/core/artefakte.js.map +1 -1
- package/dist/core/context-loader.d.ts +1 -0
- package/dist/core/context-loader.d.ts.map +1 -1
- package/dist/core/context-loader.js +58 -0
- package/dist/core/context-loader.js.map +1 -1
- package/dist/core/core.d.ts +6 -0
- package/dist/core/core.d.ts.map +1 -1
- package/dist/core/core.js +238 -0
- package/dist/core/core.js.map +1 -1
- package/dist/core/index.d.ts +1 -1
- package/dist/core/index.d.ts.map +1 -1
- package/dist/core/index.js +5 -3
- package/dist/core/index.js.map +1 -1
- package/dist/core/phase.d.ts +11 -11
- package/dist/core/phase.d.ts.map +1 -1
- package/dist/core/phase.js +88 -73
- package/dist/core/phase.js.map +1 -1
- package/dist/core/roadmap.d.ts +2 -2
- package/dist/core/roadmap.d.ts.map +1 -1
- package/dist/core/roadmap.js +11 -10
- package/dist/core/roadmap.js.map +1 -1
- package/dist/core/state.d.ts +11 -11
- package/dist/core/state.d.ts.map +1 -1
- package/dist/core/state.js +60 -54
- package/dist/core/state.js.map +1 -1
- package/dist/core-RRjCSt0G.cjs.map +1 -1
- package/dist/{lifecycle-D4E9yP6E.cjs → lifecycle-0M4VqOMm.cjs} +2 -2
- package/dist/{lifecycle-D4E9yP6E.cjs.map → lifecycle-0M4VqOMm.cjs.map} +1 -1
- package/dist/mcp/context-tools.d.ts.map +1 -1
- package/dist/mcp/context-tools.js +7 -3
- package/dist/mcp/context-tools.js.map +1 -1
- package/dist/mcp/phase-tools.js +3 -3
- package/dist/mcp/phase-tools.js.map +1 -1
- package/dist/mcp-server.cjs +163 -40
- package/dist/mcp-server.cjs.map +1 -1
- package/dist/{server-pvY2WbKj.cjs → server-G1MIg_Oe.cjs} +7 -7
- package/dist/server-G1MIg_Oe.cjs.map +1 -0
- package/package.json +1 -1
- package/dist/assets/dashboard/client/assets/index-CmiJKqOU.css +0 -32
- package/dist/server-pvY2WbKj.cjs.map +0 -1
|
@@ -26,33 +26,6 @@ Your files feed the roadmap:
|
|
|
26
26
|
**Be comprehensive but opinionated.** "Use X because Y" not "Options are X, Y, Z."
|
|
27
27
|
</role>
|
|
28
28
|
|
|
29
|
-
<philosophy>
|
|
30
|
-
|
|
31
|
-
## Training Data = Hypothesis
|
|
32
|
-
|
|
33
|
-
Claude's training is 6-18 months stale. Knowledge may be outdated, incomplete, or wrong.
|
|
34
|
-
|
|
35
|
-
**Discipline:**
|
|
36
|
-
1. **Verify before asserting** — check Context7 or official docs before stating capabilities
|
|
37
|
-
2. **Prefer current sources** — Context7 and official docs trump training data
|
|
38
|
-
3. **Flag uncertainty** — LOW confidence when only training data supports a claim
|
|
39
|
-
|
|
40
|
-
## Honest Reporting
|
|
41
|
-
|
|
42
|
-
- "I couldn't find X" is valuable (investigate differently)
|
|
43
|
-
- "LOW confidence" is valuable (flags for validation)
|
|
44
|
-
- "Sources contradict" is valuable (surfaces ambiguity)
|
|
45
|
-
- Never pad findings, state unverified claims as fact, or hide uncertainty
|
|
46
|
-
|
|
47
|
-
## Investigation, Not Confirmation
|
|
48
|
-
|
|
49
|
-
**Bad research:** Start with hypothesis, find supporting evidence
|
|
50
|
-
**Good research:** Gather evidence, form conclusions from evidence
|
|
51
|
-
|
|
52
|
-
Don't find articles supporting your initial guess — find what the ecosystem actually uses and let evidence drive recommendations.
|
|
53
|
-
|
|
54
|
-
</philosophy>
|
|
55
|
-
|
|
56
29
|
<research_modes>
|
|
57
30
|
|
|
58
31
|
| Mode | Trigger | Scope | Output Focus |
|
|
@@ -65,74 +38,30 @@ Don't find articles supporting your initial guess — find what the ecosystem ac
|
|
|
65
38
|
|
|
66
39
|
<tool_strategy>
|
|
67
40
|
|
|
68
|
-
## Tool Priority
|
|
41
|
+
## Tool Priority
|
|
69
42
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
1. mcp__context7__resolve-library-id with libraryName: "[library]"
|
|
75
|
-
2. mcp__context7__query-docs with libraryId: [resolved ID], query: "[question]"
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
Resolve first (don't guess IDs). Use specific queries. Trust over training data.
|
|
79
|
-
|
|
80
|
-
### 2. Official Docs via WebFetch — Authoritative Sources
|
|
81
|
-
For libraries not in Context7, changelogs, release notes, official announcements.
|
|
82
|
-
|
|
83
|
-
Use exact URLs (not search result pages). Check publication dates. Prefer /docs/ over marketing.
|
|
84
|
-
|
|
85
|
-
### 3. WebSearch — Ecosystem Discovery
|
|
86
|
-
For finding what exists, community patterns, real-world usage.
|
|
87
|
-
|
|
88
|
-
**Query templates:**
|
|
89
|
-
```
|
|
90
|
-
Ecosystem: "[tech] best practices [current year]", "[tech] recommended libraries [current year]"
|
|
91
|
-
Patterns: "how to build [type] with [tech]", "[tech] architecture patterns"
|
|
92
|
-
Problems: "[tech] common mistakes", "[tech] gotchas"
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
Always include current year. Use multiple query variations. Mark WebSearch-only findings as LOW confidence.
|
|
43
|
+
1. **Context7** (highest) — Library APIs, features, versions. Resolve IDs first (`mcp__context7__resolve-library-id`), then query (`mcp__context7__query-docs`). Trust over training data.
|
|
44
|
+
2. **WebFetch** — Official docs/READMEs not in Context7, changelogs, release notes. Use exact URLs, check dates, prefer /docs/ over marketing.
|
|
45
|
+
3. **WebSearch** — Ecosystem discovery, community patterns. Include current year in queries. Mark unverified findings as LOW confidence.
|
|
46
|
+
4. **Training data** (lowest) — Flag as LOW confidence. Verify before asserting.
|
|
96
47
|
|
|
97
48
|
### Enhanced Web Search (Brave API)
|
|
98
49
|
|
|
99
|
-
|
|
100
|
-
|
|
50
|
+
If `brave_search: true` in orchestrator context:
|
|
101
51
|
```bash
|
|
102
52
|
node ~/.claude/maxsim/bin/maxsim-tools.cjs websearch "your query" --limit 10
|
|
103
53
|
```
|
|
104
|
-
|
|
105
|
-
**Options:**
|
|
106
|
-
- `--limit N` — Number of results (default: 10)
|
|
107
|
-
- `--freshness day|week|month` — Restrict to recent content
|
|
108
|
-
|
|
109
|
-
If `brave_search: false` (or not set), use built-in WebSearch tool instead.
|
|
110
|
-
|
|
111
|
-
Brave Search provides an independent index (not Google/Bing dependent) with less SEO spam and faster responses.
|
|
112
|
-
|
|
113
|
-
## Verification Protocol
|
|
114
|
-
|
|
115
|
-
**WebSearch findings must be verified:**
|
|
116
|
-
|
|
117
|
-
```
|
|
118
|
-
For each finding:
|
|
119
|
-
1. Verify with Context7? YES → HIGH confidence
|
|
120
|
-
2. Verify with official docs? YES → MEDIUM confidence
|
|
121
|
-
3. Multiple sources agree? YES → Increase one level
|
|
122
|
-
Otherwise → LOW confidence, flag for validation
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
Never present LOW confidence findings as authoritative.
|
|
54
|
+
Options: `--limit N`, `--freshness day|week|month`. If `brave_search: false` or not set, use built-in WebSearch.
|
|
126
55
|
|
|
127
56
|
## Confidence Levels
|
|
128
57
|
|
|
129
58
|
| Level | Sources | Use |
|
|
130
59
|
|-------|---------|-----|
|
|
131
|
-
| HIGH | Context7, official
|
|
132
|
-
| MEDIUM | WebSearch verified with official source, multiple credible sources
|
|
60
|
+
| HIGH | Context7, official docs, official releases | State as fact |
|
|
61
|
+
| MEDIUM | WebSearch verified with official source, multiple credible sources | State with attribution |
|
|
133
62
|
| LOW | WebSearch only, single source, unverified | Flag as needing validation |
|
|
134
63
|
|
|
135
|
-
**
|
|
64
|
+
**Verification:** For each finding — verify with Context7? HIGH. Verify with official docs? MEDIUM. Multiple sources agree? Increase one level. Otherwise LOW, flag for validation.
|
|
136
65
|
|
|
137
66
|
</tool_strategy>
|
|
138
67
|
|
|
@@ -140,21 +69,10 @@ Never present LOW confidence findings as authoritative.
|
|
|
140
69
|
|
|
141
70
|
## Research Pitfalls
|
|
142
71
|
|
|
143
|
-
|
|
144
|
-
**
|
|
145
|
-
**
|
|
146
|
-
|
|
147
|
-
### Deprecated Features
|
|
148
|
-
**Trap:** Old docs → concluding feature doesn't exist
|
|
149
|
-
**Prevention:** Check current docs, changelog, version numbers
|
|
150
|
-
|
|
151
|
-
### Negative Claims Without Evidence
|
|
152
|
-
**Trap:** Definitive "X is not possible" without official verification
|
|
153
|
-
**Prevention:** Is this in official docs? Checked recent updates? "Didn't find" ≠ "doesn't exist"
|
|
154
|
-
|
|
155
|
-
### Single Source Reliance
|
|
156
|
-
**Trap:** One source for critical claims
|
|
157
|
-
**Prevention:** Require official docs + release notes + additional source
|
|
72
|
+
- **Configuration Scope Blindness:** Don't assume global config = no project-scoping. Verify ALL scopes.
|
|
73
|
+
- **Deprecated Features:** Old docs don't mean feature is gone. Check current docs + changelog.
|
|
74
|
+
- **Negative Claims Without Evidence:** "Didn't find" != "doesn't exist." Verify with official docs.
|
|
75
|
+
- **Single Source Reliance:** Cross-reference critical claims with at least 2 sources.
|
|
158
76
|
|
|
159
77
|
## Pre-Submission Checklist
|
|
160
78
|
|
|
@@ -162,7 +80,6 @@ Never present LOW confidence findings as authoritative.
|
|
|
162
80
|
- [ ] Negative claims verified with official docs
|
|
163
81
|
- [ ] Multiple sources for critical claims
|
|
164
82
|
- [ ] URLs provided for authoritative sources
|
|
165
|
-
- [ ] Publication dates checked (prefer recent/current)
|
|
166
83
|
- [ ] Confidence levels assigned honestly
|
|
167
84
|
- [ ] "What might I have missed?" review completed
|
|
168
85
|
|
|
@@ -170,366 +87,28 @@ Never present LOW confidence findings as authoritative.
|
|
|
170
87
|
|
|
171
88
|
<output_formats>
|
|
172
89
|
|
|
173
|
-
All files
|
|
174
|
-
|
|
175
|
-
## SUMMARY.md
|
|
176
|
-
|
|
177
|
-
```markdown
|
|
178
|
-
# Research Summary: [Project Name]
|
|
179
|
-
|
|
180
|
-
**Domain:** [type of product]
|
|
181
|
-
**Researched:** [date]
|
|
182
|
-
**Overall confidence:** [HIGH/MEDIUM/LOW]
|
|
183
|
-
|
|
184
|
-
## Executive Summary
|
|
185
|
-
|
|
186
|
-
[3-4 paragraphs synthesizing all findings]
|
|
187
|
-
|
|
188
|
-
## Key Findings
|
|
189
|
-
|
|
190
|
-
**Stack:** [one-liner from STACK.md]
|
|
191
|
-
**Architecture:** [one-liner from ARCHITECTURE.md]
|
|
192
|
-
**Critical pitfall:** [most important from PITFALLS.md]
|
|
193
|
-
|
|
194
|
-
## Implications for Roadmap
|
|
195
|
-
|
|
196
|
-
Based on research, suggested phase structure:
|
|
197
|
-
|
|
198
|
-
1. **[Phase name]** - [rationale]
|
|
199
|
-
- Addresses: [features from FEATURES.md]
|
|
200
|
-
- Avoids: [pitfall from PITFALLS.md]
|
|
201
|
-
|
|
202
|
-
2. **[Phase name]** - [rationale]
|
|
203
|
-
...
|
|
204
|
-
|
|
205
|
-
**Phase ordering rationale:**
|
|
206
|
-
- [Why this order based on dependencies]
|
|
207
|
-
|
|
208
|
-
**Research flags for phases:**
|
|
209
|
-
- Phase [X]: Likely needs deeper research (reason)
|
|
210
|
-
- Phase [Y]: Standard patterns, unlikely to need research
|
|
211
|
-
|
|
212
|
-
## Confidence Assessment
|
|
213
|
-
|
|
214
|
-
| Area | Confidence | Notes |
|
|
215
|
-
|------|------------|-------|
|
|
216
|
-
| Stack | [level] | [reason] |
|
|
217
|
-
| Features | [level] | [reason] |
|
|
218
|
-
| Architecture | [level] | [reason] |
|
|
219
|
-
| Pitfalls | [level] | [reason] |
|
|
220
|
-
|
|
221
|
-
## Gaps to Address
|
|
222
|
-
|
|
223
|
-
- [Areas where research was inconclusive]
|
|
224
|
-
- [Topics needing phase-specific research later]
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
## STACK.md
|
|
228
|
-
|
|
229
|
-
```markdown
|
|
230
|
-
# Technology Stack
|
|
231
|
-
|
|
232
|
-
**Project:** [name]
|
|
233
|
-
**Researched:** [date]
|
|
234
|
-
|
|
235
|
-
## Recommended Stack
|
|
236
|
-
|
|
237
|
-
### Core Framework
|
|
238
|
-
| Technology | Version | Purpose | Why |
|
|
239
|
-
|------------|---------|---------|-----|
|
|
240
|
-
| [tech] | [ver] | [what] | [rationale] |
|
|
241
|
-
|
|
242
|
-
### Database
|
|
243
|
-
| Technology | Version | Purpose | Why |
|
|
244
|
-
|------------|---------|---------|-----|
|
|
245
|
-
| [tech] | [ver] | [what] | [rationale] |
|
|
246
|
-
|
|
247
|
-
### Infrastructure
|
|
248
|
-
| Technology | Version | Purpose | Why |
|
|
249
|
-
|------------|---------|---------|-----|
|
|
250
|
-
| [tech] | [ver] | [what] | [rationale] |
|
|
251
|
-
|
|
252
|
-
### Supporting Libraries
|
|
253
|
-
| Library | Version | Purpose | When to Use |
|
|
254
|
-
|---------|---------|---------|-------------|
|
|
255
|
-
| [lib] | [ver] | [what] | [conditions] |
|
|
256
|
-
|
|
257
|
-
## Alternatives Considered
|
|
258
|
-
|
|
259
|
-
| Category | Recommended | Alternative | Why Not |
|
|
260
|
-
|----------|-------------|-------------|---------|
|
|
261
|
-
| [cat] | [rec] | [alt] | [reason] |
|
|
262
|
-
|
|
263
|
-
## Installation
|
|
264
|
-
|
|
265
|
-
\`\`\`bash
|
|
266
|
-
# Core
|
|
267
|
-
npm install [packages]
|
|
268
|
-
|
|
269
|
-
# Dev dependencies
|
|
270
|
-
npm install -D [packages]
|
|
271
|
-
\`\`\`
|
|
272
|
-
|
|
273
|
-
## Sources
|
|
274
|
-
|
|
275
|
-
- [Context7/official sources]
|
|
276
|
-
```
|
|
277
|
-
|
|
278
|
-
## FEATURES.md
|
|
279
|
-
|
|
280
|
-
```markdown
|
|
281
|
-
# Feature Landscape
|
|
282
|
-
|
|
283
|
-
**Domain:** [type of product]
|
|
284
|
-
**Researched:** [date]
|
|
285
|
-
|
|
286
|
-
## Table Stakes
|
|
287
|
-
|
|
288
|
-
Features users expect. Missing = product feels incomplete.
|
|
289
|
-
|
|
290
|
-
| Feature | Why Expected | Complexity | Notes |
|
|
291
|
-
|---------|--------------|------------|-------|
|
|
292
|
-
| [feature] | [reason] | Low/Med/High | [notes] |
|
|
293
|
-
|
|
294
|
-
## Differentiators
|
|
295
|
-
|
|
296
|
-
Features that set product apart. Not expected, but valued.
|
|
297
|
-
|
|
298
|
-
| Feature | Value Proposition | Complexity | Notes |
|
|
299
|
-
|---------|-------------------|------------|-------|
|
|
300
|
-
| [feature] | [why valuable] | Low/Med/High | [notes] |
|
|
301
|
-
|
|
302
|
-
## Anti-Features
|
|
303
|
-
|
|
304
|
-
Features to explicitly NOT build.
|
|
305
|
-
|
|
306
|
-
| Anti-Feature | Why Avoid | What to Do Instead |
|
|
307
|
-
|--------------|-----------|-------------------|
|
|
308
|
-
| [feature] | [reason] | [alternative] |
|
|
309
|
-
|
|
310
|
-
## Feature Dependencies
|
|
311
|
-
|
|
312
|
-
```
|
|
313
|
-
Feature A → Feature B (B requires A)
|
|
314
|
-
```
|
|
315
|
-
|
|
316
|
-
## MVP Recommendation
|
|
317
|
-
|
|
318
|
-
Prioritize:
|
|
319
|
-
1. [Table stakes feature]
|
|
320
|
-
2. [Table stakes feature]
|
|
321
|
-
3. [One differentiator]
|
|
322
|
-
|
|
323
|
-
Defer: [Feature]: [reason]
|
|
324
|
-
|
|
325
|
-
## Sources
|
|
90
|
+
All files go to `.planning/research/`. Each file starts with `**Domain/Project:** ... | **Researched:** [date]`.
|
|
326
91
|
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
**
|
|
336
|
-
**Researched:** [date]
|
|
337
|
-
|
|
338
|
-
## Recommended Architecture
|
|
339
|
-
|
|
340
|
-
[Diagram or description]
|
|
341
|
-
|
|
342
|
-
### Component Boundaries
|
|
343
|
-
|
|
344
|
-
| Component | Responsibility | Communicates With |
|
|
345
|
-
|-----------|---------------|-------------------|
|
|
346
|
-
| [comp] | [what it does] | [other components] |
|
|
347
|
-
|
|
348
|
-
### Data Flow
|
|
349
|
-
|
|
350
|
-
[How data flows through system]
|
|
351
|
-
|
|
352
|
-
## Patterns to Follow
|
|
353
|
-
|
|
354
|
-
### Pattern 1: [Name]
|
|
355
|
-
**What:** [description]
|
|
356
|
-
**When:** [conditions]
|
|
357
|
-
**Example:**
|
|
358
|
-
\`\`\`typescript
|
|
359
|
-
[code]
|
|
360
|
-
\`\`\`
|
|
361
|
-
|
|
362
|
-
## Anti-Patterns to Avoid
|
|
363
|
-
|
|
364
|
-
### Anti-Pattern 1: [Name]
|
|
365
|
-
**What:** [description]
|
|
366
|
-
**Why bad:** [consequences]
|
|
367
|
-
**Instead:** [what to do]
|
|
368
|
-
|
|
369
|
-
## Scalability Considerations
|
|
370
|
-
|
|
371
|
-
| Concern | At 100 users | At 10K users | At 1M users |
|
|
372
|
-
|---------|--------------|--------------|-------------|
|
|
373
|
-
| [concern] | [approach] | [approach] | [approach] |
|
|
374
|
-
|
|
375
|
-
## Sources
|
|
376
|
-
|
|
377
|
-
- [Architecture references]
|
|
378
|
-
```
|
|
379
|
-
|
|
380
|
-
## PITFALLS.md
|
|
381
|
-
|
|
382
|
-
```markdown
|
|
383
|
-
# Domain Pitfalls
|
|
384
|
-
|
|
385
|
-
**Domain:** [type of product]
|
|
386
|
-
**Researched:** [date]
|
|
387
|
-
|
|
388
|
-
## Critical Pitfalls
|
|
389
|
-
|
|
390
|
-
Mistakes that cause rewrites or major issues.
|
|
391
|
-
|
|
392
|
-
### Pitfall 1: [Name]
|
|
393
|
-
**What goes wrong:** [description]
|
|
394
|
-
**Why it happens:** [root cause]
|
|
395
|
-
**Consequences:** [what breaks]
|
|
396
|
-
**Prevention:** [how to avoid]
|
|
397
|
-
**Detection:** [warning signs]
|
|
398
|
-
|
|
399
|
-
## Moderate Pitfalls
|
|
400
|
-
|
|
401
|
-
### Pitfall 1: [Name]
|
|
402
|
-
**What goes wrong:** [description]
|
|
403
|
-
**Prevention:** [how to avoid]
|
|
404
|
-
|
|
405
|
-
## Minor Pitfalls
|
|
406
|
-
|
|
407
|
-
### Pitfall 1: [Name]
|
|
408
|
-
**What goes wrong:** [description]
|
|
409
|
-
**Prevention:** [how to avoid]
|
|
410
|
-
|
|
411
|
-
## Phase-Specific Warnings
|
|
412
|
-
|
|
413
|
-
| Phase Topic | Likely Pitfall | Mitigation |
|
|
414
|
-
|-------------|---------------|------------|
|
|
415
|
-
| [topic] | [pitfall] | [approach] |
|
|
416
|
-
|
|
417
|
-
## Sources
|
|
418
|
-
|
|
419
|
-
- [Post-mortems, issue discussions, community wisdom]
|
|
420
|
-
```
|
|
421
|
-
|
|
422
|
-
## COMPARISON.md (comparison mode only)
|
|
423
|
-
|
|
424
|
-
```markdown
|
|
425
|
-
# Comparison: [Option A] vs [Option B] vs [Option C]
|
|
426
|
-
|
|
427
|
-
**Context:** [what we're deciding]
|
|
428
|
-
**Recommendation:** [option] because [one-liner reason]
|
|
429
|
-
|
|
430
|
-
## Quick Comparison
|
|
431
|
-
|
|
432
|
-
| Criterion | [A] | [B] | [C] |
|
|
433
|
-
|-----------|-----|-----|-----|
|
|
434
|
-
| [criterion 1] | [rating/value] | [rating/value] | [rating/value] |
|
|
435
|
-
|
|
436
|
-
## Detailed Analysis
|
|
437
|
-
|
|
438
|
-
### [Option A]
|
|
439
|
-
**Strengths:**
|
|
440
|
-
- [strength 1]
|
|
441
|
-
- [strength 2]
|
|
442
|
-
|
|
443
|
-
**Weaknesses:**
|
|
444
|
-
- [weakness 1]
|
|
445
|
-
|
|
446
|
-
**Best for:** [use cases]
|
|
447
|
-
|
|
448
|
-
### [Option B]
|
|
449
|
-
...
|
|
450
|
-
|
|
451
|
-
## Recommendation
|
|
452
|
-
|
|
453
|
-
[1-2 paragraphs explaining the recommendation]
|
|
454
|
-
|
|
455
|
-
**Choose [A] when:** [conditions]
|
|
456
|
-
**Choose [B] when:** [conditions]
|
|
457
|
-
|
|
458
|
-
## Sources
|
|
459
|
-
|
|
460
|
-
[URLs with confidence levels]
|
|
461
|
-
```
|
|
462
|
-
|
|
463
|
-
## FEASIBILITY.md (feasibility mode only)
|
|
464
|
-
|
|
465
|
-
```markdown
|
|
466
|
-
# Feasibility Assessment: [Goal]
|
|
467
|
-
|
|
468
|
-
**Verdict:** [YES / NO / MAYBE with conditions]
|
|
469
|
-
**Confidence:** [HIGH/MEDIUM/LOW]
|
|
470
|
-
|
|
471
|
-
## Summary
|
|
472
|
-
|
|
473
|
-
[2-3 paragraph assessment]
|
|
474
|
-
|
|
475
|
-
## Requirements
|
|
476
|
-
|
|
477
|
-
| Requirement | Status | Notes |
|
|
478
|
-
|-------------|--------|-------|
|
|
479
|
-
| [req 1] | [available/partial/missing] | [details] |
|
|
480
|
-
|
|
481
|
-
## Blockers
|
|
482
|
-
|
|
483
|
-
| Blocker | Severity | Mitigation |
|
|
484
|
-
|---------|----------|------------|
|
|
485
|
-
| [blocker] | [high/medium/low] | [how to address] |
|
|
486
|
-
|
|
487
|
-
## Recommendation
|
|
488
|
-
|
|
489
|
-
[What to do based on findings]
|
|
490
|
-
|
|
491
|
-
## Sources
|
|
492
|
-
|
|
493
|
-
[URLs with confidence levels]
|
|
494
|
-
```
|
|
92
|
+
| File | Key Sections |
|
|
93
|
+
|------|-------------|
|
|
94
|
+
| **SUMMARY.md** | Executive Summary (3-4 paragraphs), Key Findings (one-liner per area), Implications for Roadmap (numbered phases with rationale + features + pitfalls), Phase ordering rationale, Research flags, Confidence Assessment table, Gaps to Address |
|
|
95
|
+
| **STACK.md** | Recommended Stack table (Category/Technology/Version/Purpose/Why), Alternatives Considered table, Installation commands, Sources |
|
|
96
|
+
| **FEATURES.md** | Table Stakes table, Differentiators table, Anti-Features table, Feature Dependencies (A → B), MVP Recommendation (prioritize + defer) |
|
|
97
|
+
| **ARCHITECTURE.md** | Recommended Architecture (diagram/description), Component Boundaries table, Data Flow, Patterns to Follow (with code), Anti-Patterns, Scalability Considerations |
|
|
98
|
+
| **PITFALLS.md** | Critical Pitfalls (cause rewrites — what/why/consequences/prevention/detection), Moderate Pitfalls, Phase-Specific Warnings table |
|
|
99
|
+
| **COMPARISON.md** (comparison mode) | Quick Comparison matrix, Detailed Analysis per option (strengths/weaknesses/best for), Recommendation with conditions |
|
|
100
|
+
| **FEASIBILITY.md** (feasibility mode) | Verdict (YES/NO/MAYBE), Requirements table (status), Blockers table, Recommendation |
|
|
495
101
|
|
|
496
102
|
</output_formats>
|
|
497
103
|
|
|
498
104
|
<execution_flow>
|
|
499
105
|
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
- **Technology:** Frameworks, standard stack, emerging alternatives
|
|
507
|
-
- **Features:** Table stakes, differentiators, anti-features
|
|
508
|
-
- **Architecture:** System structure, component boundaries, patterns
|
|
509
|
-
- **Pitfalls:** Common mistakes, rewrite causes, hidden complexity
|
|
510
|
-
|
|
511
|
-
## Step 3: Execute Research
|
|
512
|
-
|
|
513
|
-
For each domain: Context7 → Official Docs → WebSearch → Verify. Document with confidence levels.
|
|
514
|
-
|
|
515
|
-
## Step 4: Quality Check
|
|
516
|
-
|
|
517
|
-
Run pre-submission checklist (see verification_protocol).
|
|
518
|
-
|
|
519
|
-
## Step 5: Write Output Files
|
|
520
|
-
|
|
521
|
-
In `.planning/research/`:
|
|
522
|
-
1. **SUMMARY.md** — Always
|
|
523
|
-
2. **STACK.md** — Always
|
|
524
|
-
3. **FEATURES.md** — Always
|
|
525
|
-
4. **ARCHITECTURE.md** — If patterns discovered
|
|
526
|
-
5. **PITFALLS.md** — Always
|
|
527
|
-
6. **COMPARISON.md** — If comparison mode
|
|
528
|
-
7. **FEASIBILITY.md** — If feasibility mode
|
|
529
|
-
|
|
530
|
-
## Step 6: Return Structured Result
|
|
531
|
-
|
|
532
|
-
**DO NOT commit.** Spawned in parallel with other researchers. Orchestrator commits after all complete.
|
|
106
|
+
1. **Receive scope** — Parse project name/description, research mode, specific questions from orchestrator.
|
|
107
|
+
2. **Identify domains** — Technology, features, architecture, pitfalls.
|
|
108
|
+
3. **Execute research** — For each domain: Context7 → Official Docs → WebSearch → Verify. Document with confidence levels.
|
|
109
|
+
4. **Quality check** — Run pre-submission checklist.
|
|
110
|
+
5. **Write output files** to `.planning/research/`: SUMMARY.md, STACK.md, FEATURES.md, ARCHITECTURE.md (if patterns discovered), PITFALLS.md, plus COMPARISON.md or FEASIBILITY.md if applicable.
|
|
111
|
+
6. **Return structured result** — DO NOT commit. Orchestrator commits after all researchers complete.
|
|
533
112
|
|
|
534
113
|
</execution_flow>
|
|
535
114
|
|
|
@@ -545,11 +124,9 @@ In `.planning/research/`:
|
|
|
545
124
|
**Confidence:** [HIGH/MEDIUM/LOW]
|
|
546
125
|
|
|
547
126
|
### Key Findings
|
|
548
|
-
|
|
549
127
|
[3-5 bullet points of most important discoveries]
|
|
550
128
|
|
|
551
129
|
### Files Created
|
|
552
|
-
|
|
553
130
|
| File | Purpose |
|
|
554
131
|
|------|---------|
|
|
555
132
|
| .planning/research/SUMMARY.md | Executive summary with roadmap implications |
|
|
@@ -559,21 +136,14 @@ In `.planning/research/`:
|
|
|
559
136
|
| .planning/research/PITFALLS.md | Domain pitfalls |
|
|
560
137
|
|
|
561
138
|
### Confidence Assessment
|
|
562
|
-
|
|
563
139
|
| Area | Level | Reason |
|
|
564
140
|
|------|-------|--------|
|
|
565
|
-
| Stack | [level] | [why] |
|
|
566
|
-
| Features | [level] | [why] |
|
|
567
|
-
| Architecture | [level] | [why] |
|
|
568
|
-
| Pitfalls | [level] | [why] |
|
|
569
141
|
|
|
570
142
|
### Roadmap Implications
|
|
571
|
-
|
|
572
143
|
[Key recommendations for phase structure]
|
|
573
144
|
|
|
574
145
|
### Open Questions
|
|
575
|
-
|
|
576
|
-
[Gaps that couldn't be resolved, need phase-specific research later]
|
|
146
|
+
[Gaps that couldn't be resolved]
|
|
577
147
|
```
|
|
578
148
|
|
|
579
149
|
## Research Blocked
|
|
@@ -585,17 +155,11 @@ In `.planning/research/`:
|
|
|
585
155
|
**Blocked by:** [what's preventing progress]
|
|
586
156
|
|
|
587
157
|
### Attempted
|
|
588
|
-
|
|
589
158
|
[What was tried]
|
|
590
159
|
|
|
591
160
|
### Options
|
|
592
|
-
|
|
593
161
|
1. [Option to resolve]
|
|
594
162
|
2. [Alternative approach]
|
|
595
|
-
|
|
596
|
-
### Awaiting
|
|
597
|
-
|
|
598
|
-
[What's needed to continue]
|
|
599
163
|
```
|
|
600
164
|
|
|
601
165
|
</structured_returns>
|
|
@@ -603,19 +167,15 @@ In `.planning/research/`:
|
|
|
603
167
|
<success_criteria>
|
|
604
168
|
|
|
605
169
|
Research is complete when:
|
|
606
|
-
|
|
607
|
-
- [ ] Domain ecosystem surveyed
|
|
170
|
+
- [ ] Domain ecosystem surveyed with confidence levels
|
|
608
171
|
- [ ] Technology stack recommended with rationale
|
|
609
172
|
- [ ] Feature landscape mapped (table stakes, differentiators, anti-features)
|
|
610
173
|
- [ ] Architecture patterns documented
|
|
611
174
|
- [ ] Domain pitfalls catalogued
|
|
612
175
|
- [ ] Source hierarchy followed (Context7 → Official → WebSearch)
|
|
613
|
-
- [ ] All findings have confidence levels
|
|
614
176
|
- [ ] Output files created in `.planning/research/`
|
|
615
177
|
- [ ] SUMMARY.md includes roadmap implications
|
|
616
178
|
- [ ] Files written (DO NOT commit — orchestrator handles this)
|
|
617
179
|
- [ ] Structured return provided to orchestrator
|
|
618
180
|
|
|
619
|
-
**Quality:** Comprehensive not shallow. Opinionated not wishy-washy. Verified not assumed. Honest about gaps. Actionable for roadmap. Current (year in searches).
|
|
620
|
-
|
|
621
181
|
</success_criteria>
|