@devobsessed/code-captain 0.0.5 → 0.0.8
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 +1 -10
- package/bin/install.js +186 -187
- package/claude-code/agents/code-captain.md +17 -20
- package/copilot/README.md +26 -16
- package/copilot/chatmodes/Code Captain.chatmode.md +11 -16
- package/copilot/prompts/create-spec.prompt.md +5 -8
- package/copilot/prompts/explain-code.prompt.md +5 -8
- package/copilot/prompts/new-command.prompt.md +60 -21
- package/copilot/prompts/research.prompt.md +5 -8
- package/copilot/prompts/status.prompt.md +13 -2
- package/copilot/prompts/swab.prompt.md +1 -0
- package/cursor/README.md +8 -23
- package/cursor/cc.md +2 -29
- package/cursor/cc.mdc +3 -10
- package/cursor/commands/create-adr.md +1 -1
- package/cursor/commands/create-spec.md +9 -12
- package/cursor/commands/explain-code.md +5 -8
- package/cursor/commands/initialize.md +1 -1
- package/cursor/commands/new-command.md +5 -4
- package/cursor/commands/research.md +6 -9
- package/cursor/commands/status.md +13 -2
- package/cursor/commands/swab.md +61 -2
- package/manifest.json +150 -166
- package/package.json +12 -2
- package/windsurf/workflows/explain-code.md +4 -8
- package/windsurf/workflows/plan-product.md +330 -0
- package/windsurf/workflows/research.md +240 -0
- package/windsurf/workflows/swab.md +212 -0
- package/cursor/integrations/azure-devops/create-azure-work-items.md +0 -403
- package/cursor/integrations/azure-devops/sync-azure-work-items.md +0 -486
- package/cursor/integrations/github/create-github-issues.md +0 -765
- package/cursor/integrations/github/scripts/create-issues-batch.sh +0 -272
- package/cursor/integrations/github/sync-github-issues.md +0 -237
- package/cursor/integrations/github/sync.md +0 -305
|
@@ -0,0 +1,330 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "Generate comprehensive product planning documentation using contract-first approach with structured discovery"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Plan Product Workflow
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
Generate comprehensive product planning documentation using contract-first approach. Establishes clear product vision, mission, and roadmap through structured discovery, then creates complete product planning package.
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
/plan-product "product idea description"
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Process
|
|
18
|
+
|
|
19
|
+
### Phase 1: Product Discovery & Contract (No Files Created)
|
|
20
|
+
|
|
21
|
+
**Mission:** Transform rough product idea into comprehensive, actionable product plan. Challenge ideas that don't make business or technical sense.
|
|
22
|
+
|
|
23
|
+
#### Step 1.1: Context Scan
|
|
24
|
+
- Scan existing `.code-captain/product/` for product documentation
|
|
25
|
+
- Load project context from `.code-captain/docs/` (tech-stack.md if available)
|
|
26
|
+
- Review existing product mission or objectives
|
|
27
|
+
- **Output:** Product context summary and foundation assessment
|
|
28
|
+
|
|
29
|
+
#### Step 1.2: Gap Analysis (Internal)
|
|
30
|
+
Silently identify missing details across:
|
|
31
|
+
- Product vision and core value proposition
|
|
32
|
+
- Target market and user personas
|
|
33
|
+
- Key features and functionality scope
|
|
34
|
+
- Business model and monetization strategy
|
|
35
|
+
- Technical feasibility and architecture requirements
|
|
36
|
+
- Competitive landscape and differentiation
|
|
37
|
+
- Success metrics and validation criteria
|
|
38
|
+
- Timeline expectations and resource constraints
|
|
39
|
+
- Risk factors and mitigation strategies
|
|
40
|
+
|
|
41
|
+
#### Step 1.3: Structured Discovery Loop
|
|
42
|
+
|
|
43
|
+
**Rules:**
|
|
44
|
+
- Ask ONE focused question at a time
|
|
45
|
+
- After each answer, re-analyze context and technical feasibility
|
|
46
|
+
- Continue until reaching 95% confidence on product deliverable
|
|
47
|
+
- **Challenge ideas that don't make business or technical sense**
|
|
48
|
+
- Never declare "final question" - let conversation flow naturally
|
|
49
|
+
|
|
50
|
+
**Critical Analysis Examples:**
|
|
51
|
+
- "I see a potential issue with [scope] because [business/technical reason]. Would focusing on [core value] first work better?"
|
|
52
|
+
- "Based on your existing codebase, [proposed approach] might require significant architecture changes. Are you prepared for that?"
|
|
53
|
+
- "The market you're describing sounds very broad. Should we focus on [specific segment] to start?"
|
|
54
|
+
|
|
55
|
+
**Question Categories:**
|
|
56
|
+
- "Who specifically has this problem, and how painful is it for them?"
|
|
57
|
+
- "What would make someone switch from their current solution to yours?"
|
|
58
|
+
- "How will you measure product success in the first 6 months?"
|
|
59
|
+
- "What's your biggest constraint - time, budget, technical expertise, or market access?"
|
|
60
|
+
|
|
61
|
+
#### Step 1.4: Product Contract Proposal
|
|
62
|
+
|
|
63
|
+
When confident, present contract proposal:
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
## Product Planning Contract
|
|
67
|
+
|
|
68
|
+
**Product Vision:** [One clear sentence describing product and primary value]
|
|
69
|
+
|
|
70
|
+
**Target Market:** [Specific user segment with core problem]
|
|
71
|
+
|
|
72
|
+
**Unique Value:** [What makes this different/better than alternatives]
|
|
73
|
+
|
|
74
|
+
**Success Criteria:** [How you'll measure product-market fit and growth]
|
|
75
|
+
|
|
76
|
+
**MVP Scope:**
|
|
77
|
+
- Core Features: [3-5 essential features for first version]
|
|
78
|
+
- Success Metrics: [Key performance indicators]
|
|
79
|
+
|
|
80
|
+
**Product Architecture:**
|
|
81
|
+
- Complexity Level: [Simple/Moderate/Complex based on features]
|
|
82
|
+
- Integration Needs: [How this fits with existing business systems]
|
|
83
|
+
- Scale Requirements: [Expected user growth and feature expansion]
|
|
84
|
+
|
|
85
|
+
**⚠️ Product Risks (if any):**
|
|
86
|
+
- [Market risk, technical risk, or business model concerns]
|
|
87
|
+
- [Suggested validation approach or risk mitigation]
|
|
88
|
+
|
|
89
|
+
**💡 Recommendations:**
|
|
90
|
+
- [Suggestions for improving product-market fit]
|
|
91
|
+
- [Ways to validate assumptions early and reduce risk]
|
|
92
|
+
|
|
93
|
+
**Roadmap Phases:**
|
|
94
|
+
- Phase 1 (MVP): [Core value delivery - weeks/months]
|
|
95
|
+
- Phase 2 (Growth): [Key expansion features - months]
|
|
96
|
+
- Phase 3 (Scale): [Advanced capabilities - quarters]
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
Options:
|
|
100
|
+
- Type 'yes' to lock this contract and create the product planning package
|
|
101
|
+
- Type 'edit: [your changes]' to modify the contract
|
|
102
|
+
- Type 'risks' to explore potential market/technical risks in detail
|
|
103
|
+
- Ask more questions if anything needs clarification
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Phase 2: Product Planning Package Creation (Post-Agreement Only)
|
|
107
|
+
|
|
108
|
+
**Triggered only after user confirms contract with 'yes'**
|
|
109
|
+
|
|
110
|
+
#### Step 2.1: Initialize Tracking
|
|
111
|
+
Use memory feature to track creation process:
|
|
112
|
+
1. Create product planning folder structure
|
|
113
|
+
2. Generate core product mission document
|
|
114
|
+
3. Develop product roadmap with phases
|
|
115
|
+
4. Create decision log and rationale
|
|
116
|
+
5. Generate lite mission for AI context
|
|
117
|
+
6. Present package for user review and validation
|
|
118
|
+
|
|
119
|
+
#### Step 2.2: Create Directory Structure
|
|
120
|
+
|
|
121
|
+
**Generated folder:**
|
|
122
|
+
```
|
|
123
|
+
.code-captain/product/
|
|
124
|
+
├── mission.md # Complete product vision and strategy
|
|
125
|
+
├── mission-lite.md # Condensed version for AI context
|
|
126
|
+
├── roadmap.md # Development phases and timeline
|
|
127
|
+
├── decisions.md # Decision log with rationale
|
|
128
|
+
└── research/ # Supporting research and analysis
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
#### Step 2.3: Generate Core Documents
|
|
132
|
+
|
|
133
|
+
**mission.md** - Built from locked contract:
|
|
134
|
+
```markdown
|
|
135
|
+
# Product Mission
|
|
136
|
+
|
|
137
|
+
> Created: [DATE]
|
|
138
|
+
> Status: Planning
|
|
139
|
+
> Contract Locked: ✅
|
|
140
|
+
|
|
141
|
+
## Pitch
|
|
142
|
+
[PRODUCT_NAME] is a [PRODUCT_TYPE] that helps [TARGET_USERS] [SOLVE_PROBLEM] by providing [KEY_VALUE_PROPOSITION].
|
|
143
|
+
|
|
144
|
+
## Users
|
|
145
|
+
### Primary Customers
|
|
146
|
+
- [CUSTOMER_SEGMENT]: [DESCRIPTION and pain points]
|
|
147
|
+
|
|
148
|
+
### User Personas
|
|
149
|
+
**[PRIMARY_USER_TYPE]** ([AGE_RANGE])
|
|
150
|
+
- **Role:** [JOB_TITLE or context]
|
|
151
|
+
- **Context:** [Where/when they encounter the problem]
|
|
152
|
+
- **Pain Points:** [Specific problems this product solves]
|
|
153
|
+
- **Goals:** [What success looks like for them]
|
|
154
|
+
|
|
155
|
+
## The Problem
|
|
156
|
+
### [MAIN_PROBLEM_TITLE]
|
|
157
|
+
[Problem description with quantifiable impact where possible]
|
|
158
|
+
|
|
159
|
+
**Our Solution:** [How the product specifically addresses this problem]
|
|
160
|
+
|
|
161
|
+
## Differentiators
|
|
162
|
+
### [KEY_DIFFERENTIATOR]
|
|
163
|
+
Unlike [EXISTING_ALTERNATIVES], we provide [SPECIFIC_ADVANTAGE]. This results in [MEASURABLE_BENEFIT].
|
|
164
|
+
|
|
165
|
+
## Key Features
|
|
166
|
+
### Core Features (MVP)
|
|
167
|
+
- **[FEATURE_NAME]:** [User benefit and value]
|
|
168
|
+
|
|
169
|
+
### Growth Features (Phase 2)
|
|
170
|
+
- **[FEATURE_NAME]:** [User benefit and expansion value]
|
|
171
|
+
|
|
172
|
+
### Scale Features (Phase 3)
|
|
173
|
+
- **[FEATURE_NAME]:** [Advanced capabilities]
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
**roadmap.md** - Phased development plan:
|
|
177
|
+
```markdown
|
|
178
|
+
# Product Roadmap
|
|
179
|
+
|
|
180
|
+
> Based on Product Contract: [DATE]
|
|
181
|
+
|
|
182
|
+
## Phase 1: MVP (Minimum Viable Product)
|
|
183
|
+
**Timeline:** [Weeks/months]
|
|
184
|
+
**Goal:** Validate core value proposition with target users
|
|
185
|
+
|
|
186
|
+
### Success Criteria
|
|
187
|
+
- [Measurable criteria for product-market fit]
|
|
188
|
+
- [Key metrics to track]
|
|
189
|
+
|
|
190
|
+
### Core Features
|
|
191
|
+
- [ ] [FEATURE] - [User value] `[Effort: XS/S/M/L/XL]`
|
|
192
|
+
- [ ] [FEATURE] - [User value] `[Effort: XS/S/M/L/XL]`
|
|
193
|
+
|
|
194
|
+
### Technical Foundation
|
|
195
|
+
- [ ] [Infrastructure setup]
|
|
196
|
+
- [ ] [Core architecture implementation]
|
|
197
|
+
- [ ] [Testing and deployment pipeline]
|
|
198
|
+
|
|
199
|
+
### Validation Targets
|
|
200
|
+
- [Number] active users using core feature
|
|
201
|
+
- [Metric] user retention rate
|
|
202
|
+
- [Feedback] qualitative validation criteria
|
|
203
|
+
|
|
204
|
+
## Phase 2: Growth (Market Expansion)
|
|
205
|
+
**Timeline:** [Months]
|
|
206
|
+
**Goal:** Scale user base and expand feature set
|
|
207
|
+
|
|
208
|
+
### Growth Features
|
|
209
|
+
- [ ] [FEATURE] - [Expansion value] `[Effort]`
|
|
210
|
+
- [ ] [FEATURE] - [User experience improvement] `[Effort]`
|
|
211
|
+
|
|
212
|
+
## Phase 3: Scale (Advanced Capabilities)
|
|
213
|
+
**Timeline:** [Quarters]
|
|
214
|
+
**Goal:** Establish market leadership and advanced functionality
|
|
215
|
+
|
|
216
|
+
### Advanced Features
|
|
217
|
+
- [ ] [FEATURE] - [Competitive advantage] `[Effort]`
|
|
218
|
+
- [ ] [FEATURE] - [Enterprise/scale capability] `[Effort]`
|
|
219
|
+
|
|
220
|
+
## Effort Sizing
|
|
221
|
+
- **XS:** 1-2 days
|
|
222
|
+
- **S:** 3-5 days
|
|
223
|
+
- **M:** 1-2 weeks
|
|
224
|
+
- **L:** 3-4 weeks
|
|
225
|
+
- **XL:** 1+ months
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
#### Step 2.4: Generate Decision Log
|
|
229
|
+
|
|
230
|
+
**decisions.md** - Key product and technical decisions:
|
|
231
|
+
```markdown
|
|
232
|
+
# Product Decisions Log
|
|
233
|
+
|
|
234
|
+
> Override Priority: Highest
|
|
235
|
+
|
|
236
|
+
## [DATE]: Initial Product Planning
|
|
237
|
+
**ID:** DEC-001
|
|
238
|
+
**Status:** Accepted
|
|
239
|
+
**Category:** Product
|
|
240
|
+
|
|
241
|
+
### Decision
|
|
242
|
+
[Summarize: product vision, target market, key features, technical approach]
|
|
243
|
+
|
|
244
|
+
### Context
|
|
245
|
+
[Market opportunity, user problems, strategic rationale]
|
|
246
|
+
|
|
247
|
+
### Alternatives Considered
|
|
248
|
+
1. **[ALTERNATIVE_APPROACH]**
|
|
249
|
+
- Pros: [Benefits]
|
|
250
|
+
- Cons: [Drawbacks]
|
|
251
|
+
- Why rejected: [Reasoning]
|
|
252
|
+
|
|
253
|
+
### Rationale
|
|
254
|
+
[Key factors that drove this product direction]
|
|
255
|
+
|
|
256
|
+
### Consequences
|
|
257
|
+
**Positive:**
|
|
258
|
+
- [Expected benefits and advantages]
|
|
259
|
+
|
|
260
|
+
**Negative:**
|
|
261
|
+
- [Known tradeoffs and constraints]
|
|
262
|
+
|
|
263
|
+
### Success Metrics
|
|
264
|
+
- [How we'll measure if this decision was correct]
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
#### Step 2.5: Create Mission-Lite
|
|
268
|
+
|
|
269
|
+
**mission-lite.md** - Condensed product context for AI:
|
|
270
|
+
```markdown
|
|
271
|
+
# Product Mission (Lite)
|
|
272
|
+
|
|
273
|
+
> Source: Complete mission.md
|
|
274
|
+
> Purpose: Efficient AI context for development
|
|
275
|
+
|
|
276
|
+
## Core Value
|
|
277
|
+
[1-2 sentences capturing essential product value proposition]
|
|
278
|
+
|
|
279
|
+
## Target Users
|
|
280
|
+
[Primary user segment and core problem]
|
|
281
|
+
|
|
282
|
+
## Key Differentiator
|
|
283
|
+
[What makes this unique in 1 sentence]
|
|
284
|
+
|
|
285
|
+
## Success Definition
|
|
286
|
+
[How we measure product success]
|
|
287
|
+
|
|
288
|
+
## Current Phase
|
|
289
|
+
[MVP/Growth/Scale - what we're building now]
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
#### Step 2.6: Final Package Review
|
|
293
|
+
|
|
294
|
+
Present complete package:
|
|
295
|
+
```
|
|
296
|
+
✅ Product planning package created successfully!
|
|
297
|
+
|
|
298
|
+
📁 .code-captain/product/
|
|
299
|
+
├── 📋 mission.md - Complete product vision and strategy
|
|
300
|
+
├── 📝 mission-lite.md - AI context summary
|
|
301
|
+
├── 🗺️ roadmap.md - Phased development plan
|
|
302
|
+
└── 📊 decisions.md - Decision log and rationale
|
|
303
|
+
|
|
304
|
+
Please review the planning documents and let me know:
|
|
305
|
+
- Does this accurately capture your product vision?
|
|
306
|
+
- Are there any missing requirements or incorrect assumptions?
|
|
307
|
+
- Should any product decisions be reconsidered?
|
|
308
|
+
- Does the roadmap timeline align with your expectations?
|
|
309
|
+
|
|
310
|
+
Once satisfied, you can use:
|
|
311
|
+
- `/create-spec` to detail specific features from the roadmap
|
|
312
|
+
- `/execute-task` to begin implementing planned features
|
|
313
|
+
- `/research` to investigate any market or product unknowns
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
## Implementation with Windsurf Tools
|
|
317
|
+
|
|
318
|
+
**File Operations:**
|
|
319
|
+
- Use `write_to_file` to create product planning documents
|
|
320
|
+
- Use `view_file` to review existing product documentation
|
|
321
|
+
- Use `find_by_name` to locate related files
|
|
322
|
+
|
|
323
|
+
**Research Tools:**
|
|
324
|
+
- Use `search_web` for market research and competitive analysis
|
|
325
|
+
- Use memory feature to track discovery progress and key decisions
|
|
326
|
+
|
|
327
|
+
**Integration:**
|
|
328
|
+
- Works with existing `.code-captain/product/` directory structure
|
|
329
|
+
- Feeds into feature specification and development workflows
|
|
330
|
+
- Supports cross-command integration with research and ADR workflows
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "Conduct systematic research using structured phases with web search capabilities and actionable todos"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Research Workflow
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
Conduct systematic research using structured phases with web search capabilities and actionable todos.
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
/research "topic description"
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Process
|
|
18
|
+
|
|
19
|
+
### Phase 1: Define Research Scope
|
|
20
|
+
|
|
21
|
+
**Create research todos:**
|
|
22
|
+
|
|
23
|
+
Use memory feature to track progress:
|
|
24
|
+
```
|
|
25
|
+
- Phase 1: Define scope and questions [in_progress]
|
|
26
|
+
- Phase 2: Initial discovery [pending]
|
|
27
|
+
- Phase 3: Deep dive analysis [pending]
|
|
28
|
+
- Phase 4: Synthesis and recommendations [pending]
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**Actions:**
|
|
32
|
+
1. Define primary research question(s)
|
|
33
|
+
2. Identify key stakeholders and information needs
|
|
34
|
+
3. Set success criteria for research
|
|
35
|
+
|
|
36
|
+
### Phase 2: Initial Discovery
|
|
37
|
+
|
|
38
|
+
**Objective:** Gather broad understanding of topic landscape
|
|
39
|
+
|
|
40
|
+
**Actions:**
|
|
41
|
+
1. Use `search_web` with broad search terms
|
|
42
|
+
2. Search for:
|
|
43
|
+
- Overview articles and introductory content
|
|
44
|
+
- Current trends and recent developments
|
|
45
|
+
- Key players and thought leaders
|
|
46
|
+
- Common terminology and concepts
|
|
47
|
+
3. Document initial findings and themes
|
|
48
|
+
4. Identify knowledge gaps for deeper investigation
|
|
49
|
+
|
|
50
|
+
**Search Strategy:**
|
|
51
|
+
- Start with general terms: "[topic] overview", "[topic] 2024", "[topic] trends"
|
|
52
|
+
- Look for authoritative sources: documentation, whitepapers, industry reports
|
|
53
|
+
- Note recurring themes for Phase 3
|
|
54
|
+
|
|
55
|
+
### Phase 3: Deep Dive Analysis
|
|
56
|
+
|
|
57
|
+
**Objective:** Investigate specific aspects identified in Phase 2
|
|
58
|
+
|
|
59
|
+
**Actions:**
|
|
60
|
+
1. Use `search_web` with targeted queries from Phase 2 findings
|
|
61
|
+
2. Research specific sub-topics:
|
|
62
|
+
- Technical implementation details
|
|
63
|
+
- Pros and cons of different approaches
|
|
64
|
+
- Real-world case studies and examples
|
|
65
|
+
- Performance metrics and benchmarks
|
|
66
|
+
3. Compare alternatives and trade-offs
|
|
67
|
+
4. Validate claims from multiple sources
|
|
68
|
+
|
|
69
|
+
**Search Strategy:**
|
|
70
|
+
- Use specific terminology from Phase 2
|
|
71
|
+
- Search for: "[approach] vs [alternative]", "[topic] case study", "[topic] performance"
|
|
72
|
+
- Look for criticism and limitations, not just benefits
|
|
73
|
+
|
|
74
|
+
### Phase 4: Synthesis and Recommendations
|
|
75
|
+
|
|
76
|
+
**Objective:** Transform research into actionable insights
|
|
77
|
+
|
|
78
|
+
**Actions:**
|
|
79
|
+
1. Synthesize findings into key insights
|
|
80
|
+
2. Create recommendations based on research
|
|
81
|
+
3. Identify next steps or further investigation needs
|
|
82
|
+
4. Document sources and evidence
|
|
83
|
+
5. Create research document in `.code-captain/research/` folder
|
|
84
|
+
|
|
85
|
+
**Deliverables:**
|
|
86
|
+
- Executive summary of key findings
|
|
87
|
+
- Pros/cons analysis of options
|
|
88
|
+
- Specific recommendations with rationale
|
|
89
|
+
- Risk assessment and mitigation strategies
|
|
90
|
+
- Research document: `.code-captain/research/[DATE]-[topic-name]-research.md`
|
|
91
|
+
|
|
92
|
+
## Date Determination
|
|
93
|
+
|
|
94
|
+
### Primary Method: System Clock
|
|
95
|
+
|
|
96
|
+
1. Read the current UTC date from the system clock and format as `YYYY-MM-DD`.
|
|
97
|
+
2. Store it for naming:
|
|
98
|
+
`.code-captain/research/[DATE]-[topic-name]-research.md`
|
|
99
|
+
|
|
100
|
+
### Fallback Method
|
|
101
|
+
|
|
102
|
+
If system clock access isn't available:
|
|
103
|
+
1. Prompt: "What is today's date? (YYYY-MM-DD)"
|
|
104
|
+
2. Validate against `^\d{4}-\d{2}-\d{2}$`
|
|
105
|
+
3. Store the date for naming
|
|
106
|
+
|
|
107
|
+
## Research Document Template
|
|
108
|
+
|
|
109
|
+
Create: `.code-captain/research/[DATE]-[topic-name]-research.md`
|
|
110
|
+
|
|
111
|
+
```markdown
|
|
112
|
+
# [Topic Name] Research
|
|
113
|
+
|
|
114
|
+
**Date:** [Current date]
|
|
115
|
+
**Researcher:** [Name]
|
|
116
|
+
**Status:** [In Progress/Complete]
|
|
117
|
+
|
|
118
|
+
## Research Question(s)
|
|
119
|
+
|
|
120
|
+
[Primary questions this research aimed to answer]
|
|
121
|
+
|
|
122
|
+
## Executive Summary
|
|
123
|
+
|
|
124
|
+
[2-3 paragraph overview of key findings and recommendations]
|
|
125
|
+
|
|
126
|
+
## Background & Context
|
|
127
|
+
|
|
128
|
+
[Why research was needed, current situation, stakeholders]
|
|
129
|
+
|
|
130
|
+
## Methodology
|
|
131
|
+
|
|
132
|
+
[How research was conducted, sources used, timeframe]
|
|
133
|
+
|
|
134
|
+
## Key Findings
|
|
135
|
+
|
|
136
|
+
### Finding 1: [Title]
|
|
137
|
+
|
|
138
|
+
- **Evidence:** [Supporting data/sources]
|
|
139
|
+
- **Implications:** [What this means for project/decision]
|
|
140
|
+
|
|
141
|
+
### Finding 2: [Title]
|
|
142
|
+
|
|
143
|
+
- **Evidence:** [Supporting data/sources]
|
|
144
|
+
- **Implications:** [What this means for project/decision]
|
|
145
|
+
|
|
146
|
+
## Options Analysis
|
|
147
|
+
|
|
148
|
+
### Option 1: [Name]
|
|
149
|
+
|
|
150
|
+
- **Pros:** [Benefits and advantages]
|
|
151
|
+
- **Cons:** [Drawbacks and limitations]
|
|
152
|
+
- **Cost/Effort:** [Implementation requirements]
|
|
153
|
+
- **Risk Level:** [High/Medium/Low with explanation]
|
|
154
|
+
|
|
155
|
+
### Option 2: [Name]
|
|
156
|
+
|
|
157
|
+
- **Pros:** [Benefits and advantages]
|
|
158
|
+
- **Cons:** [Drawbacks and limitations]
|
|
159
|
+
- **Cost/Effort:** [Implementation requirements]
|
|
160
|
+
- **Risk Level:** [High/Medium/Low with explanation]
|
|
161
|
+
|
|
162
|
+
## Recommendations
|
|
163
|
+
|
|
164
|
+
### Primary Recommendation
|
|
165
|
+
|
|
166
|
+
[Specific recommended course of action with rationale]
|
|
167
|
+
|
|
168
|
+
### Alternative Approaches
|
|
169
|
+
|
|
170
|
+
[Secondary options if primary isn't feasible]
|
|
171
|
+
|
|
172
|
+
### Implementation Considerations
|
|
173
|
+
|
|
174
|
+
[Key factors to consider when moving forward]
|
|
175
|
+
|
|
176
|
+
## Risks & Mitigation
|
|
177
|
+
|
|
178
|
+
- **Risk 1:** [Description] → **Mitigation:** [How to address]
|
|
179
|
+
- **Risk 2:** [Description] → **Mitigation:** [How to address]
|
|
180
|
+
|
|
181
|
+
## Further Research Needed
|
|
182
|
+
|
|
183
|
+
- [Questions/areas needing additional investigation]
|
|
184
|
+
|
|
185
|
+
## Sources
|
|
186
|
+
|
|
187
|
+
- [Source 1 with URL and access date]
|
|
188
|
+
- [Source 2 with URL and access date]
|
|
189
|
+
|
|
190
|
+
## Appendix
|
|
191
|
+
|
|
192
|
+
[Additional detailed information, raw data, extended quotes]
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## Best Practices
|
|
196
|
+
|
|
197
|
+
### Search Strategy
|
|
198
|
+
- Start broad, then narrow down
|
|
199
|
+
- Use multiple search terms and phrasings
|
|
200
|
+
- Look for recent content (last 1-2 years) for evolving topics
|
|
201
|
+
- Cross-reference information from multiple sources
|
|
202
|
+
- Search for both benefits AND criticisms
|
|
203
|
+
|
|
204
|
+
### Critical Thinking
|
|
205
|
+
- Question assumptions and biases in sources
|
|
206
|
+
- Look for evidence, not just opinions
|
|
207
|
+
- Consider source credibility and potential conflicts
|
|
208
|
+
- Distinguish between correlation and causation
|
|
209
|
+
- Identify missing information
|
|
210
|
+
|
|
211
|
+
### Documentation
|
|
212
|
+
- Keep track of sources for all claims
|
|
213
|
+
- Note information dates (especially for fast-moving topics)
|
|
214
|
+
- Document search process for reproducibility
|
|
215
|
+
- Save important quotes with proper attribution
|
|
216
|
+
|
|
217
|
+
## Common Pitfalls to Avoid
|
|
218
|
+
|
|
219
|
+
- Confirmation bias (only seeking supporting information)
|
|
220
|
+
- Stopping research too early when findings seem obvious
|
|
221
|
+
- Not considering implementation challenges
|
|
222
|
+
- Ignoring edge cases or limitations
|
|
223
|
+
- Failing to consider stakeholder perspectives beyond your own
|
|
224
|
+
|
|
225
|
+
## Implementation with Windsurf Tools
|
|
226
|
+
|
|
227
|
+
**File Operations:**
|
|
228
|
+
- Use `write_to_file` to create research documents
|
|
229
|
+
- Use `view_file` to review existing research
|
|
230
|
+
- Use `find_by_name` to locate related files
|
|
231
|
+
|
|
232
|
+
**Research Tools:**
|
|
233
|
+
- Use `search_web` for all web research phases
|
|
234
|
+
- Use `codebase_search` for understanding current implementation
|
|
235
|
+
- Use memory feature to track research progress and key findings
|
|
236
|
+
|
|
237
|
+
**Integration:**
|
|
238
|
+
- Works with existing `.code-captain/research/` directory structure
|
|
239
|
+
- Feeds into Architecture Decision Records (ADRs)
|
|
240
|
+
- Supports product planning and feature specification workflows
|