cokit-cli 1.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/FAQ.md +102 -0
- package/LICENSE +32 -0
- package/QUICK-START.md +37 -0
- package/README.md +110 -0
- package/bin/cokit.js +4 -0
- package/docs/cokit-comprehensive-mapping-guide.md +937 -0
- package/docs/cokit-slides.md +205 -0
- package/docs/cokit-team-presentation.md +319 -0
- package/docs/migration-guide.md +120 -0
- package/docs/project-roadmap.md +257 -0
- package/package.json +35 -0
- package/plans/260106-1102-cokit-implementation/phases/phase-01-cli-tool.md +151 -0
- package/plans/260106-1102-cokit-implementation/phases/phase-02-repo-level-templates.md +198 -0
- package/plans/260106-1102-cokit-implementation/phases/phase-03-user-level-skills.md +219 -0
- package/plans/260106-1102-cokit-implementation/phases/phase-04-prompt-files.md +328 -0
- package/plans/260106-1102-cokit-implementation/phases/phase-05-documentation.md +166 -0
- package/plans/260106-1102-cokit-implementation/plan.md +130 -0
- package/plans/260106-1102-cokit-implementation/research/researcher-01-copilot-skills-spec.md +182 -0
- package/plans/260106-1102-cokit-implementation/research/researcher-02-copilot-instructions-prompts.md +201 -0
- package/plans/reports/code-reviewer-260106-1718-phase2-repo-templates.md +184 -0
- package/plans/reports/code-reviewer-260106-1728-phase3-review.md +486 -0
- package/plans/reports/code-reviewer-260106-1742-phase4-prompts.md +235 -0
- package/plans/reports/code-reviewer-260106-1753-phase5-docs.md +275 -0
- package/plans/reports/docs-manager-260106-1217-phase1-completion.md +45 -0
- package/plans/reports/docs-manager-260106-1734-phase3-skills.md +108 -0
- package/plans/reports/docs-manager-260106-1746-phase4-prompt-files.md +75 -0
- package/plans/reports/project-manager-260106-1734-SUMMARY.md +354 -0
- package/plans/reports/project-manager-260106-1734-phase3-completion.md +257 -0
- package/plans/reports/project-manager-260106-1734-phase3-to-phase4-transition.md +274 -0
- package/plans/reports/project-manager-260106-1734-phase4-kickoff.md +343 -0
- package/plans/reports/project-manager-260106-1734-project-status.md +355 -0
- package/plans/reports/project-manager-260106-1746-phase4-completion.md +249 -0
- package/plans/reports/project-manager-260106-1746-phase4-deliverables.md +350 -0
- package/plans/reports/project-manager-260106-1804-project-complete.md +297 -0
- package/plans/reports/tester-260106-1717-phase2-templates.md +216 -0
- package/plans/reports/tester-260106-1726-phase3-user-skills.md +256 -0
- package/plans/reports/tester-260106-1741-phase4-prompts.md +202 -0
- package/plans/reports/tester-260106-1751-phase5-docs.md +301 -0
- package/skills/code-review/SKILL.md +86 -0
- package/skills/code-review/references/code-review-reception.md +76 -0
- package/skills/code-review/references/verification-before-completion.md +86 -0
- package/skills/debugging/SKILL.md +70 -0
- package/skills/debugging/references/root-cause-tracing.md +65 -0
- package/skills/debugging/references/systematic-debugging.md +74 -0
- package/skills/debugging/references/verification.md +74 -0
- package/skills/docs-seeker/SKILL.md +91 -0
- package/skills/docs-seeker/references/search-patterns.md +93 -0
- package/skills/docs-seeker/references/source-evaluation.md +77 -0
- package/skills/planning/SKILL.md +82 -0
- package/skills/planning/references/plan-organization.md +88 -0
- package/skills/planning/references/research-phase.md +56 -0
- package/skills/planning/references/solution-design.md +65 -0
- package/skills/sequential-thinking/SKILL.md +80 -0
- package/skills/sequential-thinking/references/advanced-techniques.md +88 -0
- package/skills/sequential-thinking/references/core-patterns.md +87 -0
- package/src/commands/add.js +93 -0
- package/src/commands/doctor.js +117 -0
- package/src/commands/init.js +152 -0
- package/src/commands/list.js +91 -0
- package/src/commands/update.js +22 -0
- package/src/index.js +23 -0
- package/src/utils/colors.js +14 -0
- package/src/utils/copy.js +122 -0
- package/src/utils/paths.js +35 -0
- package/templates/repo/.github/.cokit-version +4 -0
- package/templates/repo/.github/AGENTS.md +55 -0
- package/templates/repo/.github/copilot-instructions.md +45 -0
- package/templates/repo/.github/instructions/backend.instructions.md +35 -0
- package/templates/repo/.github/instructions/development.instructions.md +25 -0
- package/templates/repo/.github/instructions/frontend.instructions.md +31 -0
- package/templates/repo/.github/instructions/testing.instructions.md +31 -0
- package/templates/repo/.github/prompts/code.prompt.md +28 -0
- package/templates/repo/.github/prompts/docs.prompt.md +23 -0
- package/templates/repo/.github/prompts/fix.prompt.md +24 -0
- package/templates/repo/.github/prompts/plan.prompt.md +24 -0
- package/templates/repo/.github/prompts/review.prompt.md +24 -0
- package/templates/repo/.github/prompts/test.prompt.md +23 -0
- package/templates/repo/.github/skills/code-review/SKILL.md +46 -0
- package/templates/repo/.github/skills/debugging/SKILL.md +34 -0
- package/templates/repo/.vscode/settings.json +6 -0
- package/templates/repo/prompts/code.prompt.md +40 -0
- package/templates/repo/prompts/docs.prompt.md +29 -0
- package/templates/repo/prompts/fix.prompt.md +35 -0
- package/templates/repo/prompts/plan.prompt.md +41 -0
- package/templates/repo/prompts/review.prompt.md +38 -0
- package/templates/repo/prompts/test.prompt.md +29 -0
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# Systematic Debugging
|
|
2
|
+
|
|
3
|
+
Four-phase framework ensuring proper investigation before fixes.
|
|
4
|
+
|
|
5
|
+
## Phase 1: Root Cause Investigation
|
|
6
|
+
|
|
7
|
+
Before ANY fix attempt:
|
|
8
|
+
|
|
9
|
+
1. **Read the full error**
|
|
10
|
+
- Stack trace, line numbers, error type
|
|
11
|
+
- Don't skim - read word by word
|
|
12
|
+
|
|
13
|
+
2. **Reproduce consistently**
|
|
14
|
+
- Can you trigger it reliably?
|
|
15
|
+
- What are the exact steps?
|
|
16
|
+
|
|
17
|
+
3. **Check recent changes**
|
|
18
|
+
- What changed since it last worked?
|
|
19
|
+
- git diff, recent commits
|
|
20
|
+
|
|
21
|
+
4. **Gather evidence**
|
|
22
|
+
- Add logging if needed
|
|
23
|
+
- Check inputs and outputs
|
|
24
|
+
- Don't guess - observe
|
|
25
|
+
|
|
26
|
+
## Phase 2: Pattern Analysis
|
|
27
|
+
|
|
28
|
+
1. **Find working example**
|
|
29
|
+
- Similar code that works
|
|
30
|
+
- Previous version that worked
|
|
31
|
+
|
|
32
|
+
2. **Compare systematically**
|
|
33
|
+
- Line by line comparison
|
|
34
|
+
- What's different?
|
|
35
|
+
|
|
36
|
+
3. **Identify key difference**
|
|
37
|
+
- What's the minimal difference?
|
|
38
|
+
- What assumption changed?
|
|
39
|
+
|
|
40
|
+
## Phase 3: Hypothesis and Testing
|
|
41
|
+
|
|
42
|
+
1. **Form specific theory**
|
|
43
|
+
- "The bug is caused by X because Y"
|
|
44
|
+
- Must be testable
|
|
45
|
+
|
|
46
|
+
2. **Test minimally**
|
|
47
|
+
- Smallest change to prove/disprove
|
|
48
|
+
- Don't fix yet - just test theory
|
|
49
|
+
|
|
50
|
+
3. **Verify theory**
|
|
51
|
+
- Did prediction match result?
|
|
52
|
+
- If not, return to Phase 1
|
|
53
|
+
|
|
54
|
+
## Phase 4: Implementation
|
|
55
|
+
|
|
56
|
+
1. **Write failing test first**
|
|
57
|
+
- Test should fail before fix
|
|
58
|
+
- Proves you understand bug
|
|
59
|
+
|
|
60
|
+
2. **Make minimal fix**
|
|
61
|
+
- Fix at root cause
|
|
62
|
+
- Don't add workarounds
|
|
63
|
+
|
|
64
|
+
3. **Verify fix works**
|
|
65
|
+
- Test passes now
|
|
66
|
+
- No regressions
|
|
67
|
+
- Fresh run, not cached
|
|
68
|
+
|
|
69
|
+
## Key Rules
|
|
70
|
+
|
|
71
|
+
- Complete each phase before proceeding
|
|
72
|
+
- No fixes without Phase 1 evidence
|
|
73
|
+
- Theory must be testable
|
|
74
|
+
- Verify every claim
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# Verification Protocol
|
|
2
|
+
|
|
3
|
+
Run verification commands and confirm output before claiming success.
|
|
4
|
+
|
|
5
|
+
## Core Rule
|
|
6
|
+
|
|
7
|
+
**NO COMPLETION CLAIMS WITHOUT FRESH VERIFICATION EVIDENCE**
|
|
8
|
+
|
|
9
|
+
"Should work" is not evidence. Run it. Read the output. Then claim.
|
|
10
|
+
|
|
11
|
+
## Verification Steps
|
|
12
|
+
|
|
13
|
+
### 1. Run Fresh
|
|
14
|
+
|
|
15
|
+
- Clear cache if applicable
|
|
16
|
+
- Run from clean state
|
|
17
|
+
- Don't rely on previous runs
|
|
18
|
+
|
|
19
|
+
### 2. Read Output
|
|
20
|
+
|
|
21
|
+
- Read the actual output
|
|
22
|
+
- Don't assume it passed
|
|
23
|
+
- Check for warnings too
|
|
24
|
+
|
|
25
|
+
### 3. Confirm Expectations
|
|
26
|
+
|
|
27
|
+
- Did it do what you expected?
|
|
28
|
+
- All tests pass (not just most)?
|
|
29
|
+
- No new warnings/errors?
|
|
30
|
+
|
|
31
|
+
### 4. Document Evidence
|
|
32
|
+
|
|
33
|
+
- Copy relevant output
|
|
34
|
+
- Note what was verified
|
|
35
|
+
- Timestamp if needed
|
|
36
|
+
|
|
37
|
+
## What to Verify
|
|
38
|
+
|
|
39
|
+
Before claiming "fixed":
|
|
40
|
+
- [ ] Tests pass (fresh run)
|
|
41
|
+
- [ ] No new errors in logs
|
|
42
|
+
- [ ] Feature works manually
|
|
43
|
+
- [ ] Edge cases handled
|
|
44
|
+
|
|
45
|
+
Before claiming "complete":
|
|
46
|
+
- [ ] All acceptance criteria met
|
|
47
|
+
- [ ] Tests cover new code
|
|
48
|
+
- [ ] No regressions
|
|
49
|
+
- [ ] Documentation updated
|
|
50
|
+
|
|
51
|
+
## Anti-Patterns
|
|
52
|
+
|
|
53
|
+
**Don't do:**
|
|
54
|
+
- "Tests passed earlier"
|
|
55
|
+
- "It worked on my machine"
|
|
56
|
+
- "Should be fine now"
|
|
57
|
+
- Skipping verification because confident
|
|
58
|
+
|
|
59
|
+
**Do instead:**
|
|
60
|
+
- Run fresh every time
|
|
61
|
+
- Read actual output
|
|
62
|
+
- Verify on clean state
|
|
63
|
+
- Question assumptions
|
|
64
|
+
|
|
65
|
+
## Verification Checklist
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
[ ] Ran command fresh (not cached)
|
|
69
|
+
[ ] Read full output (not skimmed)
|
|
70
|
+
[ ] Output matches expectations
|
|
71
|
+
[ ] No warnings or errors
|
|
72
|
+
[ ] Tested edge case
|
|
73
|
+
[ ] Documented result
|
|
74
|
+
```
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: docs-seeker
|
|
3
|
+
description: Find and reference technical documentation. Use when needing API docs, library references, or implementation examples.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Docs Seeker
|
|
7
|
+
|
|
8
|
+
Find relevant technical documentation efficiently.
|
|
9
|
+
|
|
10
|
+
## When to Use
|
|
11
|
+
|
|
12
|
+
- Need API documentation
|
|
13
|
+
- Looking for library examples
|
|
14
|
+
- Researching best practices
|
|
15
|
+
- Finding implementation guides
|
|
16
|
+
- Unknown technology referenced
|
|
17
|
+
|
|
18
|
+
## Search Strategy
|
|
19
|
+
|
|
20
|
+
### 1. Identify What's Needed
|
|
21
|
+
|
|
22
|
+
- API reference?
|
|
23
|
+
- Tutorial/guide?
|
|
24
|
+
- Code examples?
|
|
25
|
+
- Best practices?
|
|
26
|
+
|
|
27
|
+
### 2. Search Sources
|
|
28
|
+
|
|
29
|
+
Priority order:
|
|
30
|
+
1. Official documentation
|
|
31
|
+
2. GitHub repositories
|
|
32
|
+
3. Stack Overflow (verified answers)
|
|
33
|
+
4. Technical blogs (reputable)
|
|
34
|
+
|
|
35
|
+
### 3. Validate Information
|
|
36
|
+
|
|
37
|
+
- Check date (is it current?)
|
|
38
|
+
- Check source (is it authoritative?)
|
|
39
|
+
- Check version (matches your version?)
|
|
40
|
+
|
|
41
|
+
## Documentation Types
|
|
42
|
+
|
|
43
|
+
### API Reference
|
|
44
|
+
- Function signatures
|
|
45
|
+
- Parameters and return types
|
|
46
|
+
- Error codes
|
|
47
|
+
|
|
48
|
+
### Tutorials
|
|
49
|
+
- Step-by-step guides
|
|
50
|
+
- Getting started
|
|
51
|
+
- Common patterns
|
|
52
|
+
|
|
53
|
+
### Examples
|
|
54
|
+
- Working code samples
|
|
55
|
+
- Real-world usage
|
|
56
|
+
- Edge case handling
|
|
57
|
+
|
|
58
|
+
## Search Tips
|
|
59
|
+
|
|
60
|
+
### For Libraries
|
|
61
|
+
```
|
|
62
|
+
[library name] documentation
|
|
63
|
+
[library name] [specific feature] example
|
|
64
|
+
[library name] [version] migration guide
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### For APIs
|
|
68
|
+
```
|
|
69
|
+
[service] API reference
|
|
70
|
+
[service] [endpoint] documentation
|
|
71
|
+
[service] authentication guide
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### For Errors
|
|
75
|
+
```
|
|
76
|
+
[error message] [language/framework]
|
|
77
|
+
[error code] [library name]
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Quality Checks
|
|
81
|
+
|
|
82
|
+
- [ ] Source is official/reputable?
|
|
83
|
+
- [ ] Information is current?
|
|
84
|
+
- [ ] Version matches?
|
|
85
|
+
- [ ] Examples work?
|
|
86
|
+
|
|
87
|
+
## References
|
|
88
|
+
|
|
89
|
+
See `./references/` for detailed guides:
|
|
90
|
+
- `search-patterns.md` - Search strategies
|
|
91
|
+
- `source-evaluation.md` - Evaluating sources
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# Search Patterns
|
|
2
|
+
|
|
3
|
+
Effective patterns for finding documentation.
|
|
4
|
+
|
|
5
|
+
## Library Documentation
|
|
6
|
+
|
|
7
|
+
### Getting Started
|
|
8
|
+
```
|
|
9
|
+
[library] getting started
|
|
10
|
+
[library] quickstart guide
|
|
11
|
+
[library] tutorial for beginners
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
### Specific Features
|
|
15
|
+
```
|
|
16
|
+
[library] [feature] example
|
|
17
|
+
[library] how to [action]
|
|
18
|
+
[library] [feature] documentation
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### Version-Specific
|
|
22
|
+
```
|
|
23
|
+
[library] [version] changelog
|
|
24
|
+
[library] [version] migration
|
|
25
|
+
[library] [version] breaking changes
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Troubleshooting
|
|
29
|
+
```
|
|
30
|
+
[library] [error message]
|
|
31
|
+
[library] [error code] fix
|
|
32
|
+
[library] common issues
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## API Documentation
|
|
36
|
+
|
|
37
|
+
### Authentication
|
|
38
|
+
```
|
|
39
|
+
[service] API authentication
|
|
40
|
+
[service] API key setup
|
|
41
|
+
[service] OAuth implementation
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Endpoints
|
|
45
|
+
```
|
|
46
|
+
[service] API [endpoint] reference
|
|
47
|
+
[service] [resource] API documentation
|
|
48
|
+
[service] REST API examples
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Rate Limits
|
|
52
|
+
```
|
|
53
|
+
[service] API rate limits
|
|
54
|
+
[service] API quotas
|
|
55
|
+
[service] API throttling
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Framework Documentation
|
|
59
|
+
|
|
60
|
+
### Core Concepts
|
|
61
|
+
```
|
|
62
|
+
[framework] core concepts
|
|
63
|
+
[framework] architecture guide
|
|
64
|
+
[framework] fundamentals
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Patterns
|
|
68
|
+
```
|
|
69
|
+
[framework] best practices
|
|
70
|
+
[framework] [pattern] example
|
|
71
|
+
[framework] recommended approach
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Integration
|
|
75
|
+
```
|
|
76
|
+
[framework] [library] integration
|
|
77
|
+
[framework] with [tool]
|
|
78
|
+
[framework] [database] setup
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Source Priority
|
|
82
|
+
|
|
83
|
+
1. **Official docs** - Most authoritative
|
|
84
|
+
2. **GitHub repos** - Real implementations
|
|
85
|
+
3. **Stack Overflow** - Community solutions
|
|
86
|
+
4. **Blogs** - Tutorials and explanations
|
|
87
|
+
|
|
88
|
+
## Red Flags
|
|
89
|
+
|
|
90
|
+
- Outdated (check date)
|
|
91
|
+
- Wrong version
|
|
92
|
+
- Unverified source
|
|
93
|
+
- No working examples
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Source Evaluation
|
|
2
|
+
|
|
3
|
+
How to evaluate documentation sources for reliability.
|
|
4
|
+
|
|
5
|
+
## Evaluation Criteria
|
|
6
|
+
|
|
7
|
+
### Authority
|
|
8
|
+
- Official documentation?
|
|
9
|
+
- Recognized expert author?
|
|
10
|
+
- Reputable organization?
|
|
11
|
+
- Community-verified?
|
|
12
|
+
|
|
13
|
+
### Currency
|
|
14
|
+
- Publication date visible?
|
|
15
|
+
- Last updated recently?
|
|
16
|
+
- Version matches yours?
|
|
17
|
+
- Active maintenance?
|
|
18
|
+
|
|
19
|
+
### Accuracy
|
|
20
|
+
- Code examples work?
|
|
21
|
+
- Information consistent?
|
|
22
|
+
- Cross-referenced?
|
|
23
|
+
- No obvious errors?
|
|
24
|
+
|
|
25
|
+
### Completeness
|
|
26
|
+
- Covers your use case?
|
|
27
|
+
- Explains edge cases?
|
|
28
|
+
- Includes examples?
|
|
29
|
+
- Links to related docs?
|
|
30
|
+
|
|
31
|
+
## Source Ranking
|
|
32
|
+
|
|
33
|
+
### Tier 1: Official Sources
|
|
34
|
+
- Official documentation
|
|
35
|
+
- API references
|
|
36
|
+
- Official tutorials
|
|
37
|
+
- Release notes
|
|
38
|
+
|
|
39
|
+
### Tier 2: Primary Sources
|
|
40
|
+
- GitHub repositories
|
|
41
|
+
- Author blogs
|
|
42
|
+
- Conference talks
|
|
43
|
+
- RFC documents
|
|
44
|
+
|
|
45
|
+
### Tier 3: Community Sources
|
|
46
|
+
- Stack Overflow (verified)
|
|
47
|
+
- Community tutorials
|
|
48
|
+
- Technical blogs
|
|
49
|
+
- Forum discussions
|
|
50
|
+
|
|
51
|
+
### Tier 4: Use with Caution
|
|
52
|
+
- Outdated articles
|
|
53
|
+
- Unverified answers
|
|
54
|
+
- AI-generated content
|
|
55
|
+
- Anonymous sources
|
|
56
|
+
|
|
57
|
+
## Red Flags
|
|
58
|
+
|
|
59
|
+
### Content Issues
|
|
60
|
+
- No date/version info
|
|
61
|
+
- Broken code examples
|
|
62
|
+
- Outdated dependencies
|
|
63
|
+
- Copy-pasted errors
|
|
64
|
+
|
|
65
|
+
### Source Issues
|
|
66
|
+
- Unknown author
|
|
67
|
+
- No references
|
|
68
|
+
- Clickbait title
|
|
69
|
+
- Excessive ads
|
|
70
|
+
|
|
71
|
+
## Validation Checklist
|
|
72
|
+
|
|
73
|
+
- [ ] Source is authoritative?
|
|
74
|
+
- [ ] Content is current?
|
|
75
|
+
- [ ] Version matches?
|
|
76
|
+
- [ ] Examples tested?
|
|
77
|
+
- [ ] Cross-referenced?
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: planning
|
|
3
|
+
description: Create technical implementation plans through research, analysis, and design. Use when planning features, architecting systems, or breaking down complex requirements.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Planning
|
|
7
|
+
|
|
8
|
+
Create detailed implementation plans before writing code.
|
|
9
|
+
|
|
10
|
+
## Core Principles
|
|
11
|
+
|
|
12
|
+
- **YAGNI**, **KISS**, **DRY**
|
|
13
|
+
- Plan quality determines implementation success
|
|
14
|
+
- Research before designing
|
|
15
|
+
|
|
16
|
+
## When to Use
|
|
17
|
+
|
|
18
|
+
- Planning new feature implementations
|
|
19
|
+
- Architecting system designs
|
|
20
|
+
- Evaluating technical approaches
|
|
21
|
+
- Breaking down complex requirements
|
|
22
|
+
- Assessing technical trade-offs
|
|
23
|
+
|
|
24
|
+
## Planning Workflow
|
|
25
|
+
|
|
26
|
+
### 1. Research & Analysis
|
|
27
|
+
- Understand requirements fully
|
|
28
|
+
- Research existing solutions
|
|
29
|
+
- Identify constraints and risks
|
|
30
|
+
|
|
31
|
+
### 2. Codebase Understanding
|
|
32
|
+
- Read existing code patterns
|
|
33
|
+
- Identify integration points
|
|
34
|
+
- Note dependencies
|
|
35
|
+
|
|
36
|
+
### 3. Solution Design
|
|
37
|
+
- Design architecture
|
|
38
|
+
- Consider alternatives
|
|
39
|
+
- Evaluate trade-offs
|
|
40
|
+
|
|
41
|
+
### 4. Plan Documentation
|
|
42
|
+
- Write clear plan document
|
|
43
|
+
- Break into phases
|
|
44
|
+
- Define success criteria
|
|
45
|
+
|
|
46
|
+
### 5. Review & Refine
|
|
47
|
+
- Verify completeness
|
|
48
|
+
- Check actionability
|
|
49
|
+
- Get stakeholder input
|
|
50
|
+
|
|
51
|
+
## Output Requirements
|
|
52
|
+
|
|
53
|
+
- **DO NOT** implement code - only create plans
|
|
54
|
+
- Plans must be self-contained
|
|
55
|
+
- Include code snippets for clarity
|
|
56
|
+
- Provide multiple options when applicable
|
|
57
|
+
|
|
58
|
+
## Plan Structure
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
plans/
|
|
62
|
+
└── YYMMDD-plan-name/
|
|
63
|
+
├── plan.md # Main plan
|
|
64
|
+
├── phase-01-xxx.md # Phase details
|
|
65
|
+
├── phase-02-xxx.md
|
|
66
|
+
└── research/ # Research notes
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Quality Standards
|
|
70
|
+
|
|
71
|
+
- Thorough and specific
|
|
72
|
+
- Consider maintainability
|
|
73
|
+
- Address security concerns
|
|
74
|
+
- Detailed enough for any developer
|
|
75
|
+
- Validate against existing patterns
|
|
76
|
+
|
|
77
|
+
## References
|
|
78
|
+
|
|
79
|
+
See `./references/` for detailed guides:
|
|
80
|
+
- `research-phase.md` - Research methodology
|
|
81
|
+
- `solution-design.md` - Design patterns
|
|
82
|
+
- `plan-organization.md` - Plan structure
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# Plan Organization
|
|
2
|
+
|
|
3
|
+
How to structure implementation plans.
|
|
4
|
+
|
|
5
|
+
## Plan Document Structure
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
---
|
|
9
|
+
title: "Feature Name"
|
|
10
|
+
status: pending
|
|
11
|
+
effort: Xh
|
|
12
|
+
created: YYYY-MM-DD
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# Plan Title
|
|
16
|
+
|
|
17
|
+
## Overview
|
|
18
|
+
[2-3 sentences describing what and why]
|
|
19
|
+
|
|
20
|
+
## Goals
|
|
21
|
+
- [ ] Goal 1
|
|
22
|
+
- [ ] Goal 2
|
|
23
|
+
|
|
24
|
+
## Non-Goals
|
|
25
|
+
- Thing we're not doing
|
|
26
|
+
- Thing deferred to later
|
|
27
|
+
|
|
28
|
+
## Design
|
|
29
|
+
[Architecture overview]
|
|
30
|
+
|
|
31
|
+
## Phases
|
|
32
|
+
|
|
33
|
+
| Phase | Description | Effort |
|
|
34
|
+
|-------|-------------|--------|
|
|
35
|
+
| 1 | Setup | 1h |
|
|
36
|
+
| 2 | Core feature | 2h |
|
|
37
|
+
| 3 | Testing | 1h |
|
|
38
|
+
|
|
39
|
+
## Risks
|
|
40
|
+
- Risk 1: [mitigation]
|
|
41
|
+
- Risk 2: [mitigation]
|
|
42
|
+
|
|
43
|
+
## Success Criteria
|
|
44
|
+
- [ ] Criterion 1
|
|
45
|
+
- [ ] Criterion 2
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Phase Documents
|
|
49
|
+
|
|
50
|
+
Each phase gets its own file:
|
|
51
|
+
|
|
52
|
+
```markdown
|
|
53
|
+
# Phase N: Name
|
|
54
|
+
|
|
55
|
+
**Effort:** Xh | **Status:** Pending
|
|
56
|
+
|
|
57
|
+
## Objective
|
|
58
|
+
[What this phase accomplishes]
|
|
59
|
+
|
|
60
|
+
## Tasks
|
|
61
|
+
- [ ] Task 1
|
|
62
|
+
- [ ] Task 2
|
|
63
|
+
- [ ] Task 3
|
|
64
|
+
|
|
65
|
+
## Acceptance Criteria
|
|
66
|
+
- [ ] Criterion 1
|
|
67
|
+
- [ ] Criterion 2
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## File Organization
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
plans/
|
|
74
|
+
└── YYMMDD-feature-name/
|
|
75
|
+
├── plan.md
|
|
76
|
+
├── phase-01-setup.md
|
|
77
|
+
├── phase-02-implementation.md
|
|
78
|
+
├── phase-03-testing.md
|
|
79
|
+
└── research/
|
|
80
|
+
└── notes.md
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Quality Checks
|
|
84
|
+
|
|
85
|
+
- [ ] Clear structure?
|
|
86
|
+
- [ ] Tasks actionable?
|
|
87
|
+
- [ ] Effort estimated?
|
|
88
|
+
- [ ] Success criteria defined?
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Research Phase
|
|
2
|
+
|
|
3
|
+
How to properly research before planning.
|
|
4
|
+
|
|
5
|
+
## Goals
|
|
6
|
+
|
|
7
|
+
- Understand problem space
|
|
8
|
+
- Find existing solutions
|
|
9
|
+
- Identify constraints
|
|
10
|
+
- Avoid reinventing wheels
|
|
11
|
+
|
|
12
|
+
## Research Steps
|
|
13
|
+
|
|
14
|
+
### 1. Understand Requirements
|
|
15
|
+
|
|
16
|
+
- What exactly needs to be built?
|
|
17
|
+
- What's the success criteria?
|
|
18
|
+
- What are the constraints?
|
|
19
|
+
- Who are the stakeholders?
|
|
20
|
+
|
|
21
|
+
### 2. Research Existing Solutions
|
|
22
|
+
|
|
23
|
+
- How do others solve this?
|
|
24
|
+
- What libraries/tools exist?
|
|
25
|
+
- What patterns are common?
|
|
26
|
+
- What pitfalls to avoid?
|
|
27
|
+
|
|
28
|
+
### 3. Analyze Codebase
|
|
29
|
+
|
|
30
|
+
- What exists already?
|
|
31
|
+
- What patterns are used?
|
|
32
|
+
- What can be reused?
|
|
33
|
+
- What needs to change?
|
|
34
|
+
|
|
35
|
+
### 4. Identify Risks
|
|
36
|
+
|
|
37
|
+
- What could go wrong?
|
|
38
|
+
- What's uncertain?
|
|
39
|
+
- What needs clarification?
|
|
40
|
+
- What are blockers?
|
|
41
|
+
|
|
42
|
+
## Research Output
|
|
43
|
+
|
|
44
|
+
Document findings:
|
|
45
|
+
- Problem summary
|
|
46
|
+
- Existing solutions
|
|
47
|
+
- Recommended approach
|
|
48
|
+
- Risks and mitigations
|
|
49
|
+
- Open questions
|
|
50
|
+
|
|
51
|
+
## Quality Checks
|
|
52
|
+
|
|
53
|
+
- [ ] Requirements clear?
|
|
54
|
+
- [ ] Alternatives considered?
|
|
55
|
+
- [ ] Risks identified?
|
|
56
|
+
- [ ] Questions listed?
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# Solution Design
|
|
2
|
+
|
|
3
|
+
How to design solutions before implementing.
|
|
4
|
+
|
|
5
|
+
## Design Process
|
|
6
|
+
|
|
7
|
+
### 1. Define Scope
|
|
8
|
+
|
|
9
|
+
- What's included?
|
|
10
|
+
- What's excluded?
|
|
11
|
+
- What's the MVP?
|
|
12
|
+
- What's future work?
|
|
13
|
+
|
|
14
|
+
### 2. Architecture
|
|
15
|
+
|
|
16
|
+
- High-level structure
|
|
17
|
+
- Component breakdown
|
|
18
|
+
- Data flow
|
|
19
|
+
- Integration points
|
|
20
|
+
|
|
21
|
+
### 3. Consider Alternatives
|
|
22
|
+
|
|
23
|
+
For each major decision:
|
|
24
|
+
- Option A: [description]
|
|
25
|
+
- Option B: [description]
|
|
26
|
+
- Recommendation: [choice + reasoning]
|
|
27
|
+
|
|
28
|
+
### 4. Trade-offs
|
|
29
|
+
|
|
30
|
+
Document trade-offs:
|
|
31
|
+
- Performance vs simplicity
|
|
32
|
+
- Flexibility vs complexity
|
|
33
|
+
- Speed vs quality
|
|
34
|
+
|
|
35
|
+
## Design Output
|
|
36
|
+
|
|
37
|
+
### Architecture Document
|
|
38
|
+
|
|
39
|
+
```markdown
|
|
40
|
+
## Overview
|
|
41
|
+
[1-2 sentences]
|
|
42
|
+
|
|
43
|
+
## Components
|
|
44
|
+
- Component A: [purpose]
|
|
45
|
+
- Component B: [purpose]
|
|
46
|
+
|
|
47
|
+
## Data Flow
|
|
48
|
+
[diagram or description]
|
|
49
|
+
|
|
50
|
+
## Key Decisions
|
|
51
|
+
- Decision 1: [choice + why]
|
|
52
|
+
- Decision 2: [choice + why]
|
|
53
|
+
|
|
54
|
+
## Trade-offs
|
|
55
|
+
- [trade-off 1]
|
|
56
|
+
- [trade-off 2]
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Quality Checks
|
|
60
|
+
|
|
61
|
+
- [ ] Scope clear?
|
|
62
|
+
- [ ] Components defined?
|
|
63
|
+
- [ ] Alternatives considered?
|
|
64
|
+
- [ ] Trade-offs documented?
|
|
65
|
+
- [ ] Fits existing patterns?
|