mindsystem-cc 3.0.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 +501 -0
- package/agents/ms-codebase-mapper.md +739 -0
- package/agents/ms-debugger.md +1184 -0
- package/agents/ms-designer.md +414 -0
- package/agents/ms-executor.md +760 -0
- package/agents/ms-integration-checker.md +423 -0
- package/agents/ms-milestone-auditor.md +448 -0
- package/agents/ms-mock-generator.md +182 -0
- package/agents/ms-plan-checker.md +746 -0
- package/agents/ms-research-synthesizer.md +248 -0
- package/agents/ms-researcher.md +962 -0
- package/agents/ms-roadmapper.md +606 -0
- package/agents/ms-verifier.md +779 -0
- package/agents/ms-verify-fixer.md +124 -0
- package/bin/install.js +296 -0
- package/commands/ms/add-phase.md +207 -0
- package/commands/ms/add-todo.md +182 -0
- package/commands/ms/audit-milestone.md +318 -0
- package/commands/ms/check-phase.md +162 -0
- package/commands/ms/check-todos.md +217 -0
- package/commands/ms/complete-milestone.md +137 -0
- package/commands/ms/create-roadmap.md +273 -0
- package/commands/ms/debug.md +149 -0
- package/commands/ms/define-requirements.md +121 -0
- package/commands/ms/design-phase.md +341 -0
- package/commands/ms/discuss-milestone.md +48 -0
- package/commands/ms/discuss-phase.md +60 -0
- package/commands/ms/do-work.md +90 -0
- package/commands/ms/execute-phase.md +289 -0
- package/commands/ms/help.md +623 -0
- package/commands/ms/insert-phase.md +227 -0
- package/commands/ms/list-phase-assumptions.md +50 -0
- package/commands/ms/map-codebase.md +71 -0
- package/commands/ms/new-milestone.md +193 -0
- package/commands/ms/new-project.md +338 -0
- package/commands/ms/pause-work.md +123 -0
- package/commands/ms/plan-milestone-gaps.md +285 -0
- package/commands/ms/plan-phase.md +105 -0
- package/commands/ms/progress.md +370 -0
- package/commands/ms/remove-phase.md +338 -0
- package/commands/ms/research-phase.md +175 -0
- package/commands/ms/research-project.md +339 -0
- package/commands/ms/resume-work.md +40 -0
- package/commands/ms/review-design.md +484 -0
- package/commands/ms/simplify-flutter.md +193 -0
- package/commands/ms/update.md +159 -0
- package/commands/ms/verify-work.md +92 -0
- package/commands/ms/whats-new.md +124 -0
- package/mindsystem/references/checkpoints.md +788 -0
- package/mindsystem/references/continuation-format.md +255 -0
- package/mindsystem/references/debugging/debugging-mindset.md +11 -0
- package/mindsystem/references/debugging/hypothesis-testing.md +11 -0
- package/mindsystem/references/debugging/investigation-techniques.md +11 -0
- package/mindsystem/references/debugging/verification-patterns.md +11 -0
- package/mindsystem/references/debugging/when-to-research.md +11 -0
- package/mindsystem/references/git-integration.md +254 -0
- package/mindsystem/references/goal-backward.md +286 -0
- package/mindsystem/references/mock-patterns.md +294 -0
- package/mindsystem/references/plan-format.md +473 -0
- package/mindsystem/references/principles.md +73 -0
- package/mindsystem/references/questioning.md +140 -0
- package/mindsystem/references/research-pitfalls.md +233 -0
- package/mindsystem/references/scope-estimation.md +256 -0
- package/mindsystem/references/tdd.md +263 -0
- package/mindsystem/references/verification-patterns.md +595 -0
- package/mindsystem/templates/DEBUG.md +159 -0
- package/mindsystem/templates/UAT.md +403 -0
- package/mindsystem/templates/adhoc-summary.md +153 -0
- package/mindsystem/templates/codebase/architecture.md +255 -0
- package/mindsystem/templates/codebase/concerns.md +310 -0
- package/mindsystem/templates/codebase/conventions.md +307 -0
- package/mindsystem/templates/codebase/integrations.md +280 -0
- package/mindsystem/templates/codebase/stack.md +186 -0
- package/mindsystem/templates/codebase/structure.md +285 -0
- package/mindsystem/templates/codebase/testing.md +480 -0
- package/mindsystem/templates/config.json +26 -0
- package/mindsystem/templates/context.md +140 -0
- package/mindsystem/templates/continue-here.md +78 -0
- package/mindsystem/templates/debug-subagent-prompt.md +91 -0
- package/mindsystem/templates/design-iteration.md +208 -0
- package/mindsystem/templates/design.md +417 -0
- package/mindsystem/templates/discovery.md +146 -0
- package/mindsystem/templates/milestone-archive.md +123 -0
- package/mindsystem/templates/milestone-context.md +93 -0
- package/mindsystem/templates/milestone.md +115 -0
- package/mindsystem/templates/phase-prompt.md +574 -0
- package/mindsystem/templates/project.md +184 -0
- package/mindsystem/templates/requirements.md +231 -0
- package/mindsystem/templates/research-project/ARCHITECTURE.md +204 -0
- package/mindsystem/templates/research-project/FEATURES.md +147 -0
- package/mindsystem/templates/research-project/PITFALLS.md +200 -0
- package/mindsystem/templates/research-project/STACK.md +120 -0
- package/mindsystem/templates/research-project/SUMMARY.md +170 -0
- package/mindsystem/templates/research-subagent-prompt.md +92 -0
- package/mindsystem/templates/research.md +529 -0
- package/mindsystem/templates/roadmap.md +214 -0
- package/mindsystem/templates/state.md +224 -0
- package/mindsystem/templates/summary.md +269 -0
- package/mindsystem/templates/user-setup.md +323 -0
- package/mindsystem/templates/verification-report.md +322 -0
- package/mindsystem/workflows/complete-milestone.md +759 -0
- package/mindsystem/workflows/create-milestone.md +203 -0
- package/mindsystem/workflows/debug.md +14 -0
- package/mindsystem/workflows/define-requirements.md +330 -0
- package/mindsystem/workflows/diagnose-issues.md +241 -0
- package/mindsystem/workflows/discovery-phase.md +293 -0
- package/mindsystem/workflows/discuss-milestone.md +310 -0
- package/mindsystem/workflows/discuss-phase.md +237 -0
- package/mindsystem/workflows/do-work.md +359 -0
- package/mindsystem/workflows/execute-phase.md +644 -0
- package/mindsystem/workflows/execute-plan.md +1828 -0
- package/mindsystem/workflows/generate-mocks.md +187 -0
- package/mindsystem/workflows/list-phase-assumptions.md +178 -0
- package/mindsystem/workflows/map-codebase.md +289 -0
- package/mindsystem/workflows/plan-phase.md +876 -0
- package/mindsystem/workflows/research-phase.md +17 -0
- package/mindsystem/workflows/research-project.md +23 -0
- package/mindsystem/workflows/resume-project.md +311 -0
- package/mindsystem/workflows/transition.md +564 -0
- package/mindsystem/workflows/verify-phase.md +629 -0
- package/mindsystem/workflows/verify-work.md +823 -0
- package/package.json +32 -0
- package/scripts/generate-phase-patch.sh +169 -0
- package/scripts/ms-lookup/README.md +112 -0
- package/scripts/ms-lookup/ms_lookup/__init__.py +3 -0
- package/scripts/ms-lookup/ms_lookup/__main__.py +6 -0
- package/scripts/ms-lookup/ms_lookup/backends/__init__.py +6 -0
- package/scripts/ms-lookup/ms_lookup/backends/context7.py +219 -0
- package/scripts/ms-lookup/ms_lookup/backends/perplexity.py +145 -0
- package/scripts/ms-lookup/ms_lookup/cache.py +48 -0
- package/scripts/ms-lookup/ms_lookup/cli.py +219 -0
- package/scripts/ms-lookup/ms_lookup/config.py +23 -0
- package/scripts/ms-lookup/ms_lookup/errors.py +24 -0
- package/scripts/ms-lookup/ms_lookup/output.py +49 -0
- package/scripts/ms-lookup/ms_lookup/tokens.py +56 -0
- package/scripts/ms-lookup/pyproject.toml +17 -0
- package/scripts/ms-lookup/uv.lock +207 -0
- package/scripts/ms-lookup-wrapper.sh +21 -0
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
# Features Research Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/research/FEATURES.md` — feature landscape for the project domain.
|
|
4
|
+
|
|
5
|
+
<template>
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
# Feature Research
|
|
9
|
+
|
|
10
|
+
**Domain:** [domain type]
|
|
11
|
+
**Researched:** [date]
|
|
12
|
+
**Confidence:** [HIGH/MEDIUM/LOW]
|
|
13
|
+
|
|
14
|
+
## Feature Landscape
|
|
15
|
+
|
|
16
|
+
### Table Stakes (Users Expect These)
|
|
17
|
+
|
|
18
|
+
Features users assume exist. Missing these = product feels incomplete.
|
|
19
|
+
|
|
20
|
+
| Feature | Why Expected | Complexity | Notes |
|
|
21
|
+
|---------|--------------|------------|-------|
|
|
22
|
+
| [feature] | [user expectation] | LOW/MEDIUM/HIGH | [implementation notes] |
|
|
23
|
+
| [feature] | [user expectation] | LOW/MEDIUM/HIGH | [implementation notes] |
|
|
24
|
+
| [feature] | [user expectation] | LOW/MEDIUM/HIGH | [implementation notes] |
|
|
25
|
+
|
|
26
|
+
### Differentiators (Competitive Advantage)
|
|
27
|
+
|
|
28
|
+
Features that set the product apart. Not required, but valuable.
|
|
29
|
+
|
|
30
|
+
| Feature | Value Proposition | Complexity | Notes |
|
|
31
|
+
|---------|-------------------|------------|-------|
|
|
32
|
+
| [feature] | [why it matters] | LOW/MEDIUM/HIGH | [implementation notes] |
|
|
33
|
+
| [feature] | [why it matters] | LOW/MEDIUM/HIGH | [implementation notes] |
|
|
34
|
+
| [feature] | [why it matters] | LOW/MEDIUM/HIGH | [implementation notes] |
|
|
35
|
+
|
|
36
|
+
### Anti-Features (Commonly Requested, Often Problematic)
|
|
37
|
+
|
|
38
|
+
Features that seem good but create problems.
|
|
39
|
+
|
|
40
|
+
| Feature | Why Requested | Why Problematic | Alternative |
|
|
41
|
+
|---------|---------------|-----------------|-------------|
|
|
42
|
+
| [feature] | [surface appeal] | [actual problems] | [better approach] |
|
|
43
|
+
| [feature] | [surface appeal] | [actual problems] | [better approach] |
|
|
44
|
+
|
|
45
|
+
## Feature Dependencies
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
[Feature A]
|
|
49
|
+
└──requires──> [Feature B]
|
|
50
|
+
└──requires──> [Feature C]
|
|
51
|
+
|
|
52
|
+
[Feature D] ──enhances──> [Feature A]
|
|
53
|
+
|
|
54
|
+
[Feature E] ──conflicts──> [Feature F]
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Dependency Notes
|
|
58
|
+
|
|
59
|
+
- **[Feature A] requires [Feature B]:** [why the dependency exists]
|
|
60
|
+
- **[Feature D] enhances [Feature A]:** [how they work together]
|
|
61
|
+
- **[Feature E] conflicts with [Feature F]:** [why they're incompatible]
|
|
62
|
+
|
|
63
|
+
## MVP Definition
|
|
64
|
+
|
|
65
|
+
### Launch With (v1)
|
|
66
|
+
|
|
67
|
+
Minimum viable product — what's needed to validate the concept.
|
|
68
|
+
|
|
69
|
+
- [ ] [Feature] — [why essential]
|
|
70
|
+
- [ ] [Feature] — [why essential]
|
|
71
|
+
- [ ] [Feature] — [why essential]
|
|
72
|
+
|
|
73
|
+
### Add After Validation (v1.x)
|
|
74
|
+
|
|
75
|
+
Features to add once core is working.
|
|
76
|
+
|
|
77
|
+
- [ ] [Feature] — [trigger for adding]
|
|
78
|
+
- [ ] [Feature] — [trigger for adding]
|
|
79
|
+
|
|
80
|
+
### Future Consideration (v2+)
|
|
81
|
+
|
|
82
|
+
Features to defer until product-market fit is established.
|
|
83
|
+
|
|
84
|
+
- [ ] [Feature] — [why defer]
|
|
85
|
+
- [ ] [Feature] — [why defer]
|
|
86
|
+
|
|
87
|
+
## Feature Prioritization Matrix
|
|
88
|
+
|
|
89
|
+
| Feature | User Value | Implementation Cost | Priority |
|
|
90
|
+
|---------|------------|---------------------|----------|
|
|
91
|
+
| [feature] | HIGH/MEDIUM/LOW | HIGH/MEDIUM/LOW | P1/P2/P3 |
|
|
92
|
+
| [feature] | HIGH/MEDIUM/LOW | HIGH/MEDIUM/LOW | P1/P2/P3 |
|
|
93
|
+
| [feature] | HIGH/MEDIUM/LOW | HIGH/MEDIUM/LOW | P1/P2/P3 |
|
|
94
|
+
|
|
95
|
+
**Priority key:**
|
|
96
|
+
- P1: Must have for launch
|
|
97
|
+
- P2: Should have, add when possible
|
|
98
|
+
- P3: Nice to have, future consideration
|
|
99
|
+
|
|
100
|
+
## Competitor Feature Analysis
|
|
101
|
+
|
|
102
|
+
| Feature | Competitor A | Competitor B | Our Approach |
|
|
103
|
+
|---------|--------------|--------------|--------------|
|
|
104
|
+
| [feature] | [how they do it] | [how they do it] | [our plan] |
|
|
105
|
+
| [feature] | [how they do it] | [how they do it] | [our plan] |
|
|
106
|
+
|
|
107
|
+
## Sources
|
|
108
|
+
|
|
109
|
+
- [Competitor products analyzed]
|
|
110
|
+
- [User research or feedback sources]
|
|
111
|
+
- [Industry standards referenced]
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
*Feature research for: [domain]*
|
|
115
|
+
*Researched: [date]*
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
</template>
|
|
119
|
+
|
|
120
|
+
<guidelines>
|
|
121
|
+
|
|
122
|
+
**Table Stakes:**
|
|
123
|
+
- These are non-negotiable for launch
|
|
124
|
+
- Users don't give credit for having them, but penalize for missing them
|
|
125
|
+
- Example: A community platform without user profiles is broken
|
|
126
|
+
|
|
127
|
+
**Differentiators:**
|
|
128
|
+
- These are where you compete
|
|
129
|
+
- Should align with the Core Value from PROJECT.md
|
|
130
|
+
- Don't try to differentiate on everything
|
|
131
|
+
|
|
132
|
+
**Anti-Features:**
|
|
133
|
+
- Prevent scope creep by documenting what seems good but isn't
|
|
134
|
+
- Include the alternative approach
|
|
135
|
+
- Example: "Real-time everything" often creates complexity without value
|
|
136
|
+
|
|
137
|
+
**Feature Dependencies:**
|
|
138
|
+
- Critical for roadmap phase ordering
|
|
139
|
+
- If A requires B, B must be in an earlier phase
|
|
140
|
+
- Conflicts inform what NOT to combine in same phase
|
|
141
|
+
|
|
142
|
+
**MVP Definition:**
|
|
143
|
+
- Be ruthless about what's truly minimum
|
|
144
|
+
- "Nice to have" is not MVP
|
|
145
|
+
- Launch with less, validate, then expand
|
|
146
|
+
|
|
147
|
+
</guidelines>
|
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
# Pitfalls Research Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/research/PITFALLS.md` — common mistakes to avoid in the project domain.
|
|
4
|
+
|
|
5
|
+
<template>
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
# Pitfalls Research
|
|
9
|
+
|
|
10
|
+
**Domain:** [domain type]
|
|
11
|
+
**Researched:** [date]
|
|
12
|
+
**Confidence:** [HIGH/MEDIUM/LOW]
|
|
13
|
+
|
|
14
|
+
## Critical Pitfalls
|
|
15
|
+
|
|
16
|
+
### Pitfall 1: [Name]
|
|
17
|
+
|
|
18
|
+
**What goes wrong:**
|
|
19
|
+
[Description of the failure mode]
|
|
20
|
+
|
|
21
|
+
**Why it happens:**
|
|
22
|
+
[Root cause — why developers make this mistake]
|
|
23
|
+
|
|
24
|
+
**How to avoid:**
|
|
25
|
+
[Specific prevention strategy]
|
|
26
|
+
|
|
27
|
+
**Warning signs:**
|
|
28
|
+
[How to detect this early before it becomes a problem]
|
|
29
|
+
|
|
30
|
+
**Phase to address:**
|
|
31
|
+
[Which roadmap phase should prevent this]
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
### Pitfall 2: [Name]
|
|
36
|
+
|
|
37
|
+
**What goes wrong:**
|
|
38
|
+
[Description of the failure mode]
|
|
39
|
+
|
|
40
|
+
**Why it happens:**
|
|
41
|
+
[Root cause — why developers make this mistake]
|
|
42
|
+
|
|
43
|
+
**How to avoid:**
|
|
44
|
+
[Specific prevention strategy]
|
|
45
|
+
|
|
46
|
+
**Warning signs:**
|
|
47
|
+
[How to detect this early before it becomes a problem]
|
|
48
|
+
|
|
49
|
+
**Phase to address:**
|
|
50
|
+
[Which roadmap phase should prevent this]
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
### Pitfall 3: [Name]
|
|
55
|
+
|
|
56
|
+
**What goes wrong:**
|
|
57
|
+
[Description of the failure mode]
|
|
58
|
+
|
|
59
|
+
**Why it happens:**
|
|
60
|
+
[Root cause — why developers make this mistake]
|
|
61
|
+
|
|
62
|
+
**How to avoid:**
|
|
63
|
+
[Specific prevention strategy]
|
|
64
|
+
|
|
65
|
+
**Warning signs:**
|
|
66
|
+
[How to detect this early before it becomes a problem]
|
|
67
|
+
|
|
68
|
+
**Phase to address:**
|
|
69
|
+
[Which roadmap phase should prevent this]
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
[Continue for all critical pitfalls...]
|
|
74
|
+
|
|
75
|
+
## Technical Debt Patterns
|
|
76
|
+
|
|
77
|
+
Shortcuts that seem reasonable but create long-term problems.
|
|
78
|
+
|
|
79
|
+
| Shortcut | Immediate Benefit | Long-term Cost | When Acceptable |
|
|
80
|
+
|----------|-------------------|----------------|-----------------|
|
|
81
|
+
| [shortcut] | [benefit] | [cost] | [conditions, or "never"] |
|
|
82
|
+
| [shortcut] | [benefit] | [cost] | [conditions, or "never"] |
|
|
83
|
+
| [shortcut] | [benefit] | [cost] | [conditions, or "never"] |
|
|
84
|
+
|
|
85
|
+
## Integration Gotchas
|
|
86
|
+
|
|
87
|
+
Common mistakes when connecting to external services.
|
|
88
|
+
|
|
89
|
+
| Integration | Common Mistake | Correct Approach |
|
|
90
|
+
|-------------|----------------|------------------|
|
|
91
|
+
| [service] | [what people do wrong] | [what to do instead] |
|
|
92
|
+
| [service] | [what people do wrong] | [what to do instead] |
|
|
93
|
+
| [service] | [what people do wrong] | [what to do instead] |
|
|
94
|
+
|
|
95
|
+
## Performance Traps
|
|
96
|
+
|
|
97
|
+
Patterns that work at small scale but fail as usage grows.
|
|
98
|
+
|
|
99
|
+
| Trap | Symptoms | Prevention | When It Breaks |
|
|
100
|
+
|------|----------|------------|----------------|
|
|
101
|
+
| [trap] | [how you notice] | [how to avoid] | [scale threshold] |
|
|
102
|
+
| [trap] | [how you notice] | [how to avoid] | [scale threshold] |
|
|
103
|
+
| [trap] | [how you notice] | [how to avoid] | [scale threshold] |
|
|
104
|
+
|
|
105
|
+
## Security Mistakes
|
|
106
|
+
|
|
107
|
+
Domain-specific security issues beyond general web security.
|
|
108
|
+
|
|
109
|
+
| Mistake | Risk | Prevention |
|
|
110
|
+
|---------|------|------------|
|
|
111
|
+
| [mistake] | [what could happen] | [how to avoid] |
|
|
112
|
+
| [mistake] | [what could happen] | [how to avoid] |
|
|
113
|
+
| [mistake] | [what could happen] | [how to avoid] |
|
|
114
|
+
|
|
115
|
+
## UX Pitfalls
|
|
116
|
+
|
|
117
|
+
Common user experience mistakes in this domain.
|
|
118
|
+
|
|
119
|
+
| Pitfall | User Impact | Better Approach |
|
|
120
|
+
|---------|-------------|-----------------|
|
|
121
|
+
| [pitfall] | [how users suffer] | [what to do instead] |
|
|
122
|
+
| [pitfall] | [how users suffer] | [what to do instead] |
|
|
123
|
+
| [pitfall] | [how users suffer] | [what to do instead] |
|
|
124
|
+
|
|
125
|
+
## "Looks Done But Isn't" Checklist
|
|
126
|
+
|
|
127
|
+
Things that appear complete but are missing critical pieces.
|
|
128
|
+
|
|
129
|
+
- [ ] **[Feature]:** Often missing [thing] — verify [check]
|
|
130
|
+
- [ ] **[Feature]:** Often missing [thing] — verify [check]
|
|
131
|
+
- [ ] **[Feature]:** Often missing [thing] — verify [check]
|
|
132
|
+
- [ ] **[Feature]:** Often missing [thing] — verify [check]
|
|
133
|
+
|
|
134
|
+
## Recovery Strategies
|
|
135
|
+
|
|
136
|
+
When pitfalls occur despite prevention, how to recover.
|
|
137
|
+
|
|
138
|
+
| Pitfall | Recovery Cost | Recovery Steps |
|
|
139
|
+
|---------|---------------|----------------|
|
|
140
|
+
| [pitfall] | LOW/MEDIUM/HIGH | [what to do] |
|
|
141
|
+
| [pitfall] | LOW/MEDIUM/HIGH | [what to do] |
|
|
142
|
+
| [pitfall] | LOW/MEDIUM/HIGH | [what to do] |
|
|
143
|
+
|
|
144
|
+
## Pitfall-to-Phase Mapping
|
|
145
|
+
|
|
146
|
+
How roadmap phases should address these pitfalls.
|
|
147
|
+
|
|
148
|
+
| Pitfall | Prevention Phase | Verification |
|
|
149
|
+
|---------|------------------|--------------|
|
|
150
|
+
| [pitfall] | Phase [X] | [how to verify prevention worked] |
|
|
151
|
+
| [pitfall] | Phase [X] | [how to verify prevention worked] |
|
|
152
|
+
| [pitfall] | Phase [X] | [how to verify prevention worked] |
|
|
153
|
+
|
|
154
|
+
## Sources
|
|
155
|
+
|
|
156
|
+
- [Post-mortems referenced]
|
|
157
|
+
- [Community discussions]
|
|
158
|
+
- [Official "gotchas" documentation]
|
|
159
|
+
- [Personal experience / known issues]
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
*Pitfalls research for: [domain]*
|
|
163
|
+
*Researched: [date]*
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
</template>
|
|
167
|
+
|
|
168
|
+
<guidelines>
|
|
169
|
+
|
|
170
|
+
**Critical Pitfalls:**
|
|
171
|
+
- Focus on domain-specific issues, not generic mistakes
|
|
172
|
+
- Include warning signs — early detection prevents disasters
|
|
173
|
+
- Link to specific phases — makes pitfalls actionable
|
|
174
|
+
|
|
175
|
+
**Technical Debt:**
|
|
176
|
+
- Be realistic — some shortcuts are acceptable
|
|
177
|
+
- Note when shortcuts are "never acceptable" vs. "only in MVP"
|
|
178
|
+
- Include the long-term cost to inform tradeoff decisions
|
|
179
|
+
|
|
180
|
+
**Performance Traps:**
|
|
181
|
+
- Include scale thresholds ("breaks at 10k users")
|
|
182
|
+
- Focus on what's relevant for this project's expected scale
|
|
183
|
+
- Don't over-engineer for hypothetical scale
|
|
184
|
+
|
|
185
|
+
**Security Mistakes:**
|
|
186
|
+
- Beyond OWASP basics — domain-specific issues
|
|
187
|
+
- Example: Community platforms have different security concerns than e-commerce
|
|
188
|
+
- Include risk level to prioritize
|
|
189
|
+
|
|
190
|
+
**"Looks Done But Isn't":**
|
|
191
|
+
- Checklist format for verification during execution
|
|
192
|
+
- Common in demos vs. production
|
|
193
|
+
- Prevents "it works on my machine" issues
|
|
194
|
+
|
|
195
|
+
**Pitfall-to-Phase Mapping:**
|
|
196
|
+
- Critical for roadmap creation
|
|
197
|
+
- Each pitfall should map to a phase that prevents it
|
|
198
|
+
- Informs phase ordering and success criteria
|
|
199
|
+
|
|
200
|
+
</guidelines>
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# Stack Research Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/research/STACK.md` — recommended technologies for the project domain.
|
|
4
|
+
|
|
5
|
+
<template>
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
# Stack Research
|
|
9
|
+
|
|
10
|
+
**Domain:** [domain type]
|
|
11
|
+
**Researched:** [date]
|
|
12
|
+
**Confidence:** [HIGH/MEDIUM/LOW]
|
|
13
|
+
|
|
14
|
+
## Recommended Stack
|
|
15
|
+
|
|
16
|
+
### Core Technologies
|
|
17
|
+
|
|
18
|
+
| Technology | Version | Purpose | Why Recommended |
|
|
19
|
+
|------------|---------|---------|-----------------|
|
|
20
|
+
| [name] | [version] | [what it does] | [why experts use it for this domain] |
|
|
21
|
+
| [name] | [version] | [what it does] | [why experts use it for this domain] |
|
|
22
|
+
| [name] | [version] | [what it does] | [why experts use it for this domain] |
|
|
23
|
+
|
|
24
|
+
### Supporting Libraries
|
|
25
|
+
|
|
26
|
+
| Library | Version | Purpose | When to Use |
|
|
27
|
+
|---------|---------|---------|-------------|
|
|
28
|
+
| [name] | [version] | [what it does] | [specific use case] |
|
|
29
|
+
| [name] | [version] | [what it does] | [specific use case] |
|
|
30
|
+
| [name] | [version] | [what it does] | [specific use case] |
|
|
31
|
+
|
|
32
|
+
### Development Tools
|
|
33
|
+
|
|
34
|
+
| Tool | Purpose | Notes |
|
|
35
|
+
|------|---------|-------|
|
|
36
|
+
| [name] | [what it does] | [configuration tips] |
|
|
37
|
+
| [name] | [what it does] | [configuration tips] |
|
|
38
|
+
|
|
39
|
+
## Installation
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
# Core
|
|
43
|
+
npm install [packages]
|
|
44
|
+
|
|
45
|
+
# Supporting
|
|
46
|
+
npm install [packages]
|
|
47
|
+
|
|
48
|
+
# Dev dependencies
|
|
49
|
+
npm install -D [packages]
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Alternatives Considered
|
|
53
|
+
|
|
54
|
+
| Recommended | Alternative | When to Use Alternative |
|
|
55
|
+
|-------------|-------------|-------------------------|
|
|
56
|
+
| [our choice] | [other option] | [conditions where alternative is better] |
|
|
57
|
+
| [our choice] | [other option] | [conditions where alternative is better] |
|
|
58
|
+
|
|
59
|
+
## What NOT to Use
|
|
60
|
+
|
|
61
|
+
| Avoid | Why | Use Instead |
|
|
62
|
+
|-------|-----|-------------|
|
|
63
|
+
| [technology] | [specific problem] | [recommended alternative] |
|
|
64
|
+
| [technology] | [specific problem] | [recommended alternative] |
|
|
65
|
+
|
|
66
|
+
## Stack Patterns by Variant
|
|
67
|
+
|
|
68
|
+
**If [condition]:**
|
|
69
|
+
- Use [variation]
|
|
70
|
+
- Because [reason]
|
|
71
|
+
|
|
72
|
+
**If [condition]:**
|
|
73
|
+
- Use [variation]
|
|
74
|
+
- Because [reason]
|
|
75
|
+
|
|
76
|
+
## Version Compatibility
|
|
77
|
+
|
|
78
|
+
| Package A | Compatible With | Notes |
|
|
79
|
+
|-----------|-----------------|-------|
|
|
80
|
+
| [package@version] | [package@version] | [compatibility notes] |
|
|
81
|
+
|
|
82
|
+
## Sources
|
|
83
|
+
|
|
84
|
+
- [Context7 library ID] — [topics fetched]
|
|
85
|
+
- [Official docs URL] — [what was verified]
|
|
86
|
+
- [Other source] — [confidence level]
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
*Stack research for: [domain]*
|
|
90
|
+
*Researched: [date]*
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
</template>
|
|
94
|
+
|
|
95
|
+
<guidelines>
|
|
96
|
+
|
|
97
|
+
**Core Technologies:**
|
|
98
|
+
- Include specific version numbers
|
|
99
|
+
- Explain why this is the standard choice, not just what it does
|
|
100
|
+
- Focus on technologies that affect architecture decisions
|
|
101
|
+
|
|
102
|
+
**Supporting Libraries:**
|
|
103
|
+
- Include libraries commonly needed for this domain
|
|
104
|
+
- Note when each is needed (not all projects need all libraries)
|
|
105
|
+
|
|
106
|
+
**Alternatives:**
|
|
107
|
+
- Don't just dismiss alternatives
|
|
108
|
+
- Explain when alternatives make sense
|
|
109
|
+
- Helps user make informed decisions if they disagree
|
|
110
|
+
|
|
111
|
+
**What NOT to Use:**
|
|
112
|
+
- Actively warn against outdated or problematic choices
|
|
113
|
+
- Explain the specific problem, not just "it's old"
|
|
114
|
+
- Provide the recommended alternative
|
|
115
|
+
|
|
116
|
+
**Version Compatibility:**
|
|
117
|
+
- Note any known compatibility issues
|
|
118
|
+
- Critical for avoiding debugging time later
|
|
119
|
+
|
|
120
|
+
</guidelines>
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# Research Summary Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/research/SUMMARY.md` — executive summary of project research with roadmap implications.
|
|
4
|
+
|
|
5
|
+
<template>
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
# Project Research Summary
|
|
9
|
+
|
|
10
|
+
**Project:** [name from PROJECT.md]
|
|
11
|
+
**Domain:** [inferred domain type]
|
|
12
|
+
**Researched:** [date]
|
|
13
|
+
**Confidence:** [HIGH/MEDIUM/LOW]
|
|
14
|
+
|
|
15
|
+
## Executive Summary
|
|
16
|
+
|
|
17
|
+
[2-3 paragraph overview of research findings]
|
|
18
|
+
|
|
19
|
+
- What type of product this is and how experts build it
|
|
20
|
+
- The recommended approach based on research
|
|
21
|
+
- Key risks and how to mitigate them
|
|
22
|
+
|
|
23
|
+
## Key Findings
|
|
24
|
+
|
|
25
|
+
### Recommended Stack
|
|
26
|
+
|
|
27
|
+
[Summary from STACK.md — 1-2 paragraphs]
|
|
28
|
+
|
|
29
|
+
**Core technologies:**
|
|
30
|
+
- [Technology]: [purpose] — [why recommended]
|
|
31
|
+
- [Technology]: [purpose] — [why recommended]
|
|
32
|
+
- [Technology]: [purpose] — [why recommended]
|
|
33
|
+
|
|
34
|
+
### Expected Features
|
|
35
|
+
|
|
36
|
+
[Summary from FEATURES.md]
|
|
37
|
+
|
|
38
|
+
**Must have (table stakes):**
|
|
39
|
+
- [Feature] — users expect this
|
|
40
|
+
- [Feature] — users expect this
|
|
41
|
+
|
|
42
|
+
**Should have (competitive):**
|
|
43
|
+
- [Feature] — differentiator
|
|
44
|
+
- [Feature] — differentiator
|
|
45
|
+
|
|
46
|
+
**Defer (v2+):**
|
|
47
|
+
- [Feature] — not essential for launch
|
|
48
|
+
|
|
49
|
+
### Architecture Approach
|
|
50
|
+
|
|
51
|
+
[Summary from ARCHITECTURE.md — 1 paragraph]
|
|
52
|
+
|
|
53
|
+
**Major components:**
|
|
54
|
+
1. [Component] — [responsibility]
|
|
55
|
+
2. [Component] — [responsibility]
|
|
56
|
+
3. [Component] — [responsibility]
|
|
57
|
+
|
|
58
|
+
### Critical Pitfalls
|
|
59
|
+
|
|
60
|
+
[Top 3-5 from PITFALLS.md]
|
|
61
|
+
|
|
62
|
+
1. **[Pitfall]** — [how to avoid]
|
|
63
|
+
2. **[Pitfall]** — [how to avoid]
|
|
64
|
+
3. **[Pitfall]** — [how to avoid]
|
|
65
|
+
|
|
66
|
+
## Implications for Roadmap
|
|
67
|
+
|
|
68
|
+
Based on research, suggested phase structure:
|
|
69
|
+
|
|
70
|
+
### Phase 1: [Name]
|
|
71
|
+
**Rationale:** [why this comes first based on research]
|
|
72
|
+
**Delivers:** [what this phase produces]
|
|
73
|
+
**Addresses:** [features from FEATURES.md]
|
|
74
|
+
**Avoids:** [pitfall from PITFALLS.md]
|
|
75
|
+
|
|
76
|
+
### Phase 2: [Name]
|
|
77
|
+
**Rationale:** [why this order]
|
|
78
|
+
**Delivers:** [what this phase produces]
|
|
79
|
+
**Uses:** [stack elements from STACK.md]
|
|
80
|
+
**Implements:** [architecture component]
|
|
81
|
+
|
|
82
|
+
### Phase 3: [Name]
|
|
83
|
+
**Rationale:** [why this order]
|
|
84
|
+
**Delivers:** [what this phase produces]
|
|
85
|
+
|
|
86
|
+
[Continue for suggested phases...]
|
|
87
|
+
|
|
88
|
+
### Phase Ordering Rationale
|
|
89
|
+
|
|
90
|
+
- [Why this order based on dependencies discovered]
|
|
91
|
+
- [Why this grouping based on architecture patterns]
|
|
92
|
+
- [How this avoids pitfalls from research]
|
|
93
|
+
|
|
94
|
+
### Research Flags
|
|
95
|
+
|
|
96
|
+
Phases likely needing deeper research during planning:
|
|
97
|
+
- **Phase [X]:** [reason — e.g., "complex integration, needs API research"]
|
|
98
|
+
- **Phase [Y]:** [reason — e.g., "niche domain, sparse documentation"]
|
|
99
|
+
|
|
100
|
+
Phases with standard patterns (skip research-phase):
|
|
101
|
+
- **Phase [X]:** [reason — e.g., "well-documented, established patterns"]
|
|
102
|
+
|
|
103
|
+
## Confidence Assessment
|
|
104
|
+
|
|
105
|
+
| Area | Confidence | Notes |
|
|
106
|
+
|------|------------|-------|
|
|
107
|
+
| Stack | [HIGH/MEDIUM/LOW] | [reason] |
|
|
108
|
+
| Features | [HIGH/MEDIUM/LOW] | [reason] |
|
|
109
|
+
| Architecture | [HIGH/MEDIUM/LOW] | [reason] |
|
|
110
|
+
| Pitfalls | [HIGH/MEDIUM/LOW] | [reason] |
|
|
111
|
+
|
|
112
|
+
**Overall confidence:** [HIGH/MEDIUM/LOW]
|
|
113
|
+
|
|
114
|
+
### Gaps to Address
|
|
115
|
+
|
|
116
|
+
[Any areas where research was inconclusive or needs validation during implementation]
|
|
117
|
+
|
|
118
|
+
- [Gap]: [how to handle during planning/execution]
|
|
119
|
+
- [Gap]: [how to handle during planning/execution]
|
|
120
|
+
|
|
121
|
+
## Sources
|
|
122
|
+
|
|
123
|
+
### Primary (HIGH confidence)
|
|
124
|
+
- [Context7 library ID] — [topics]
|
|
125
|
+
- [Official docs URL] — [what was checked]
|
|
126
|
+
|
|
127
|
+
### Secondary (MEDIUM confidence)
|
|
128
|
+
- [Source] — [finding]
|
|
129
|
+
|
|
130
|
+
### Tertiary (LOW confidence)
|
|
131
|
+
- [Source] — [finding, needs validation]
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
*Research completed: [date]*
|
|
135
|
+
*Ready for roadmap: yes*
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
</template>
|
|
139
|
+
|
|
140
|
+
<guidelines>
|
|
141
|
+
|
|
142
|
+
**Executive Summary:**
|
|
143
|
+
- Write for someone who will only read this section
|
|
144
|
+
- Include the key recommendation and main risk
|
|
145
|
+
- 2-3 paragraphs maximum
|
|
146
|
+
|
|
147
|
+
**Key Findings:**
|
|
148
|
+
- Summarize, don't duplicate full documents
|
|
149
|
+
- Link to detailed docs (STACK.md, FEATURES.md, etc.)
|
|
150
|
+
- Focus on what matters for roadmap decisions
|
|
151
|
+
|
|
152
|
+
**Implications for Roadmap:**
|
|
153
|
+
- This is the most important section
|
|
154
|
+
- Directly informs create-roadmap workflow
|
|
155
|
+
- Be explicit about phase suggestions and rationale
|
|
156
|
+
- Include research flags for each suggested phase
|
|
157
|
+
|
|
158
|
+
**Confidence Assessment:**
|
|
159
|
+
- Be honest about uncertainty
|
|
160
|
+
- Note gaps that need resolution during planning
|
|
161
|
+
- HIGH = verified with official sources
|
|
162
|
+
- MEDIUM = community consensus, multiple sources agree
|
|
163
|
+
- LOW = single source or inference
|
|
164
|
+
|
|
165
|
+
**Integration with create-roadmap:**
|
|
166
|
+
- This file is loaded as @context in create-roadmap
|
|
167
|
+
- Phase suggestions here become starting point for roadmap
|
|
168
|
+
- Research flags inform detect_research_needs step
|
|
169
|
+
|
|
170
|
+
</guidelines>
|