@neyugn/agent-kits 0.1.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 +514 -0
- package/README.vi.md +410 -0
- package/README.zh.md +410 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +422 -0
- package/kits/coder/ARCHITECTURE.md +289 -0
- package/kits/coder/agents/ai-engineer.md +344 -0
- package/kits/coder/agents/backend-specialist.md +270 -0
- package/kits/coder/agents/cloud-architect.md +363 -0
- package/kits/coder/agents/code-reviewer.md +284 -0
- package/kits/coder/agents/data-engineer.md +401 -0
- package/kits/coder/agents/database-specialist.md +251 -0
- package/kits/coder/agents/debugger.md +209 -0
- package/kits/coder/agents/devops-engineer.md +281 -0
- package/kits/coder/agents/documentation-writer.md +296 -0
- package/kits/coder/agents/frontend-specialist.md +298 -0
- package/kits/coder/agents/i18n-specialist.md +348 -0
- package/kits/coder/agents/integration-specialist.md +314 -0
- package/kits/coder/agents/mobile-developer.md +271 -0
- package/kits/coder/agents/multi-tenant-architect.md +281 -0
- package/kits/coder/agents/orchestrator.md +263 -0
- package/kits/coder/agents/performance-analyst.md +327 -0
- package/kits/coder/agents/project-planner.md +277 -0
- package/kits/coder/agents/queue-specialist.md +282 -0
- package/kits/coder/agents/realtime-specialist.md +267 -0
- package/kits/coder/agents/security-auditor.md +253 -0
- package/kits/coder/agents/test-engineer.md +315 -0
- package/kits/coder/agents/ux-researcher.md +388 -0
- package/kits/coder/rules/.cursorrules +287 -0
- package/kits/coder/rules/CLAUDE.md +287 -0
- package/kits/coder/rules/CODEX.md +287 -0
- package/kits/coder/rules/GEMINI.md +287 -0
- package/kits/coder/scripts/checklist.py +318 -0
- package/kits/coder/scripts/kit_status.py +292 -0
- package/kits/coder/scripts/skills_manager.py +243 -0
- package/kits/coder/scripts/verify_all.py +391 -0
- package/kits/coder/skills/accessibility-patterns/SKILL.md +372 -0
- package/kits/coder/skills/accessibility-patterns/scripts/a11y_checker.py +211 -0
- package/kits/coder/skills/ai-rag-patterns/SKILL.md +444 -0
- package/kits/coder/skills/api-patterns/SKILL.md +316 -0
- package/kits/coder/skills/api-patterns/assets/.gitkeep +1 -0
- package/kits/coder/skills/api-patterns/references/deep-dive.md +21 -0
- package/kits/coder/skills/api-patterns/scripts/api_validator.py +253 -0
- package/kits/coder/skills/api-patterns/scripts/validate.py +56 -0
- package/kits/coder/skills/auth-patterns/SKILL.md +267 -0
- package/kits/coder/skills/aws-patterns/SKILL.md +576 -0
- package/kits/coder/skills/brainstorming/SKILL.md +370 -0
- package/kits/coder/skills/brainstorming/assets/.gitkeep +1 -0
- package/kits/coder/skills/brainstorming/references/deep-dive.md +21 -0
- package/kits/coder/skills/brainstorming/scripts/validate.py +56 -0
- package/kits/coder/skills/clean-code/SKILL.md +240 -0
- package/kits/coder/skills/clean-code/assets/.gitkeep +1 -0
- package/kits/coder/skills/clean-code/references/deep-dive.md +21 -0
- package/kits/coder/skills/clean-code/scripts/lint_runner.py +186 -0
- package/kits/coder/skills/clean-code/scripts/validate.py +56 -0
- package/kits/coder/skills/database-design/SKILL.md +255 -0
- package/kits/coder/skills/database-design/assets/.gitkeep +1 -0
- package/kits/coder/skills/database-design/references/deep-dive.md +21 -0
- package/kits/coder/skills/database-design/scripts/schema_validator.py +272 -0
- package/kits/coder/skills/database-design/scripts/validate.py +56 -0
- package/kits/coder/skills/docker-patterns/SKILL.md +240 -0
- package/kits/coder/skills/documentation-templates/SKILL.md +441 -0
- package/kits/coder/skills/e2e-testing/SKILL.md +457 -0
- package/kits/coder/skills/flutter-patterns/SKILL.md +330 -0
- package/kits/coder/skills/frontend-design/SKILL.md +127 -0
- package/kits/coder/skills/github-actions/SKILL.md +349 -0
- package/kits/coder/skills/gitlab-ci-patterns/SKILL.md +466 -0
- package/kits/coder/skills/graphql-patterns/SKILL.md +558 -0
- package/kits/coder/skills/i18n-localization/SKILL.md +345 -0
- package/kits/coder/skills/i18n-localization/scripts/i18n_checker.py +267 -0
- package/kits/coder/skills/kubernetes-patterns/SKILL.md +357 -0
- package/kits/coder/skills/mermaid-diagrams/SKILL.md +351 -0
- package/kits/coder/skills/mobile-design/SKILL.md +305 -0
- package/kits/coder/skills/monitoring-observability/SKILL.md +458 -0
- package/kits/coder/skills/multi-tenancy/SKILL.md +317 -0
- package/kits/coder/skills/multi-tenancy/assets/.gitkeep +1 -0
- package/kits/coder/skills/multi-tenancy/references/deep-dive.md +21 -0
- package/kits/coder/skills/multi-tenancy/scripts/validate.py +56 -0
- package/kits/coder/skills/nodejs-best-practices/SKILL.md +220 -0
- package/kits/coder/skills/performance-profiling/SKILL.md +333 -0
- package/kits/coder/skills/performance-profiling/assets/.gitkeep +1 -0
- package/kits/coder/skills/performance-profiling/references/deep-dive.md +21 -0
- package/kits/coder/skills/performance-profiling/scripts/validate.py +56 -0
- package/kits/coder/skills/plan-writing/SKILL.md +360 -0
- package/kits/coder/skills/plan-writing/assets/.gitkeep +1 -0
- package/kits/coder/skills/plan-writing/references/deep-dive.md +21 -0
- package/kits/coder/skills/plan-writing/scripts/validate.py +56 -0
- package/kits/coder/skills/postgres-patterns/SKILL.md +361 -0
- package/kits/coder/skills/prompt-engineering/SKILL.md +277 -0
- package/kits/coder/skills/queue-patterns/SKILL.md +359 -0
- package/kits/coder/skills/queue-patterns/assets/.gitkeep +1 -0
- package/kits/coder/skills/queue-patterns/references/deep-dive.md +21 -0
- package/kits/coder/skills/queue-patterns/scripts/validate.py +56 -0
- package/kits/coder/skills/react-native-patterns/SKILL.md +393 -0
- package/kits/coder/skills/react-patterns/SKILL.md +319 -0
- package/kits/coder/skills/realtime-patterns/SKILL.md +506 -0
- package/kits/coder/skills/realtime-patterns/assets/.gitkeep +1 -0
- package/kits/coder/skills/realtime-patterns/references/deep-dive.md +21 -0
- package/kits/coder/skills/realtime-patterns/scripts/validate.py +56 -0
- package/kits/coder/skills/redis-patterns/SKILL.md +484 -0
- package/kits/coder/skills/security-fundamentals/SKILL.md +363 -0
- package/kits/coder/skills/security-fundamentals/assets/.gitkeep +1 -0
- package/kits/coder/skills/security-fundamentals/references/deep-dive.md +21 -0
- package/kits/coder/skills/security-fundamentals/scripts/security_scan.py +326 -0
- package/kits/coder/skills/security-fundamentals/scripts/validate.py +56 -0
- package/kits/coder/skills/seo-patterns/SKILL.md +262 -0
- package/kits/coder/skills/seo-patterns/scripts/seo_checker.py +211 -0
- package/kits/coder/skills/systematic-debugging/SKILL.md +478 -0
- package/kits/coder/skills/systematic-debugging/assets/.gitkeep +1 -0
- package/kits/coder/skills/systematic-debugging/references/deep-dive.md +21 -0
- package/kits/coder/skills/systematic-debugging/scripts/validate.py +56 -0
- package/kits/coder/skills/tailwind-patterns/SKILL.md +395 -0
- package/kits/coder/skills/terraform-patterns/SKILL.md +470 -0
- package/kits/coder/skills/testing-patterns/SKILL.md +285 -0
- package/kits/coder/skills/testing-patterns/assets/.gitkeep +1 -0
- package/kits/coder/skills/testing-patterns/references/deep-dive.md +21 -0
- package/kits/coder/skills/testing-patterns/scripts/test_runner.py +219 -0
- package/kits/coder/skills/testing-patterns/scripts/validate.py +56 -0
- package/kits/coder/skills/typescript-patterns/SKILL.md +417 -0
- package/kits/coder/skills/ui-ux-pro-max/SKILL.md +364 -0
- package/kits/coder/skills/ui-ux-pro-max/data/charts.csv +26 -0
- package/kits/coder/skills/ui-ux-pro-max/data/colors.csv +97 -0
- package/kits/coder/skills/ui-ux-pro-max/data/icons.csv +101 -0
- package/kits/coder/skills/ui-ux-pro-max/data/landing.csv +31 -0
- package/kits/coder/skills/ui-ux-pro-max/data/products.csv +97 -0
- package/kits/coder/skills/ui-ux-pro-max/data/prompts.csv +24 -0
- package/kits/coder/skills/ui-ux-pro-max/data/react-performance.csv +45 -0
- package/kits/coder/skills/ui-ux-pro-max/data/stacks/flutter.csv +53 -0
- package/kits/coder/skills/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -0
- package/kits/coder/skills/ui-ux-pro-max/data/stacks/nextjs.csv +53 -0
- package/kits/coder/skills/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -0
- package/kits/coder/skills/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -0
- package/kits/coder/skills/ui-ux-pro-max/data/stacks/react-native.csv +52 -0
- package/kits/coder/skills/ui-ux-pro-max/data/stacks/react.csv +54 -0
- package/kits/coder/skills/ui-ux-pro-max/data/stacks/shadcn.csv +61 -0
- package/kits/coder/skills/ui-ux-pro-max/data/stacks/svelte.csv +54 -0
- package/kits/coder/skills/ui-ux-pro-max/data/stacks/swiftui.csv +51 -0
- package/kits/coder/skills/ui-ux-pro-max/data/stacks/vue.csv +50 -0
- package/kits/coder/skills/ui-ux-pro-max/data/styles.csv +59 -0
- package/kits/coder/skills/ui-ux-pro-max/data/typography.csv +58 -0
- package/kits/coder/skills/ui-ux-pro-max/data/ui-reasoning.csv +101 -0
- package/kits/coder/skills/ui-ux-pro-max/data/ux-guidelines.csv +100 -0
- package/kits/coder/skills/ui-ux-pro-max/data/web-interface.csv +31 -0
- package/kits/coder/skills/ui-ux-pro-max/scripts/__pycache__/core.cpython-314.pyc +0 -0
- package/kits/coder/skills/ui-ux-pro-max/scripts/__pycache__/design_system.cpython-314.pyc +0 -0
- package/kits/coder/skills/ui-ux-pro-max/scripts/core.py +257 -0
- package/kits/coder/skills/ui-ux-pro-max/scripts/design_system.py +488 -0
- package/kits/coder/skills/ui-ux-pro-max/scripts/search.py +76 -0
- package/kits/coder/workflows/.gitkeep +20 -0
- package/kits/coder/workflows/create.md +152 -0
- package/kits/coder/workflows/debug.md +223 -0
- package/kits/coder/workflows/deploy.md +283 -0
- package/kits/coder/workflows/orchestrate.md +243 -0
- package/kits/coder/workflows/plan.md +134 -0
- package/kits/coder/workflows/test.md +237 -0
- package/kits/coder/workflows/ui-ux-pro-max.md +109 -0
- package/package.json +49 -0
|
@@ -0,0 +1,360 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: plan-writing
|
|
3
|
+
description: Structured task planning with clear breakdowns, dependencies, and verification criteria. Use when implementing features, refactoring, or any multi-step work. Covers WBS, task decomposition, estimation, and plan file formats.
|
|
4
|
+
allowed-tools: Read, Write, Edit
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Plan Writing - Structured Task Decomposition
|
|
8
|
+
|
|
9
|
+
> **Philosophy:** A good plan is a roadmap that prevents wrong turns. Break down before building up.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## π― Core Principle: Decompose β Estimate β Verify
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
β WRONG: "I'll implement the feature" β Jump into code
|
|
17
|
+
β
CORRECT: "I'll implement the feature" β Break into tasks β Estimate each β Define done criteria β Then code
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
**The Planning Approach:**
|
|
21
|
+
|
|
22
|
+
- Break large work into independently completable units
|
|
23
|
+
- Identify dependencies before they block you
|
|
24
|
+
- Define "done" clearly for each task
|
|
25
|
+
- Enable progress tracking and estimation
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## π When to Write a Plan
|
|
30
|
+
|
|
31
|
+
### Decision Matrix
|
|
32
|
+
|
|
33
|
+
| Work Type | Estimated Effort | Action |
|
|
34
|
+
| ------------------------ | ---------------- | ------------------- |
|
|
35
|
+
| Single file edit | < 30 min | Just do it |
|
|
36
|
+
| Multi-file change | 30 min - 2 hours | Mental checklist |
|
|
37
|
+
| New feature | > 2 hours | **Write plan file** |
|
|
38
|
+
| Architecture change | Any | **Write plan file** |
|
|
39
|
+
| Multi-component refactor | Any | **Write plan file** |
|
|
40
|
+
|
|
41
|
+
### Plan Required When:
|
|
42
|
+
|
|
43
|
+
- Changes span 3+ files
|
|
44
|
+
- Multiple developers involved
|
|
45
|
+
- User needs visibility into progress
|
|
46
|
+
- Work can be interrupted and resumed
|
|
47
|
+
- Trade-offs need documentation
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## π’ Task Breakdown Structure
|
|
52
|
+
|
|
53
|
+
### Hierarchy Levels
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
Level 1: Epic/Feature (What we're building)
|
|
57
|
+
β
|
|
58
|
+
Level 2: Major Components (Logical groupings)
|
|
59
|
+
β
|
|
60
|
+
Level 3: Tasks (Completable units)
|
|
61
|
+
β
|
|
62
|
+
Level 4: Subtasks (If task is still too large)
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Task Sizing Guidelines
|
|
66
|
+
|
|
67
|
+
| Task Duration | Status | Action Needed |
|
|
68
|
+
| ---------------- | ---------- | -------------------------- |
|
|
69
|
+
| < 15 min | Too small | Merge with related tasks |
|
|
70
|
+
| 15 min - 4 hours | Ideal | Perfect granularity |
|
|
71
|
+
| 4 - 8 hours | Acceptable | Consider splitting |
|
|
72
|
+
| > 8 hours | Too large | **Must decompose further** |
|
|
73
|
+
|
|
74
|
+
### Good Task Characteristics
|
|
75
|
+
|
|
76
|
+
| Characteristic | Description |
|
|
77
|
+
| ------------------- | ------------------------------------------------- |
|
|
78
|
+
| **Observable** | Has visible output when complete |
|
|
79
|
+
| **Verifiable** | Clear criteria to confirm done |
|
|
80
|
+
| **Independent** | Minimal dependencies blocking start |
|
|
81
|
+
| **Sized correctly** | 15 min to 4 hours |
|
|
82
|
+
| **Named clearly** | Action verb + object (e.g., "Create user schema") |
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## π Plan File Template
|
|
87
|
+
|
|
88
|
+
### File Naming Convention
|
|
89
|
+
|
|
90
|
+
```
|
|
91
|
+
.agent/plans/{task-slug}.md # Standard location
|
|
92
|
+
{task-slug}-plan.md # Alternative in root
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
**Slug format:** `feature-name` or `YYYYMMDD-feature-name`
|
|
96
|
+
|
|
97
|
+
### Template Structure
|
|
98
|
+
|
|
99
|
+
```markdown
|
|
100
|
+
# Plan: [Feature/Task Name]
|
|
101
|
+
|
|
102
|
+
> **Goal:** One-sentence summary of what success looks like
|
|
103
|
+
> **Status:** π‘ In Progress | β
Complete | βΈοΈ Blocked
|
|
104
|
+
> **Updated:** YYYY-MM-DD
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## Overview
|
|
109
|
+
|
|
110
|
+
[2-3 sentences on what this plan covers and why]
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## Tasks
|
|
115
|
+
|
|
116
|
+
### Phase 1: [Phase Name]
|
|
117
|
+
|
|
118
|
+
- [ ] **Task 1.1:** [Description]
|
|
119
|
+
- Files: `path/to/file.ts`
|
|
120
|
+
- Depends on: -
|
|
121
|
+
- Estimate: 30m
|
|
122
|
+
- Done when: [Verification criteria]
|
|
123
|
+
|
|
124
|
+
- [ ] **Task 1.2:** [Description]
|
|
125
|
+
- Files: `path/to/file.ts`, `path/to/other.ts`
|
|
126
|
+
- Depends on: Task 1.1
|
|
127
|
+
- Estimate: 1h
|
|
128
|
+
- Done when: [Verification criteria]
|
|
129
|
+
|
|
130
|
+
### Phase 2: [Phase Name]
|
|
131
|
+
|
|
132
|
+
- [ ] **Task 2.1:** [Description]
|
|
133
|
+
- Depends on: Phase 1 complete
|
|
134
|
+
- Estimate: 45m
|
|
135
|
+
- Done when: [Verification criteria]
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## Dependencies
|
|
140
|
+
|
|
141
|
+
| Dependency | Type | Status |
|
|
142
|
+
| -------------- | -------- | -------- |
|
|
143
|
+
| [External API] | External | β
Ready |
|
|
144
|
+
| [Task 1.1] | Internal | π WIP |
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Risks & Mitigations
|
|
149
|
+
|
|
150
|
+
| Risk | Impact | Mitigation |
|
|
151
|
+
| ----------------- | ------ | --------------- |
|
|
152
|
+
| [Potential issue] | High | [How to handle] |
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## Decisions Log
|
|
157
|
+
|
|
158
|
+
| Date | Decision | Rationale |
|
|
159
|
+
| ---------- | ------------------ | --------- |
|
|
160
|
+
| YYYY-MM-DD | [What was decided] | [Why] |
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## Progress Log
|
|
165
|
+
|
|
166
|
+
- **[YYYY-MM-DD]:** [What was accomplished]
|
|
167
|
+
- **[YYYY-MM-DD]:** [What was accomplished]
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## β±οΈ Estimation Framework
|
|
173
|
+
|
|
174
|
+
### Estimating Tasks
|
|
175
|
+
|
|
176
|
+
| Confidence Level | Multiplier | When to Apply |
|
|
177
|
+
| ---------------- | ---------- | ---------------------------------- |
|
|
178
|
+
| **High** | 1.2x | Done similar work before |
|
|
179
|
+
| **Medium** | 1.5x | Understand approach, some unknowns |
|
|
180
|
+
| **Low** | 2-3x | New territory, many unknowns |
|
|
181
|
+
|
|
182
|
+
### Estimation Checklist
|
|
183
|
+
|
|
184
|
+
Before estimating, consider:
|
|
185
|
+
|
|
186
|
+
- [ ] Implementation time (actual coding)
|
|
187
|
+
- [ ] Testing and verification time
|
|
188
|
+
- [ ] Edge case handling
|
|
189
|
+
- [ ] Documentation/comments
|
|
190
|
+
- [ ] Code review and revisions
|
|
191
|
+
- [ ] Integration testing
|
|
192
|
+
|
|
193
|
+
### Common Estimation Mistakes
|
|
194
|
+
|
|
195
|
+
| β Underestimates | β
Include In Estimate |
|
|
196
|
+
| --------------------------- | ------------------------------ |
|
|
197
|
+
| "Just wire things together" | Integration complexity |
|
|
198
|
+
| "Tests are quick" | Edge cases and debugging tests |
|
|
199
|
+
| "I know this codebase" | Context switching overhead |
|
|
200
|
+
| "Simple fix" | Regression testing |
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
## π Dependency Mapping
|
|
205
|
+
|
|
206
|
+
### Dependency Types
|
|
207
|
+
|
|
208
|
+
| Type | Description | Example |
|
|
209
|
+
| ------------ | --------------------------------- | ----------------------- |
|
|
210
|
+
| **Blocking** | Cannot start until complete | Schema before API |
|
|
211
|
+
| **Soft** | Can start, but need before finish | Tests before merge |
|
|
212
|
+
| **External** | Outside your control | API access, approval |
|
|
213
|
+
| **Resource** | Limited availability | Shared test environment |
|
|
214
|
+
|
|
215
|
+
### Dependency Visualization
|
|
216
|
+
|
|
217
|
+
```
|
|
218
|
+
Task A βββ¬ββ> Task C ββ> Task E
|
|
219
|
+
β
|
|
220
|
+
Task B βββ
|
|
221
|
+
Task D ββ> Task F (independent track)
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Handling Blocked Tasks
|
|
225
|
+
|
|
226
|
+
When blocked:
|
|
227
|
+
|
|
228
|
+
1. Document the blocker explicitly
|
|
229
|
+
2. Identify tasks that can proceed
|
|
230
|
+
3. Communicate blocker to stakeholders
|
|
231
|
+
4. Set reminder to check blocker status
|
|
232
|
+
|
|
233
|
+
---
|
|
234
|
+
|
|
235
|
+
## β
Verification Criteria
|
|
236
|
+
|
|
237
|
+
### "Done" Definition Framework
|
|
238
|
+
|
|
239
|
+
```markdown
|
|
240
|
+
A task is DONE when:
|
|
241
|
+
|
|
242
|
+
1. [ ] Code is written and compiles
|
|
243
|
+
2. [ ] Tests pass (unit + integration)
|
|
244
|
+
3. [ ] Edge cases handled
|
|
245
|
+
4. [ ] Documentation updated (if needed)
|
|
246
|
+
5. [ ] Code reviewed (if required)
|
|
247
|
+
6. [ ] Meets acceptance criteria
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### Writing Good Verification Criteria
|
|
251
|
+
|
|
252
|
+
| β Vague | β
Specific |
|
|
253
|
+
| ----------------- | ---------------------------------------------- |
|
|
254
|
+
| "Works correctly" | "Returns 200 for valid input, 400 for invalid" |
|
|
255
|
+
| "Tested" | "Unit tests cover happy path + 3 error cases" |
|
|
256
|
+
| "Integrated" | "API called successfully from frontend" |
|
|
257
|
+
| "Complete" | "All checklist items verified" |
|
|
258
|
+
|
|
259
|
+
---
|
|
260
|
+
|
|
261
|
+
## π Plan Maintenance
|
|
262
|
+
|
|
263
|
+
### When to Update Plan
|
|
264
|
+
|
|
265
|
+
| Event | Update Required |
|
|
266
|
+
| ------------------- | ---------------------------------- |
|
|
267
|
+
| Task completed | Check off, add to progress log |
|
|
268
|
+
| Blocker discovered | Add to dependencies, update status |
|
|
269
|
+
| Scope change | Revise tasks, re-estimate |
|
|
270
|
+
| New information | Update risks/decisions log |
|
|
271
|
+
| End of work session | Mark current progress |
|
|
272
|
+
|
|
273
|
+
### Plan Review Frequency
|
|
274
|
+
|
|
275
|
+
| Project Duration | Review Frequency |
|
|
276
|
+
| ---------------- | -------------------------- |
|
|
277
|
+
| < 1 day | Start and end |
|
|
278
|
+
| 1-3 days | Daily |
|
|
279
|
+
| > 3 days | Daily + weekly deep review |
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
|
|
283
|
+
## π¨ Anti-Patterns
|
|
284
|
+
|
|
285
|
+
| β Don't | β
Do |
|
|
286
|
+
| --------------------------- | ------------------------------------ |
|
|
287
|
+
| Giant monolithic tasks | Break into 15min-4hr chunks |
|
|
288
|
+
| "It depends on everything" | Map only true blocking dependencies |
|
|
289
|
+
| Estimate without buffers | Apply confidence multiplier |
|
|
290
|
+
| Skip verification criteria | Define "done" for every task |
|
|
291
|
+
| Never update the plan | Update as you learn |
|
|
292
|
+
| Plan at wrong granularity | Match plan detail to project size |
|
|
293
|
+
| Plan replaces communication | Plan supplements communication |
|
|
294
|
+
| Over-plan simple work | Use judgment on when plans add value |
|
|
295
|
+
|
|
296
|
+
---
|
|
297
|
+
|
|
298
|
+
## π Quick Reference: Task Naming
|
|
299
|
+
|
|
300
|
+
### Good Task Names
|
|
301
|
+
|
|
302
|
+
| Format | Examples |
|
|
303
|
+
| --------------------- | ---------------------------------- |
|
|
304
|
+
| `Create [thing]` | Create user authentication schema |
|
|
305
|
+
| `Implement [feature]` | Implement password reset flow |
|
|
306
|
+
| `Update [existing]` | Update API error handling |
|
|
307
|
+
| `Add [capability]` | Add email validation to signup |
|
|
308
|
+
| `Remove [deprecated]` | Remove legacy auth endpoints |
|
|
309
|
+
| `Fix [issue]` | Fix timezone conversion bug |
|
|
310
|
+
| `Migrate [from β to]` | Migrate users table to new schema |
|
|
311
|
+
| `Test [component]` | Test payment processing edge cases |
|
|
312
|
+
| `Document [topic]` | Document API authentication flow |
|
|
313
|
+
|
|
314
|
+
---
|
|
315
|
+
|
|
316
|
+
## π Plan Quality Checklist
|
|
317
|
+
|
|
318
|
+
Before starting implementation:
|
|
319
|
+
|
|
320
|
+
```markdown
|
|
321
|
+
## Plan Review
|
|
322
|
+
|
|
323
|
+
### Structure
|
|
324
|
+
|
|
325
|
+
- [ ] All tasks are 15min-4hr sized
|
|
326
|
+
- [ ] Dependencies are clearly mapped
|
|
327
|
+
- [ ] Phases/milestones are defined
|
|
328
|
+
|
|
329
|
+
### Clarity
|
|
330
|
+
|
|
331
|
+
- [ ] Each task has clear done criteria
|
|
332
|
+
- [ ] No ambiguous task descriptions
|
|
333
|
+
- [ ] Files affected are identified
|
|
334
|
+
|
|
335
|
+
### Feasibility
|
|
336
|
+
|
|
337
|
+
- [ ] Estimates include buffer
|
|
338
|
+
- [ ] Blockers are acknowledged
|
|
339
|
+
- [ ] Risks are documented
|
|
340
|
+
|
|
341
|
+
### Ready?
|
|
342
|
+
|
|
343
|
+
- [ ] Plan is saved in accessible location
|
|
344
|
+
- [ ] Stakeholders have visibility (if needed)
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
---
|
|
348
|
+
|
|
349
|
+
## π Related Skills
|
|
350
|
+
|
|
351
|
+
| Need | Skill |
|
|
352
|
+
| ------------------------- | ---------------------- |
|
|
353
|
+
| Discovery before planning | `brainstorming` |
|
|
354
|
+
| Debugging with structure | `systematic-debugging` |
|
|
355
|
+
| Clean implementation | `clean-code` |
|
|
356
|
+
| API task breakdown | `api-patterns` |
|
|
357
|
+
|
|
358
|
+
---
|
|
359
|
+
|
|
360
|
+
> **Remember:** Plans are living documents. The goal isn't a perfect planβit's enough structure to build confidently while adapting to reality.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# Assets directory - add templates, images, etc.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Reference Documentation for Plan Writing
|
|
2
|
+
|
|
3
|
+
[TODO: Add detailed reference content here]
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
[Detailed explanation of concepts]
|
|
8
|
+
|
|
9
|
+
## Deep Dive Topics
|
|
10
|
+
|
|
11
|
+
### Topic 1
|
|
12
|
+
|
|
13
|
+
[Content]
|
|
14
|
+
|
|
15
|
+
### Topic 2
|
|
16
|
+
|
|
17
|
+
[Content]
|
|
18
|
+
|
|
19
|
+
## Examples
|
|
20
|
+
|
|
21
|
+
[Real-world examples]
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
"""
|
|
3
|
+
Example validator for plan-writing
|
|
4
|
+
|
|
5
|
+
Usage:
|
|
6
|
+
python validate.py <project_path>
|
|
7
|
+
"""
|
|
8
|
+
|
|
9
|
+
import sys
|
|
10
|
+
from pathlib import Path
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
def validate(project_path: str) -> dict:
|
|
14
|
+
"""Main validation logic"""
|
|
15
|
+
results = {
|
|
16
|
+
'errors': [],
|
|
17
|
+
'warnings': [],
|
|
18
|
+
'passed': []
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
# TODO: Add validation logic
|
|
22
|
+
results['passed'].append('Placeholder validation passed')
|
|
23
|
+
|
|
24
|
+
return results
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
def print_results(results: dict):
|
|
28
|
+
"""Pretty print results"""
|
|
29
|
+
print("\nπ Validation Results\n")
|
|
30
|
+
|
|
31
|
+
if results['errors']:
|
|
32
|
+
print(f"β Errors ({len(results['errors'])})")
|
|
33
|
+
for error in results['errors']:
|
|
34
|
+
print(f" - {error}")
|
|
35
|
+
|
|
36
|
+
if results['warnings']:
|
|
37
|
+
print(f"\nβ οΈ Warnings ({len(results['warnings'])})")
|
|
38
|
+
for warning in results['warnings']:
|
|
39
|
+
print(f" - {warning}")
|
|
40
|
+
|
|
41
|
+
if results['passed']:
|
|
42
|
+
print(f"\nβ
Passed ({len(results['passed'])})")
|
|
43
|
+
for passed in results['passed']:
|
|
44
|
+
print(f" - {passed}")
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
if __name__ == "__main__":
|
|
48
|
+
if len(sys.argv) < 2:
|
|
49
|
+
print("Usage: python validate.py <project_path>")
|
|
50
|
+
sys.exit(1)
|
|
51
|
+
|
|
52
|
+
project_path = sys.argv[1]
|
|
53
|
+
results = validate(project_path)
|
|
54
|
+
print_results(results)
|
|
55
|
+
|
|
56
|
+
sys.exit(1 if results['errors'] else 0)
|