Initial commit
This commit is contained in:
135
skills/structured-plan-mode/assets/plan-template.md
Normal file
135
skills/structured-plan-mode/assets/plan-template.md
Normal file
@@ -0,0 +1,135 @@
|
||||
# [Feature Name] - Plan
|
||||
|
||||
> **Template Purpose**: This template provides a structured approach for planning and tracking complex feature implementations. Copy this template to `.plans/[feature-name]/plan.md` and adapt it for your feature.
|
||||
>
|
||||
> **Task Files**: Create individual task files in `.plans/[feature-name]/tasks/` using `task-template.md` as your starting point.
|
||||
|
||||
---
|
||||
<!-- PROGRESS SECTION -->
|
||||
|
||||
### Progress Summary
|
||||
|
||||
* [ ] **Research & Strategy Selection** 🟡 Planned
|
||||
- Explore existing patterns
|
||||
- Evaluate approach options
|
||||
- Select and document strategy
|
||||
|
||||
<!-- Task links will be added in Phase 4 - these are placeholders showing the format -->
|
||||
* [ ] [**T01**: [First Implementation Task]](tasks/T01.md) - Status: 🟡 Planned
|
||||
* [ ] [**T02**: [Second Implementation Task]](tasks/T02.md) - Status: 🟡 Planned
|
||||
* [ ] [**T03**: [Third Implementation Task]](tasks/T03.md) - Status: 🟡 Planned
|
||||
|
||||
<!-- Add more task links (T04, T05, ...T0N) as needed based on complexity -->
|
||||
|
||||
<!-- END PROGRESS SECTION -->
|
||||
|
||||
---
|
||||
|
||||
## Research & Strategy Selection
|
||||
**Status**: 🟡 **Planned**
|
||||
|
||||
### Goal
|
||||
[Describe the research objective - understand existing patterns, identify approaches, evaluate alternatives]
|
||||
|
||||
### Context
|
||||
[Explain why this research is needed and what questions need answering]
|
||||
|
||||
**Action Items**:
|
||||
|
||||
- [ ] Review existing patterns in codebase
|
||||
- [ ] Analyze relevant APIs/data sources
|
||||
- [ ] Identify 2-4 viable approach options
|
||||
- [ ] Present findings and trade-offs to user
|
||||
- [ ] Get user confirmation on selected approach
|
||||
|
||||
### Strategy Proposals
|
||||
|
||||
> **Fill this during research as you discover options**
|
||||
|
||||
**Option A: [Approach Name]**
|
||||
- Description: [Brief description]
|
||||
- Pros: [Benefits]
|
||||
- Cons: [Drawbacks]
|
||||
|
||||
**Option B: [Approach Name]**
|
||||
- Description: [Brief description]
|
||||
- Pros: [Benefits]
|
||||
- Cons: [Drawbacks]
|
||||
|
||||
**Option C: [Approach Name]** (if applicable)
|
||||
- Description: [Brief description]
|
||||
- Pros: [Benefits]
|
||||
- Cons: [Drawbacks]
|
||||
|
||||
### Selected Approach
|
||||
|
||||
> **IMPORTANT**: Fill this section AFTER user confirms the selected strategy
|
||||
|
||||
**Decision**: [Which approach was selected - Option A/B/C or hybrid]
|
||||
|
||||
**Rationale**: [Why this approach was chosen over alternatives]
|
||||
|
||||
**Key Findings**:
|
||||
- [Finding 1 from research]
|
||||
- [Finding 2 from research]
|
||||
- [Finding 3 from research]
|
||||
|
||||
**Implementation Plan**:
|
||||
- [High-level step 1]
|
||||
- [High-level step 2]
|
||||
- [High-level step 3]
|
||||
- [High-level step 4]
|
||||
- [High-level step 5]
|
||||
|
||||
### Dependencies
|
||||
- [External dependency 1]
|
||||
- [External dependency 2]
|
||||
|
||||
### Related Files
|
||||
- `[file/path/here]` - Description
|
||||
|
||||
---
|
||||
|
||||
## Implementation Tasks
|
||||
|
||||
> Task files will be created in the `tasks/` subfolder during Phase 4 of the structured plan mode workflow.
|
||||
|
||||
---
|
||||
|
||||
## Lessons Learned (Post-Implementation)
|
||||
|
||||
> Fill this section out after completing the feature
|
||||
|
||||
### What Went Well
|
||||
- [Success 1]
|
||||
- [Success 2]
|
||||
|
||||
### What Could Be Improved
|
||||
- [Area for improvement 1]
|
||||
- [Area for improvement 2]
|
||||
|
||||
### Unexpected Challenges
|
||||
- [Challenge 1 and how it was resolved]
|
||||
- [Challenge 2 and how it was resolved]
|
||||
|
||||
### Recommendations for Future Features
|
||||
- [Recommendation 1]
|
||||
- [Recommendation 2]
|
||||
|
||||
---
|
||||
|
||||
|
||||
<!-- META_INFORMATION -->
|
||||
## Task Status Legend
|
||||
- 🔴 **Blocked**: Requires external dependency or decision
|
||||
- 🟡 **Planned**: Ready to implement
|
||||
- 🟢 **In Progress**: Currently being worked on
|
||||
- ✅ **Completed**: Done
|
||||
|
||||
## Change Log
|
||||
|
||||
- **YYYY-MM-DD HH:MM**: Initial task breakdown
|
||||
- **YYYY-MM-DD HH:MM**: Research completed - [selected approach]
|
||||
- **YYYY-MM-DD HH:MM**: T0X completed - [brief description of what was done]
|
||||
- **YYYY-MM-DD HH:MM**: Updated T0Y based on new findings
|
||||
<!-- META_INFORMATION -->
|
||||
80
skills/structured-plan-mode/assets/task-template.md
Normal file
80
skills/structured-plan-mode/assets/task-template.md
Normal file
@@ -0,0 +1,80 @@
|
||||
# T0X: [Task Name]
|
||||
|
||||
> **Template Purpose**: Copy this template for each implementation task (T01, T02, T03, etc.) in your `.plans/[feature-name]/tasks/` folder.
|
||||
|
||||
---
|
||||
|
||||
**Status**: 🟡 **Planned**
|
||||
**Effort**: [Small/Medium/Large]
|
||||
**Blocked By**: [List any blocking tasks or dependencies]
|
||||
|
||||
## Goal
|
||||
|
||||
[Describe what this task achieves - one clear, measurable objective]
|
||||
|
||||
## Context
|
||||
|
||||
[Explain how this fits into the overall feature, why it's needed, and how it relates to the selected approach from Research]
|
||||
|
||||
## Requirements
|
||||
|
||||
### 1. [Requirement Category 1]
|
||||
|
||||
[Describe the requirement]
|
||||
|
||||
**Key Considerations**:
|
||||
- [Consideration 1]
|
||||
- [Consideration 2]
|
||||
|
||||
### 2. [Requirement Category 2]
|
||||
|
||||
[Describe the requirement]
|
||||
|
||||
**Implementation Details**:
|
||||
- Step 1: [Description]
|
||||
- Step 2: [Description]
|
||||
- Step 3: [Description]
|
||||
|
||||
### 3. Integration Points
|
||||
|
||||
[Describe where this integrates with existing systems]
|
||||
|
||||
## Action Items
|
||||
|
||||
- [ ] [Specific action item 1]
|
||||
- [ ] [Specific action item 2]
|
||||
- [ ] [Specific action item 3]
|
||||
- [ ] Add error handling
|
||||
- [ ] Add telemetry/logging
|
||||
- [ ] Write tests
|
||||
|
||||
## Test Scenarios
|
||||
|
||||
- [ ] Happy path: [Description]
|
||||
- [ ] Error case: [Description]
|
||||
- [ ] Edge case: [Description]
|
||||
- [ ] Performance: [Description]
|
||||
|
||||
## Dependencies
|
||||
|
||||
- [Dependency 1]
|
||||
- [Dependency 2]
|
||||
|
||||
## Related Files
|
||||
|
||||
- `[file/path]` - Description
|
||||
- `[file/path]` - Description
|
||||
|
||||
## Execution Summary
|
||||
|
||||
<!-- Fill this section after completing this task -->
|
||||
|
||||
**Completed**: [YYYY-MM-DD HH:MM]
|
||||
|
||||
**What was implemented**:
|
||||
- [Key change 1]
|
||||
- [Key change 2]
|
||||
|
||||
**Challenges encountered**:
|
||||
- [Challenge 1 and resolution]
|
||||
|
||||
Reference in New Issue
Block a user