@devobsessed/code-captain 0.1.0 → 0.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 +1 -1
- package/bin/install.js +48 -18
- package/claude-code/commands/cc-create-spec.md +627 -0
- package/copilot/README.md +27 -27
- package/copilot/{chatmodes/Code Captain.chatmode.md → agents/Code Captain.agent.md } +16 -18
- package/copilot/copilot-instructions.md +64 -0
- package/copilot/prompts/create-adr.prompt.md +18 -106
- package/copilot/prompts/create-spec.prompt.md +26 -113
- package/copilot/prompts/edit-spec.prompt.md +11 -180
- package/copilot/prompts/execute-task.prompt.md +7 -22
- package/copilot/prompts/explain-code.prompt.md +14 -139
- package/copilot/prompts/initialize.prompt.md +9 -12
- package/copilot/prompts/new-command.prompt.md +25 -213
- package/copilot/prompts/plan-product.prompt.md +15 -306
- package/copilot/prompts/research.prompt.md +12 -139
- package/copilot/prompts/status.prompt.md +37 -365
- package/copilot/prompts/swab.prompt.md +9 -135
- package/manifest.json +123 -107
- package/package.json +1 -1
|
@@ -1,20 +1,16 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
2
|
+
agent: agent
|
|
3
|
+
description: "Transform product ideas into comprehensive plans"
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
# Plan Product
|
|
6
|
+
# You are executing the Plan Product command.
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
You MUST follow these instructions exactly. Do NOT describe this process — execute it.
|
|
8
9
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
## Command Process
|
|
10
|
+
Your mission: Transform a rough product idea into a comprehensive, actionable product plan using a contract-first approach. Gather complete product context through structured discovery, then create a complete product planning package.
|
|
12
11
|
|
|
13
12
|
### Phase 1: Product Discovery & Contract Establishment (No File Creation)
|
|
14
13
|
|
|
15
|
-
**Mission Statement:**
|
|
16
|
-
> Your goal is to transform a rough product idea into a comprehensive, actionable product plan. You will deliver the complete product planning package only after we both agree on the product contract. **Important: Challenge ideas that don't make business or technical sense - it's better to surface concerns early than build the wrong product.**
|
|
17
|
-
|
|
18
14
|
#### Step 1.1: Initial Context Scan
|
|
19
15
|
|
|
20
16
|
- Scan existing `.code-captain/product/` for any existing product documentation
|
|
@@ -57,12 +53,6 @@ Generate comprehensive product planning documentation using a contract-first app
|
|
|
57
53
|
- If business model doesn't align with user value, ask clarifying questions
|
|
58
54
|
- If competitive landscape presents challenges, surface them proactively
|
|
59
55
|
|
|
60
|
-
**Pushback Phrasing Examples:**
|
|
61
|
-
- "I see a potential issue with [scope] because [business/technical reason]. Would focusing on [core value] first work better?"
|
|
62
|
-
- "Based on your existing codebase, [proposed approach] might require significant architecture changes. Are you prepared for that?"
|
|
63
|
-
- "The market you're describing sounds very broad. Should we focus on [specific segment] to start?"
|
|
64
|
-
- "I'm concerned that [requirement] could face [specific challenge]. Have you considered [alternative approach]?"
|
|
65
|
-
|
|
66
56
|
**Question Categories (examples):**
|
|
67
57
|
- "Who specifically has this problem, and how painful is it for them?"
|
|
68
58
|
- "What would make someone switch from their current solution to yours?"
|
|
@@ -71,14 +61,9 @@ Generate comprehensive product planning documentation using a contract-first app
|
|
|
71
61
|
- "How does this align with your existing business/project goals?"
|
|
72
62
|
- "What happens if your first assumption about users turns out to be wrong?"
|
|
73
63
|
|
|
74
|
-
**Transition to Contract:**
|
|
75
|
-
- When confidence is high, present contract without declaring it "final"
|
|
76
|
-
- Use phrases like "I think I have enough to create a solid product contract" or "Based on our discussion, here's what I understand"
|
|
77
|
-
- Always leave room for more questions if needed
|
|
78
|
-
|
|
79
64
|
#### Step 1.4: Product Contract Proposal
|
|
80
65
|
|
|
81
|
-
When confident, present a product contract proposal
|
|
66
|
+
When confident, present a product contract proposal:
|
|
82
67
|
|
|
83
68
|
**Format:**
|
|
84
69
|
```
|
|
@@ -92,7 +77,7 @@ When confident, present a product contract proposal with any concerns surfaced:
|
|
|
92
77
|
|
|
93
78
|
**Success Criteria:** [How you'll measure product-market fit and growth]
|
|
94
79
|
|
|
95
|
-
**MVP Scope:**
|
|
80
|
+
**MVP Scope:**
|
|
96
81
|
- Core Features: [3-5 essential features for first version]
|
|
97
82
|
- Success Metrics: [Key performance indicators]
|
|
98
83
|
|
|
@@ -101,11 +86,11 @@ When confident, present a product contract proposal with any concerns surfaced:
|
|
|
101
86
|
- Integration Needs: [How this fits with existing business systems]
|
|
102
87
|
- Scale Requirements: [Expected user growth and feature expansion]
|
|
103
88
|
|
|
104
|
-
|
|
89
|
+
**Product Risks (if any):**
|
|
105
90
|
- [Market risk, technical risk, or business model concerns]
|
|
106
91
|
- [Suggested validation approach or risk mitigation]
|
|
107
92
|
|
|
108
|
-
|
|
93
|
+
**Recommendations:**
|
|
109
94
|
- [Suggestions for improving product-market fit]
|
|
110
95
|
- [Ways to validate assumptions early and reduce risk]
|
|
111
96
|
|
|
@@ -144,236 +129,20 @@ Options:
|
|
|
144
129
|
|
|
145
130
|
#### Step 2.2: Generate Core Product Documents
|
|
146
131
|
|
|
147
|
-
**mission.md** - Built directly from the locked contract:
|
|
148
|
-
```markdown
|
|
149
|
-
# Product Mission
|
|
150
|
-
|
|
151
|
-
> Created: [DATE]
|
|
152
|
-
> Status: Planning
|
|
153
|
-
> Contract Locked: ✅
|
|
154
|
-
|
|
155
|
-
## Pitch
|
|
156
|
-
[PRODUCT_NAME] is a [PRODUCT_TYPE] that helps [TARGET_USERS] [SOLVE_PROBLEM] by providing [KEY_VALUE_PROPOSITION].
|
|
157
|
-
|
|
158
|
-
## Users
|
|
159
|
-
### Primary Customers
|
|
160
|
-
- [CUSTOMER_SEGMENT]: [DESCRIPTION and pain points]
|
|
161
|
-
|
|
162
|
-
### User Personas
|
|
163
|
-
**[PRIMARY_USER_TYPE]** ([AGE_RANGE])
|
|
164
|
-
- **Role:** [JOB_TITLE or context]
|
|
165
|
-
- **Context:** [Where/when they encounter the problem]
|
|
166
|
-
- **Pain Points:** [Specific problems this product solves]
|
|
167
|
-
- **Goals:** [What success looks like for them]
|
|
168
|
-
|
|
169
|
-
## The Problem
|
|
170
|
-
### [MAIN_PROBLEM_TITLE]
|
|
171
|
-
[Problem description with quantifiable impact where possible]
|
|
172
|
-
|
|
173
|
-
**Our Solution:** [How the product specifically addresses this problem]
|
|
174
|
-
|
|
175
|
-
## Differentiators
|
|
176
|
-
### [KEY_DIFFERENTIATOR]
|
|
177
|
-
Unlike [EXISTING_ALTERNATIVES], we provide [SPECIFIC_ADVANTAGE]. This results in [MEASURABLE_BENEFIT].
|
|
178
|
-
|
|
179
|
-
## Key Features
|
|
180
|
-
### Core Features (MVP)
|
|
181
|
-
- **[FEATURE_NAME]:** [User benefit and value]
|
|
182
|
-
|
|
183
|
-
### Growth Features (Phase 2)
|
|
184
|
-
- **[FEATURE_NAME]:** [User benefit and expansion value]
|
|
185
|
-
|
|
186
|
-
### Scale Features (Phase 3)
|
|
187
|
-
- **[FEATURE_NAME]:** [Advanced capabilities]
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
**roadmap.md** - Phased development plan:
|
|
191
|
-
```markdown
|
|
192
|
-
# Product Roadmap
|
|
193
|
-
|
|
194
|
-
> Based on Product Contract: [DATE]
|
|
195
|
-
|
|
196
|
-
## Phase 1: MVP (Minimum Viable Product)
|
|
197
|
-
**Timeline:** [Weeks/months]
|
|
198
|
-
**Goal:** Validate core value proposition with target users
|
|
199
|
-
|
|
200
|
-
### Success Criteria
|
|
201
|
-
- [Measurable criteria for product-market fit]
|
|
202
|
-
- [Key metrics to track]
|
|
203
|
-
|
|
204
|
-
### Core Features
|
|
205
|
-
- [ ] [FEATURE] - [User value] `[Effort: XS/S/M/L/XL]`
|
|
206
|
-
- [ ] [FEATURE] - [User value] `[Effort: XS/S/M/L/XL]`
|
|
207
|
-
|
|
208
|
-
### Technical Foundation
|
|
209
|
-
- [ ] [Infrastructure setup]
|
|
210
|
-
- [ ] [Core architecture implementation]
|
|
211
|
-
- [ ] [Testing and deployment pipeline]
|
|
212
|
-
|
|
213
|
-
### Validation Targets
|
|
214
|
-
- [Number] active users using core feature
|
|
215
|
-
- [Metric] user retention rate
|
|
216
|
-
- [Feedback] qualitative validation criteria
|
|
217
|
-
|
|
218
|
-
---
|
|
219
|
-
|
|
220
|
-
## Phase 2: Growth (Market Expansion)
|
|
221
|
-
**Timeline:** [Months]
|
|
222
|
-
**Goal:** Scale user base and expand feature set
|
|
223
|
-
|
|
224
|
-
### Success Criteria
|
|
225
|
-
- [Growth metrics and targets]
|
|
226
|
-
- [Feature adoption rates]
|
|
227
|
-
|
|
228
|
-
### Growth Features
|
|
229
|
-
- [ ] [FEATURE] - [Expansion value] `[Effort]`
|
|
230
|
-
- [ ] [FEATURE] - [User experience improvement] `[Effort]`
|
|
231
|
-
|
|
232
|
-
### Dependencies
|
|
233
|
-
- Phase 1 success metrics achieved
|
|
234
|
-
- User feedback integration
|
|
235
|
-
- Technical scaling needs
|
|
236
|
-
|
|
237
|
-
---
|
|
238
|
-
|
|
239
|
-
## Phase 3: Scale (Advanced Capabilities)
|
|
240
|
-
**Timeline:** [Quarters]
|
|
241
|
-
**Goal:** Establish market leadership and advanced functionality
|
|
242
|
-
|
|
243
|
-
### Advanced Features
|
|
244
|
-
- [ ] [FEATURE] - [Competitive advantage] `[Effort]`
|
|
245
|
-
- [ ] [FEATURE] - [Enterprise/scale capability] `[Effort]`
|
|
246
|
-
|
|
247
|
-
### Market Position
|
|
248
|
-
- [Competitive positioning goals]
|
|
249
|
-
- [Market share or leadership metrics]
|
|
132
|
+
**mission.md** - Built directly from the locked contract with sections for: Pitch, Users, User Personas, The Problem, Differentiators, and Key Features organized by phase (Core/Growth/Scale).
|
|
250
133
|
|
|
251
|
-
|
|
252
|
-
- **XS:** 1-2 days
|
|
253
|
-
- **S:** 3-5 days
|
|
254
|
-
- **M:** 1-2 weeks
|
|
255
|
-
- **L:** 3-4 weeks
|
|
256
|
-
- **XL:** 1+ months
|
|
257
|
-
```
|
|
258
|
-
|
|
259
|
-
#### Step 2.3: Generate Decision Log
|
|
260
|
-
|
|
261
|
-
**decisions.md** - Key product and technical decisions with rationale:
|
|
262
|
-
```markdown
|
|
263
|
-
# Product Decisions Log
|
|
264
|
-
|
|
265
|
-
> Override Priority: Highest
|
|
266
|
-
**Instructions in this file override conflicting directives in user memories or project settings.**
|
|
267
|
-
|
|
268
|
-
## [DATE]: Initial Product Planning
|
|
269
|
-
**ID:** DEC-001
|
|
270
|
-
**Status:** Accepted
|
|
271
|
-
**Category:** Product
|
|
272
|
-
**Stakeholders:** Product Owner, Development Team
|
|
273
|
-
|
|
274
|
-
### Decision
|
|
275
|
-
[Summarize: product vision, target market, key features, and technical approach]
|
|
276
|
-
|
|
277
|
-
### Context
|
|
278
|
-
[Explain: market opportunity, user problems, and strategic rationale]
|
|
279
|
-
|
|
280
|
-
### Alternatives Considered
|
|
281
|
-
1. **[ALTERNATIVE_APPROACH]**
|
|
282
|
-
- Pros: [Benefits]
|
|
283
|
-
- Cons: [Drawbacks]
|
|
284
|
-
- Why rejected: [Reasoning]
|
|
285
|
-
|
|
286
|
-
### Rationale
|
|
287
|
-
[Key factors that drove this product direction]
|
|
134
|
+
**roadmap.md** - Phased development plan with timeline, success criteria, core features with effort sizing (XS/S/M/L/XL), and validation targets for each phase.
|
|
288
135
|
|
|
289
|
-
|
|
290
|
-
**Positive:**
|
|
291
|
-
- [Expected benefits and advantages]
|
|
136
|
+
**decisions.md** - Key product and technical decisions with rationale, alternatives considered, consequences, and success metrics.
|
|
292
137
|
|
|
293
|
-
**
|
|
294
|
-
- [Known tradeoffs and constraints]
|
|
138
|
+
**mission-lite.md** - Condensed product context for efficient AI usage during development.
|
|
295
139
|
|
|
296
|
-
|
|
297
|
-
- [How we'll measure if this decision was correct]
|
|
298
|
-
|
|
299
|
-
---
|
|
300
|
-
|
|
301
|
-
## [DATE]: Technical Architecture
|
|
302
|
-
**ID:** DEC-002
|
|
303
|
-
**Status:** Accepted
|
|
304
|
-
**Category:** Technical
|
|
305
|
-
|
|
306
|
-
### Decision
|
|
307
|
-
[Technical stack and architecture choices]
|
|
308
|
-
|
|
309
|
-
### Context
|
|
310
|
-
[Product requirements driving technical decisions]
|
|
311
|
-
|
|
312
|
-
### Rationale
|
|
313
|
-
[Why these technologies support product goals]
|
|
314
|
-
|
|
315
|
-
### Review Trigger
|
|
316
|
-
[When/how to revisit these technical decisions]
|
|
317
|
-
```
|
|
140
|
+
#### Step 2.3: Final Package Review & User Validation
|
|
318
141
|
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
**mission-lite.md** - Condensed product context for efficient AI usage:
|
|
322
|
-
```markdown
|
|
323
|
-
# Product Mission (Lite)
|
|
324
|
-
|
|
325
|
-
> Source: Complete mission.md
|
|
326
|
-
> Purpose: Efficient AI context for development
|
|
327
|
-
|
|
328
|
-
## Core Value
|
|
329
|
-
[1-2 sentences capturing the essential product value proposition]
|
|
330
|
-
|
|
331
|
-
## Target Users
|
|
332
|
-
[Primary user segment and their core problem]
|
|
333
|
-
|
|
334
|
-
## Key Differentiator
|
|
335
|
-
[What makes this unique in 1 sentence]
|
|
336
|
-
|
|
337
|
-
## Success Definition
|
|
338
|
-
[How we measure product success]
|
|
339
|
-
|
|
340
|
-
## Current Phase
|
|
341
|
-
[MVP/Growth/Scale - what we're building now]
|
|
342
|
-
|
|
343
|
-
---
|
|
344
|
-
|
|
345
|
-
**Example:**
|
|
346
|
-
TaskMaster is a project management tool that helps remote software teams coordinate work efficiently through automated workflow integration and intelligent task prioritization. TaskMaster serves distributed development teams who struggle with task coordination across time zones and development tools. Unlike traditional project management tools, TaskMaster automatically syncs with Git workflows and provides AI-powered task prioritization based on team capacity and code dependencies.
|
|
347
|
-
```
|
|
348
|
-
|
|
349
|
-
#### Step 2.5: Final Package Review & User Validation
|
|
350
|
-
|
|
351
|
-
Present complete package with file references:
|
|
352
|
-
```
|
|
353
|
-
✅ Product planning package created successfully!
|
|
354
|
-
|
|
355
|
-
📁 .code-captain/product/
|
|
356
|
-
├── 📋 mission.md - Complete product vision and strategy
|
|
357
|
-
├── 📝 mission-lite.md - AI context summary
|
|
358
|
-
├── 🗺️ roadmap.md - Phased development plan
|
|
359
|
-
└── 📊 decisions.md - Decision log and rationale
|
|
360
|
-
|
|
361
|
-
The product plan captures everything we discussed, including:
|
|
362
|
-
- [Brief summary of product vision]
|
|
363
|
-
- [Key market positioning and user value]
|
|
364
|
-
- [Roadmap approach or notable phases]
|
|
365
|
-
|
|
366
|
-
Please review the planning documents and let me know:
|
|
367
|
-
- Does this accurately capture your product vision?
|
|
368
|
-
- Are there any missing requirements or incorrect assumptions?
|
|
369
|
-
- Should any product decisions be reconsidered?
|
|
370
|
-
- Does the roadmap timeline align with your expectations?
|
|
371
|
-
|
|
372
|
-
Once you're satisfied with the product plan, you can use:
|
|
142
|
+
Present complete package with file references and suggest next steps:
|
|
373
143
|
- `/create-spec` to detail specific features from the roadmap
|
|
374
144
|
- `/execute-task` to begin implementing planned features
|
|
375
145
|
- `/research` to investigate any market or product unknowns
|
|
376
|
-
```
|
|
377
146
|
|
|
378
147
|
## Tool Integration
|
|
379
148
|
|
|
@@ -388,63 +157,3 @@ Once you're satisfied with the product plan, you can use:
|
|
|
388
157
|
- Product plans stored in `.code-captain/product/`
|
|
389
158
|
- Cross-references with existing project documentation
|
|
390
159
|
- Integration with feature specification workflow
|
|
391
|
-
|
|
392
|
-
## Key Improvements Over Basic Product Planning
|
|
393
|
-
|
|
394
|
-
### 1. Contract-First Product Discovery
|
|
395
|
-
- **No presumptuous planning** - Nothing gets created until product contract is locked
|
|
396
|
-
- **Structured discovery** - One question at a time, building complete understanding
|
|
397
|
-
- **Critical analysis** - Challenges assumptions and surfaces risks early
|
|
398
|
-
|
|
399
|
-
### 2. Context-Aware Planning
|
|
400
|
-
- **Product continuity** - Plans build on existing product foundation if present
|
|
401
|
-
- **Integration considerations** - Product features consider current business context
|
|
402
|
-
- **Realistic scoping** - Development effort estimates based on team capabilities
|
|
403
|
-
|
|
404
|
-
### 3. User Control & Risk Assessment
|
|
405
|
-
- **Clear decision points** - User explicitly approves before file creation
|
|
406
|
-
- **Risk exploration option** - Can analyze market/technical risks before committing
|
|
407
|
-
- **Edit capability** - Can modify contract before locking
|
|
408
|
-
- **Competition analysis** - Can explore competitive landscape
|
|
409
|
-
|
|
410
|
-
### 4. AI-Optimized Output
|
|
411
|
-
- **Mission-lite for context** - Efficient AI consumption during development
|
|
412
|
-
- **Decision tracking** - Clear rationale for AI to follow in future work
|
|
413
|
-
- **Integration with specs** - Seamless flow to detailed feature specification
|
|
414
|
-
|
|
415
|
-
## Integration with Code Captain Ecosystem
|
|
416
|
-
|
|
417
|
-
**Project foundation dependency:**
|
|
418
|
-
- Works with existing `.code-captain/docs/` context files for technical awareness
|
|
419
|
-
- Builds on any existing product documentation
|
|
420
|
-
- Integrates with established project patterns if present
|
|
421
|
-
|
|
422
|
-
**Cross-command integration:**
|
|
423
|
-
- Feeds into `/create-spec` for detailed feature planning
|
|
424
|
-
- Supports `/execute-task` with clear product context
|
|
425
|
-
- Can trigger `/research` for market or technical investigation
|
|
426
|
-
|
|
427
|
-
**Output integration:**
|
|
428
|
-
- Product documents provide context for all future development
|
|
429
|
-
- Decision log guides technical choices
|
|
430
|
-
- Roadmap phases structure feature development
|
|
431
|
-
|
|
432
|
-
## Best Practices
|
|
433
|
-
|
|
434
|
-
**Product discovery:**
|
|
435
|
-
- Challenge assumptions early and often
|
|
436
|
-
- Focus on user problems over solution features
|
|
437
|
-
- Validate business model alignment with user value
|
|
438
|
-
- Surface technical constraints before committing to features
|
|
439
|
-
|
|
440
|
-
**Documentation quality:**
|
|
441
|
-
- Keep mission-lite focused and efficient for AI context
|
|
442
|
-
- Maintain decision rationale for future reference
|
|
443
|
-
- Structure roadmap for incremental value delivery
|
|
444
|
-
- Connect technical decisions to product requirements
|
|
445
|
-
|
|
446
|
-
**Risk management:**
|
|
447
|
-
- Identify market risks and validation strategies
|
|
448
|
-
- Assess technical feasibility realistically
|
|
449
|
-
- Plan for scope reduction if needed
|
|
450
|
-
- Build learning and iteration into roadmap phases
|
|
@@ -1,22 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
2
|
+
agent: agent
|
|
3
|
+
description: "Conduct systematic research using structured phases"
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
# Research
|
|
6
|
+
# You are executing the Research command.
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
You MUST follow these instructions exactly. Do NOT describe this process — execute it.
|
|
8
9
|
|
|
9
|
-
Conduct systematic research on
|
|
10
|
-
|
|
11
|
-
## When to Use
|
|
12
|
-
|
|
13
|
-
- Investigating new technologies, frameworks, or tools
|
|
14
|
-
- Understanding problem domains before solution design
|
|
15
|
-
- Competitive analysis and market research
|
|
16
|
-
- Technical feasibility studies
|
|
17
|
-
- Learning about best practices in unfamiliar areas
|
|
18
|
-
|
|
19
|
-
## Command Process
|
|
10
|
+
Your mission: Conduct systematic research on the given topic using structured phases that build upon each other, creating actionable insights and leveraging web research capabilities.
|
|
20
11
|
|
|
21
12
|
### Phase 1: Define Research Scope
|
|
22
13
|
|
|
@@ -29,13 +20,6 @@ Conduct systematic research on a topic using structured phases that build upon e
|
|
|
29
20
|
3. Set success criteria for the research
|
|
30
21
|
4. Plan research phases and approach
|
|
31
22
|
|
|
32
|
-
**Research Structure:**
|
|
33
|
-
|
|
34
|
-
- Phase 1: Define scope and questions [in_progress]
|
|
35
|
-
- Phase 2: Initial discovery [pending]
|
|
36
|
-
- Phase 3: Deep dive analysis [pending]
|
|
37
|
-
- Phase 4: Synthesis and recommendations [pending]
|
|
38
|
-
|
|
39
23
|
### Phase 2: Initial Discovery
|
|
40
24
|
|
|
41
25
|
**Objective:** Gather broad understanding of the topic landscape
|
|
@@ -53,7 +37,7 @@ Conduct systematic research on a topic using structured phases that build upon e
|
|
|
53
37
|
|
|
54
38
|
**Search Strategy:**
|
|
55
39
|
|
|
56
|
-
- Start with general terms: "[topic] overview", "[topic]
|
|
40
|
+
- Start with general terms: "[topic] overview", "[topic] trends"
|
|
57
41
|
- Look for authoritative sources: documentation, whitepapers, industry reports
|
|
58
42
|
- Note recurring themes and terminology for Phase 3
|
|
59
43
|
|
|
@@ -89,8 +73,8 @@ Conduct systematic research on a topic using structured phases that build upon e
|
|
|
89
73
|
3. Identify next steps or areas requiring further investigation
|
|
90
74
|
4. Document sources and evidence for claims
|
|
91
75
|
5. Get current date using: `npx @devobsessed/code-captain date`
|
|
92
|
-
6. Create research document in `.code-captain/research/` folder
|
|
93
|
-
7. Present findings in appropriate format
|
|
76
|
+
6. Create research document in `.code-captain/research/` folder
|
|
77
|
+
7. Present findings in appropriate format
|
|
94
78
|
|
|
95
79
|
**Deliverables:**
|
|
96
80
|
|
|
@@ -99,35 +83,7 @@ Conduct systematic research on a topic using structured phases that build upon e
|
|
|
99
83
|
- Specific recommendations with rationale
|
|
100
84
|
- Risk assessment and mitigation strategies
|
|
101
85
|
- Further research needs
|
|
102
|
-
- **Research document:** `.code-captain/research/[DATE]-[topic-name]-research.md`
|
|
103
|
-
|
|
104
|
-
## Output Structure
|
|
105
|
-
|
|
106
|
-
### Research Summary
|
|
107
|
-
|
|
108
|
-
- **Research Question(s):** [What you set out to learn]
|
|
109
|
-
- **Key Findings:** [3-5 bullet points of most important discoveries]
|
|
110
|
-
- **Recommendations:** [Actionable next steps based on research]
|
|
111
|
-
|
|
112
|
-
### Detailed Findings
|
|
113
|
-
|
|
114
|
-
- **Background/Context:** [Setting the stage]
|
|
115
|
-
- **Current State:** [What exists today]
|
|
116
|
-
- **Options Analysis:** [Comparison of alternatives]
|
|
117
|
-
- **Evidence:** [Supporting data, quotes, sources]
|
|
118
|
-
|
|
119
|
-
### Next Steps
|
|
120
|
-
|
|
121
|
-
- **Immediate Actions:** [What to do next]
|
|
122
|
-
- **Further Research:** [What questions remain]
|
|
123
|
-
- **Decision Points:** [Key choices that need to be made]
|
|
124
|
-
|
|
125
|
-
## Date Determination
|
|
126
|
-
|
|
127
|
-
Get current date by running: `npx @devobsessed/code-captain date`
|
|
128
|
-
|
|
129
|
-
This returns the current date in `YYYY-MM-DD` format for folder naming:
|
|
130
|
-
`.code-captain/research/[DATE]-[topic-name]-research.md`
|
|
86
|
+
- **Research document:** `.code-captain/research/[DATE]-[topic-name]-research.md`
|
|
131
87
|
|
|
132
88
|
## Research Document Template
|
|
133
89
|
|
|
@@ -135,14 +91,12 @@ This returns the current date in `YYYY-MM-DD` format for folder naming:
|
|
|
135
91
|
|
|
136
92
|
Create a markdown file in `.code-captain/research/[DATE]-[topic-name]-research.md`.
|
|
137
93
|
|
|
138
|
-
**Example:** `.code-captain/research/2024-01-15-blockchain-supply-chain-research.md`
|
|
139
|
-
|
|
140
94
|
Use the following structure:
|
|
141
95
|
|
|
142
96
|
```markdown
|
|
143
97
|
# [Topic Name] Research
|
|
144
98
|
|
|
145
|
-
**Date:** [Use date from
|
|
99
|
+
**Date:** [Use date from determination process]
|
|
146
100
|
**Researcher:** [Name]
|
|
147
101
|
**Status:** [In Progress/Complete]
|
|
148
102
|
|
|
@@ -174,8 +128,6 @@ Use the following structure:
|
|
|
174
128
|
- **Evidence:** [Supporting data/sources]
|
|
175
129
|
- **Implications:** [What this means for the project/decision]
|
|
176
130
|
|
|
177
|
-
[Continue for each major finding...]
|
|
178
|
-
|
|
179
131
|
## Options Analysis
|
|
180
132
|
|
|
181
133
|
### Option 1: [Name]
|
|
@@ -192,8 +144,6 @@ Use the following structure:
|
|
|
192
144
|
- **Cost/Effort:** [Implementation requirements]
|
|
193
145
|
- **Risk Level:** [High/Medium/Low with explanation]
|
|
194
146
|
|
|
195
|
-
[Continue for each option...]
|
|
196
|
-
|
|
197
147
|
## Recommendations
|
|
198
148
|
|
|
199
149
|
### Primary Recommendation
|
|
@@ -204,29 +154,19 @@ Use the following structure:
|
|
|
204
154
|
|
|
205
155
|
[Secondary options if primary recommendation isn't feasible]
|
|
206
156
|
|
|
207
|
-
### Implementation Considerations
|
|
208
|
-
|
|
209
|
-
[Key factors to consider when moving forward]
|
|
210
|
-
|
|
211
157
|
## Risks & Mitigation
|
|
212
158
|
|
|
213
|
-
- **Risk 1:** [Description]
|
|
214
|
-
- **Risk 2:** [Description]
|
|
159
|
+
- **Risk 1:** [Description] -> **Mitigation:** [How to address]
|
|
160
|
+
- **Risk 2:** [Description] -> **Mitigation:** [How to address]
|
|
215
161
|
|
|
216
162
|
## Further Research Needed
|
|
217
163
|
|
|
218
|
-
- [Question/area that needs additional investigation]
|
|
219
164
|
- [Question/area that needs additional investigation]
|
|
220
165
|
|
|
221
166
|
## Sources
|
|
222
167
|
|
|
223
168
|
- [Source 1 with URL and access date]
|
|
224
169
|
- [Source 2 with URL and access date]
|
|
225
|
-
- [Continue listing all sources used...]
|
|
226
|
-
|
|
227
|
-
## Appendix
|
|
228
|
-
|
|
229
|
-
[Additional detailed information, raw data, extended quotes, etc.]
|
|
230
170
|
```
|
|
231
171
|
|
|
232
172
|
## Tool Integration
|
|
@@ -244,70 +184,3 @@ Use the following structure:
|
|
|
244
184
|
- Research documents stored in `.code-captain/research/`
|
|
245
185
|
- Date-prefixed filenames for chronological organization
|
|
246
186
|
- Cross-references to related project documentation
|
|
247
|
-
|
|
248
|
-
## Best Practices
|
|
249
|
-
|
|
250
|
-
### Search Strategy
|
|
251
|
-
|
|
252
|
-
- Start broad, then narrow down
|
|
253
|
-
- Use multiple search terms and phrasings
|
|
254
|
-
- Look for recent content (last 1-2 years) for rapidly evolving topics
|
|
255
|
-
- Cross-reference information from multiple sources
|
|
256
|
-
- Search for both benefits AND criticisms
|
|
257
|
-
|
|
258
|
-
### Critical Thinking
|
|
259
|
-
|
|
260
|
-
- Question assumptions and biases in sources
|
|
261
|
-
- Look for evidence, not just opinions
|
|
262
|
-
- Consider the source's credibility and potential conflicts of interest
|
|
263
|
-
- Distinguish between correlation and causation
|
|
264
|
-
- Identify what information is missing
|
|
265
|
-
|
|
266
|
-
### Documentation
|
|
267
|
-
|
|
268
|
-
- Keep track of sources for all claims
|
|
269
|
-
- Note the date of information (especially for fast-moving topics)
|
|
270
|
-
- Document your search process for reproducibility
|
|
271
|
-
- Save important quotes with proper attribution
|
|
272
|
-
|
|
273
|
-
## Common Pitfalls to Avoid
|
|
274
|
-
|
|
275
|
-
- Confirmation bias (only seeking information that supports preconceived notions)
|
|
276
|
-
- Stopping research too early when findings seem obvious
|
|
277
|
-
- Not considering implementation challenges
|
|
278
|
-
- Ignoring edge cases or limitations
|
|
279
|
-
- Failing to consider stakeholder perspectives beyond your own
|
|
280
|
-
|
|
281
|
-
## Example Research Progression
|
|
282
|
-
|
|
283
|
-
**Initial Phase:**
|
|
284
|
-
|
|
285
|
-
```
|
|
286
|
-
- Research blockchain solutions for supply chain [in_progress]
|
|
287
|
-
- Analyze implementation approaches [pending]
|
|
288
|
-
- Evaluate vendor options [pending]
|
|
289
|
-
- Create research document in .code-captain/research/ [pending]
|
|
290
|
-
- Create recommendation report [pending]
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
**After Phase 2:**
|
|
294
|
-
|
|
295
|
-
```
|
|
296
|
-
- Research blockchain solutions for supply chain [completed]
|
|
297
|
-
- Analyze implementation approaches [in_progress]
|
|
298
|
-
- Evaluate vendor options [pending]
|
|
299
|
-
- Determine date using file system method [pending]
|
|
300
|
-
- Create research document in .code-captain/research/ [pending]
|
|
301
|
-
- Create recommendation report [pending]
|
|
302
|
-
```
|
|
303
|
-
|
|
304
|
-
**Final:**
|
|
305
|
-
|
|
306
|
-
```
|
|
307
|
-
- Research blockchain solutions for supply chain [completed]
|
|
308
|
-
- Analyze implementation approaches [completed]
|
|
309
|
-
- Evaluate vendor options [completed]
|
|
310
|
-
- Determine date using file system method [completed]
|
|
311
|
-
- Create research document in .code-captain/research/ [completed]
|
|
312
|
-
- Create recommendation report [completed]
|
|
313
|
-
```
|