clavix 2.1.2 → 2.3.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/README.md +3 -3
- package/dist/cli/commands/init.js +11 -4
- package/dist/core/adapters/copilot-instructions-generator.d.ts +26 -0
- package/dist/core/adapters/copilot-instructions-generator.js +104 -0
- package/dist/core/agent-manager.js +0 -2
- package/dist/templates/agents/copilot-instructions.md +90 -0
- package/dist/templates/slash-commands/amp/archive.md +130 -3
- package/dist/templates/slash-commands/amp/deep.md +70 -10
- package/dist/templates/slash-commands/amp/fast.md +62 -15
- package/dist/templates/slash-commands/amp/implement.md +147 -2
- package/dist/templates/slash-commands/amp/plan.md +103 -7
- package/dist/templates/slash-commands/amp/prd.md +111 -13
- package/dist/templates/slash-commands/amp/start.md +77 -1
- package/dist/templates/slash-commands/amp/summarize.md +101 -21
- package/dist/templates/slash-commands/augment/archive.md +131 -4
- package/dist/templates/slash-commands/augment/deep.md +71 -11
- package/dist/templates/slash-commands/augment/fast.md +63 -16
- package/dist/templates/slash-commands/augment/implement.md +148 -3
- package/dist/templates/slash-commands/augment/plan.md +104 -8
- package/dist/templates/slash-commands/augment/prd.md +106 -8
- package/dist/templates/slash-commands/augment/start.md +78 -2
- package/dist/templates/slash-commands/augment/summarize.md +101 -21
- package/dist/templates/slash-commands/claude-code/archive.md +130 -3
- package/dist/templates/slash-commands/claude-code/deep.md +70 -10
- package/dist/templates/slash-commands/claude-code/fast.md +62 -15
- package/dist/templates/slash-commands/claude-code/implement.md +147 -2
- package/dist/templates/slash-commands/claude-code/plan.md +103 -7
- package/dist/templates/slash-commands/claude-code/prd.md +111 -13
- package/dist/templates/slash-commands/claude-code/start.md +77 -1
- package/dist/templates/slash-commands/claude-code/summarize.md +101 -21
- package/dist/templates/slash-commands/cline/archive.md +130 -3
- package/dist/templates/slash-commands/cline/deep.md +70 -10
- package/dist/templates/slash-commands/cline/fast.md +62 -15
- package/dist/templates/slash-commands/cline/implement.md +147 -2
- package/dist/templates/slash-commands/cline/plan.md +103 -7
- package/dist/templates/slash-commands/cline/prd.md +111 -13
- package/dist/templates/slash-commands/cline/start.md +77 -1
- package/dist/templates/slash-commands/cline/summarize.md +101 -21
- package/dist/templates/slash-commands/codebuddy/archive.md +130 -3
- package/dist/templates/slash-commands/codebuddy/deep.md +70 -10
- package/dist/templates/slash-commands/codebuddy/fast.md +62 -15
- package/dist/templates/slash-commands/codebuddy/implement.md +147 -2
- package/dist/templates/slash-commands/codebuddy/plan.md +103 -7
- package/dist/templates/slash-commands/codebuddy/prd.md +111 -13
- package/dist/templates/slash-commands/codebuddy/start.md +77 -1
- package/dist/templates/slash-commands/codebuddy/summarize.md +101 -21
- package/dist/templates/slash-commands/codex/archive.md +130 -3
- package/dist/templates/slash-commands/codex/deep.md +70 -10
- package/dist/templates/slash-commands/codex/fast.md +62 -15
- package/dist/templates/slash-commands/codex/implement.md +147 -2
- package/dist/templates/slash-commands/codex/plan.md +103 -7
- package/dist/templates/slash-commands/codex/prd.md +111 -13
- package/dist/templates/slash-commands/codex/start.md +77 -1
- package/dist/templates/slash-commands/codex/summarize.md +101 -21
- package/dist/templates/slash-commands/crush/archive.md +130 -3
- package/dist/templates/slash-commands/crush/deep.md +70 -10
- package/dist/templates/slash-commands/crush/fast.md +62 -15
- package/dist/templates/slash-commands/crush/implement.md +147 -2
- package/dist/templates/slash-commands/crush/plan.md +103 -7
- package/dist/templates/slash-commands/crush/prd.md +111 -13
- package/dist/templates/slash-commands/crush/start.md +77 -1
- package/dist/templates/slash-commands/crush/summarize.md +101 -21
- package/dist/templates/slash-commands/cursor/archive.md +130 -3
- package/dist/templates/slash-commands/cursor/deep.md +70 -10
- package/dist/templates/slash-commands/cursor/fast.md +62 -15
- package/dist/templates/slash-commands/cursor/implement.md +147 -2
- package/dist/templates/slash-commands/cursor/plan.md +103 -7
- package/dist/templates/slash-commands/cursor/prd.md +111 -13
- package/dist/templates/slash-commands/cursor/start.md +77 -1
- package/dist/templates/slash-commands/cursor/summarize.md +101 -21
- package/dist/templates/slash-commands/droid/archive.md +130 -3
- package/dist/templates/slash-commands/droid/deep.md +70 -10
- package/dist/templates/slash-commands/droid/fast.md +62 -15
- package/dist/templates/slash-commands/droid/implement.md +147 -2
- package/dist/templates/slash-commands/droid/plan.md +103 -7
- package/dist/templates/slash-commands/droid/prd.md +111 -13
- package/dist/templates/slash-commands/droid/start.md +77 -1
- package/dist/templates/slash-commands/droid/summarize.md +101 -21
- package/dist/templates/slash-commands/gemini/archive.toml +132 -4
- package/dist/templates/slash-commands/gemini/deep.toml +72 -11
- package/dist/templates/slash-commands/gemini/fast.toml +64 -16
- package/dist/templates/slash-commands/gemini/implement.toml +149 -3
- package/dist/templates/slash-commands/gemini/plan.toml +116 -13
- package/dist/templates/slash-commands/gemini/prd.toml +107 -8
- package/dist/templates/slash-commands/gemini/start.toml +79 -2
- package/dist/templates/slash-commands/gemini/summarize.toml +102 -21
- package/dist/templates/slash-commands/kilocode/archive.md +130 -3
- package/dist/templates/slash-commands/kilocode/deep.md +70 -10
- package/dist/templates/slash-commands/kilocode/fast.md +62 -15
- package/dist/templates/slash-commands/kilocode/implement.md +147 -2
- package/dist/templates/slash-commands/kilocode/plan.md +103 -7
- package/dist/templates/slash-commands/kilocode/prd.md +111 -13
- package/dist/templates/slash-commands/kilocode/start.md +77 -1
- package/dist/templates/slash-commands/kilocode/summarize.md +101 -21
- package/dist/templates/slash-commands/opencode/archive.md +130 -3
- package/dist/templates/slash-commands/opencode/deep.md +70 -10
- package/dist/templates/slash-commands/opencode/fast.md +62 -15
- package/dist/templates/slash-commands/opencode/implement.md +147 -2
- package/dist/templates/slash-commands/opencode/plan.md +103 -7
- package/dist/templates/slash-commands/opencode/prd.md +111 -13
- package/dist/templates/slash-commands/opencode/start.md +77 -1
- package/dist/templates/slash-commands/opencode/summarize.md +101 -21
- package/dist/templates/slash-commands/qwen/archive.toml +132 -4
- package/dist/templates/slash-commands/qwen/deep.toml +72 -11
- package/dist/templates/slash-commands/qwen/fast.toml +64 -16
- package/dist/templates/slash-commands/qwen/implement.toml +149 -3
- package/dist/templates/slash-commands/qwen/plan.toml +116 -13
- package/dist/templates/slash-commands/qwen/prd.toml +107 -8
- package/dist/templates/slash-commands/qwen/start.toml +79 -2
- package/dist/templates/slash-commands/qwen/summarize.toml +102 -21
- package/dist/templates/slash-commands/roocode/archive.md +130 -3
- package/dist/templates/slash-commands/roocode/deep.md +70 -10
- package/dist/templates/slash-commands/roocode/fast.md +62 -15
- package/dist/templates/slash-commands/roocode/implement.md +147 -2
- package/dist/templates/slash-commands/roocode/plan.md +103 -7
- package/dist/templates/slash-commands/roocode/prd.md +111 -13
- package/dist/templates/slash-commands/roocode/start.md +77 -1
- package/dist/templates/slash-commands/roocode/summarize.md +101 -21
- package/dist/templates/slash-commands/windsurf/archive.md +130 -3
- package/dist/templates/slash-commands/windsurf/deep.md +70 -10
- package/dist/templates/slash-commands/windsurf/fast.md +62 -15
- package/dist/templates/slash-commands/windsurf/implement.md +147 -2
- package/dist/templates/slash-commands/windsurf/plan.md +103 -7
- package/dist/templates/slash-commands/windsurf/prd.md +111 -13
- package/dist/templates/slash-commands/windsurf/start.md +77 -1
- package/dist/templates/slash-commands/windsurf/summarize.md +101 -21
- package/dist/types/agent.d.ts +1 -1
- package/package.json +2 -2
- package/dist/core/adapters/copilot-adapter.d.ts +0 -24
- package/dist/core/adapters/copilot-adapter.js +0 -88
- package/dist/templates/slash-commands/copilot/archive.agent.md +0 -164
- package/dist/templates/slash-commands/copilot/deep.agent.md +0 -147
- package/dist/templates/slash-commands/copilot/fast.agent.md +0 -136
- package/dist/templates/slash-commands/copilot/implement.agent.md +0 -122
- package/dist/templates/slash-commands/copilot/plan.agent.md +0 -69
- package/dist/templates/slash-commands/copilot/prd.agent.md +0 -80
- package/dist/templates/slash-commands/copilot/start.agent.md +0 -66
- package/dist/templates/slash-commands/copilot/summarize.agent.md +0 -99
|
@@ -83,7 +83,7 @@ Generated by Clavix /clavix:implement
|
|
|
83
83
|
|
|
84
84
|
## Important Rules
|
|
85
85
|
|
|
86
|
-
|
|
86
|
+
**DO**:
|
|
87
87
|
- Read tasks.md to find the current task
|
|
88
88
|
- Implement ONE task at a time
|
|
89
89
|
- Mark tasks complete by changing `[ ]` to `[x]`
|
|
@@ -91,13 +91,88 @@ Generated by Clavix /clavix:implement
|
|
|
91
91
|
- Reference the PRD for detailed requirements
|
|
92
92
|
- Ask for clarification when tasks are ambiguous
|
|
93
93
|
|
|
94
|
-
|
|
94
|
+
**DON'T**:
|
|
95
95
|
- Skip tasks or implement out of order
|
|
96
96
|
- Mark tasks complete before actually implementing them
|
|
97
97
|
- Modify multiple tasks' checkboxes at once (only current task)
|
|
98
98
|
- Create commits if strategy is 'none'
|
|
99
99
|
- Assume what code to write - use PRD as source of truth
|
|
100
100
|
|
|
101
|
+
## Task Blocking Protocol
|
|
102
|
+
|
|
103
|
+
**When a task is blocked** (cannot be completed), follow this protocol:
|
|
104
|
+
|
|
105
|
+
### Step 1: Detect Blocking Issues
|
|
106
|
+
|
|
107
|
+
Common blocking scenarios:
|
|
108
|
+
- **Missing dependencies**: API keys, credentials, external services not available
|
|
109
|
+
- **Unclear requirements**: Task description too vague or conflicts with PRD
|
|
110
|
+
- **External blockers**: Need design assets, content, or third-party integration not ready
|
|
111
|
+
- **Technical blockers**: Required library incompatible, environment issue, access problem
|
|
112
|
+
- **Resource blockers**: Need database, server, or infrastructure not yet set up
|
|
113
|
+
|
|
114
|
+
### Step 2: Immediate User Communication
|
|
115
|
+
|
|
116
|
+
**Stop implementation and ask user immediately:**
|
|
117
|
+
```
|
|
118
|
+
"Task blocked: [Task description]
|
|
119
|
+
|
|
120
|
+
Blocking issue: [Specific blocker, e.g., 'Missing Stripe API key for payment integration']
|
|
121
|
+
|
|
122
|
+
Options to proceed:
|
|
123
|
+
1. **Provide missing resource** - [What user needs to provide]
|
|
124
|
+
2. **Break into sub-tasks** - I can implement [unblocked parts] now and defer [blocked part]
|
|
125
|
+
3. **Skip for now** - Mark as [BLOCKED], continue with next task, return later
|
|
126
|
+
|
|
127
|
+
Which option would you like?"
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Step 3: Resolution Strategies
|
|
131
|
+
|
|
132
|
+
**Option A: User Provides Resource**
|
|
133
|
+
- Wait for user to provide (API key, design, clarification)
|
|
134
|
+
- Once provided, continue with task implementation
|
|
135
|
+
|
|
136
|
+
**Option B: Create Sub-Tasks** (preferred when possible)
|
|
137
|
+
- Identify what CAN be done without the blocker
|
|
138
|
+
- Break task into unblocked sub-tasks
|
|
139
|
+
- Example: "Implement payment integration" →
|
|
140
|
+
- [x] Create payment service interface (can do now)
|
|
141
|
+
- [ ] [BLOCKED: Need Stripe API key] Integrate Stripe SDK
|
|
142
|
+
- [ ] Add payment UI components (can do now)
|
|
143
|
+
- Implement unblocked sub-tasks, mark blocked ones with [BLOCKED] tag
|
|
144
|
+
|
|
145
|
+
**Option C: Skip and Mark Blocked**
|
|
146
|
+
- Add [BLOCKED] tag to task in tasks.md: `- [ ] [BLOCKED: Missing API key] Task description`
|
|
147
|
+
- Note the blocker reason
|
|
148
|
+
- Move to next task
|
|
149
|
+
- Return to blocked tasks when unblocked
|
|
150
|
+
|
|
151
|
+
### Step 4: Track Blocked Tasks
|
|
152
|
+
|
|
153
|
+
**In tasks.md, use [BLOCKED] notation:**
|
|
154
|
+
```markdown
|
|
155
|
+
## Phase 2: Integration
|
|
156
|
+
- [x] Create API client structure
|
|
157
|
+
- [ ] [BLOCKED: Waiting for API endpoint spec] Implement data sync
|
|
158
|
+
- [ ] Add error handling for API calls
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
**At end of implement session:**
|
|
162
|
+
- List all blocked tasks
|
|
163
|
+
- Remind user what's needed to unblock each one
|
|
164
|
+
- Suggest next steps
|
|
165
|
+
|
|
166
|
+
### Common Blocking Scenarios & Resolutions
|
|
167
|
+
|
|
168
|
+
| Blocker Type | Detection | Resolution |
|
|
169
|
+
|--------------|-----------|------------|
|
|
170
|
+
| Missing API key/credentials | Code requires authentication | Ask user for credentials OR stub with mock for now |
|
|
171
|
+
| Vague requirements | Unclear what to implement | Ask specific questions OR propose implementation for approval |
|
|
172
|
+
| External dependency | Service/API not available | Create interface/mock OR skip and defer |
|
|
173
|
+
| Environment issue | Can't run/test code | Ask user to fix environment OR implement without testing (note risk) |
|
|
174
|
+
| Design/content missing | Need specific assets | Create placeholder OR wait for actual assets |
|
|
175
|
+
|
|
101
176
|
## Example Workflow
|
|
102
177
|
|
|
103
178
|
```
|
|
@@ -113,6 +188,20 @@ Generated by Clavix /clavix:implement
|
|
|
113
188
|
- Continue or wait for user
|
|
114
189
|
```
|
|
115
190
|
|
|
191
|
+
## Workflow Navigation
|
|
192
|
+
|
|
193
|
+
**You are here:** Implement (Task Execution)
|
|
194
|
+
|
|
195
|
+
**Common workflows:**
|
|
196
|
+
- **Full workflow**: `/clavix:plan` → `/clavix:implement` → [execute all tasks] → `/clavix:archive`
|
|
197
|
+
- **Resume work**: `/clavix:implement` → Continue from last incomplete task
|
|
198
|
+
- **Iterative**: `/clavix:implement` → [complete task] → [pause] → `/clavix:implement` → [continue]
|
|
199
|
+
|
|
200
|
+
**Related commands:**
|
|
201
|
+
- `/clavix:plan` - Generate/regenerate task breakdown (previous step)
|
|
202
|
+
- `/clavix:archive` - Archive completed project (final step)
|
|
203
|
+
- `/clavix:prd` - Review PRD for context during implementation
|
|
204
|
+
|
|
116
205
|
## Tips
|
|
117
206
|
|
|
118
207
|
- The implementation is meant to be iterative and collaborative
|
|
@@ -120,3 +209,59 @@ Generated by Clavix /clavix:implement
|
|
|
120
209
|
- Tasks are designed to be atomic and independently implementable
|
|
121
210
|
- Use the PRD as the authoritative source for "what to build"
|
|
122
211
|
- Use tasks.md as the guide for "in what order"
|
|
212
|
+
|
|
213
|
+
## Troubleshooting
|
|
214
|
+
|
|
215
|
+
### Issue: `.clavix-implement-config.json` not found
|
|
216
|
+
**Cause**: User hasn't run `clavix implement` CLI command first
|
|
217
|
+
**Solution** (inline):
|
|
218
|
+
- Error: "Config file not found. Run `clavix implement` first to initialize"
|
|
219
|
+
- CLI creates config and shows first task
|
|
220
|
+
- AI agent should wait for config before proceeding
|
|
221
|
+
|
|
222
|
+
### Issue: Cannot find next incomplete task in tasks.md
|
|
223
|
+
**Cause**: All tasks completed OR tasks.md corrupted
|
|
224
|
+
**Solution**:
|
|
225
|
+
- Check if all tasks are `[x]` - if yes, congratulate completion!
|
|
226
|
+
- Suggest `/clavix:archive` for completed project
|
|
227
|
+
- If tasks.md corrupted, ask user to review/regenerate
|
|
228
|
+
|
|
229
|
+
### Issue: Task description unclear or conflicts with PRD
|
|
230
|
+
**Cause**: Task breakdown was too vague or PRD changed
|
|
231
|
+
**Solution** (inline - covered by Task Blocking Protocol):
|
|
232
|
+
- Stop and ask user for clarification
|
|
233
|
+
- Reference PRD section if mentioned
|
|
234
|
+
- Propose interpretation for user approval
|
|
235
|
+
- Update task description in tasks.md after clarification
|
|
236
|
+
|
|
237
|
+
### Issue: Git commit fails (wrong strategy, hook error, etc.)
|
|
238
|
+
**Cause**: Git configuration issue or commit hook failure
|
|
239
|
+
**Solution**:
|
|
240
|
+
- Show error to user
|
|
241
|
+
- Suggest checking git status manually
|
|
242
|
+
- Ask if should continue without commit or fix issue first
|
|
243
|
+
- Note: Commits are convenience, not blocker - can proceed without
|
|
244
|
+
|
|
245
|
+
### Issue: Multiple [BLOCKED] tasks accumulating
|
|
246
|
+
**Cause**: Dependencies or blockers not being resolved
|
|
247
|
+
**Solution**:
|
|
248
|
+
- After 3+ blocked tasks, pause and report to user
|
|
249
|
+
- List all blockers and what's needed to resolve
|
|
250
|
+
- Ask user to prioritize: unblock tasks OR continue with unblocked ones
|
|
251
|
+
- Consider if project should be paused until blockers cleared
|
|
252
|
+
|
|
253
|
+
### Issue: Task completed but tests failing
|
|
254
|
+
**Cause**: Implementation doesn't meet requirements
|
|
255
|
+
**Solution**:
|
|
256
|
+
- Do NOT mark task as complete if tests fail
|
|
257
|
+
- Fix failing tests before marking [x]
|
|
258
|
+
- If tests are incorrectly written, fix tests first
|
|
259
|
+
- Task isn't done until tests pass
|
|
260
|
+
|
|
261
|
+
### Issue: Implementing in wrong order (skipped dependencies)
|
|
262
|
+
**Cause**: AI agent or user jumped ahead
|
|
263
|
+
**Solution**:
|
|
264
|
+
- Stop and review tasks.md order
|
|
265
|
+
- Check if skipped task was a dependency
|
|
266
|
+
- Implement missed dependency first
|
|
267
|
+
- Follow sequential order unless explicitly instructed otherwise
|
|
@@ -9,9 +9,12 @@ You are helping the user generate a CLEAR-optimized implementation task breakdow
|
|
|
9
9
|
|
|
10
10
|
## Instructions
|
|
11
11
|
|
|
12
|
+
### Part A: Procedural Steps (CLI Commands)
|
|
13
|
+
|
|
12
14
|
1. **Locate the PRD outputs**:
|
|
13
15
|
- Look for the most recent artifacts in `.clavix/outputs/[project-name]/`
|
|
14
16
|
- Accepted sources: `full-prd.md`, `quick-prd.md`, `mini-prd.md`, or `optimized-prompt.md`
|
|
17
|
+
- **If not found**: Error inline - "No PRD found in `.clavix/outputs/`. Use `/clavix:prd` or `/clavix:summarize` first."
|
|
15
18
|
|
|
16
19
|
2. **Run the plan command**:
|
|
17
20
|
```bash
|
|
@@ -30,15 +33,47 @@ You are helping the user generate a CLEAR-optimized implementation task breakdow
|
|
|
30
33
|
|
|
31
34
|
The CLI will prompt you to pick a project when multiple outputs are available.
|
|
32
35
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
36
|
+
### Part B: Behavioral Guidance (Task Breakdown Strategy)
|
|
37
|
+
|
|
38
|
+
3. **How to structure tasks** (CLEAR-optimized task breakdown):
|
|
39
|
+
|
|
40
|
+
**Task Granularity Principles:**
|
|
41
|
+
- **[C] Concise**: Each task = 1 clear action (not "Build authentication system", but "Create user registration endpoint")
|
|
42
|
+
- **[L] Logical**: Tasks flow in implementation order (database schema → backend logic → frontend UI)
|
|
43
|
+
- **[E] Explicit**: Tasks specify deliverable (not "Add tests", but "Write unit tests for user service with >80% coverage")
|
|
44
|
+
|
|
45
|
+
**Atomic Task Guidelines:**
|
|
46
|
+
- **Ideal size**: Completable in 15-60 minutes
|
|
47
|
+
- **Too large**: "Implement user authentication" → Break into registration, login, logout, password reset
|
|
48
|
+
- **Too small**: "Import React" → Combine with "Setup component structure"
|
|
49
|
+
- **Dependencies**: If Task B needs Task A, ensure A comes first
|
|
50
|
+
|
|
51
|
+
**Phase Organization:**
|
|
52
|
+
- Group related tasks into phases (Setup, Core Features, Testing, Polish)
|
|
53
|
+
- Each phase should be independently deployable when possible
|
|
54
|
+
- Critical path first (must-haves before nice-to-haves)
|
|
38
55
|
|
|
39
|
-
4. **
|
|
56
|
+
4. **Review and customize generated tasks**:
|
|
57
|
+
- The command will generate `tasks.md` in the PRD folder
|
|
58
|
+
- Tasks are organized into logical phases with CLEAR principles
|
|
59
|
+
- Each task includes:
|
|
60
|
+
- Checkbox `- [ ]` for tracking
|
|
61
|
+
- Clear deliverable description
|
|
62
|
+
- Optional reference to PRD section `(ref: PRD Section)`
|
|
63
|
+
- **You can edit tasks.md** before implementing:
|
|
64
|
+
- Add/remove tasks
|
|
65
|
+
- Adjust granularity
|
|
66
|
+
- Reorder for better flow
|
|
67
|
+
- Add notes or sub-tasks
|
|
68
|
+
|
|
69
|
+
5. **CLEAR Task Labeling** (optional, for education):
|
|
70
|
+
When reviewing tasks, you can annotate improvements:
|
|
71
|
+
- **[C]**: "Split vague 'Add UI' into 3 concrete tasks"
|
|
72
|
+
- **[L]**: "Reordered tasks: database schema before API endpoints"
|
|
73
|
+
- **[E]**: "Added specific acceptance criteria (>80% test coverage)"
|
|
74
|
+
|
|
75
|
+
6. **Next steps**:
|
|
40
76
|
- Review and edit `tasks.md` if needed
|
|
41
|
-
- Add, remove, or modify tasks as appropriate
|
|
42
77
|
- Then run `/clavix:implement` to start implementation
|
|
43
78
|
|
|
44
79
|
## Task Format
|
|
@@ -67,6 +102,20 @@ The generated `tasks.md` will look like:
|
|
|
67
102
|
*Generated by Clavix /clavix:plan*
|
|
68
103
|
```
|
|
69
104
|
|
|
105
|
+
## Workflow Navigation
|
|
106
|
+
|
|
107
|
+
**You are here:** Plan (Task Breakdown)
|
|
108
|
+
|
|
109
|
+
**Common workflows:**
|
|
110
|
+
- **PRD workflow**: `/clavix:prd` → `/clavix:plan` → `/clavix:implement` → `/clavix:archive`
|
|
111
|
+
- **Conversation workflow**: `/clavix:summarize` → `/clavix:plan` → `/clavix:implement` → `/clavix:archive`
|
|
112
|
+
- **Standalone**: [Existing PRD] → `/clavix:plan` → Review tasks.md → `/clavix:implement`
|
|
113
|
+
|
|
114
|
+
**Related commands:**
|
|
115
|
+
- `/clavix:prd` - Generate PRD (typical previous step)
|
|
116
|
+
- `/clavix:summarize` - Extract mini-PRD from conversation (alternative previous step)
|
|
117
|
+
- `/clavix:implement` - Execute generated tasks (next step)
|
|
118
|
+
|
|
70
119
|
## Tips
|
|
71
120
|
|
|
72
121
|
- Tasks are automatically optimized using CLEAR framework
|
|
@@ -75,3 +124,50 @@ The generated `tasks.md` will look like:
|
|
|
75
124
|
- Supports mini-PRD outputs from `/clavix:summarize` and session workflows via `--session` or `--active-session`
|
|
76
125
|
- You can manually edit tasks.md before implementing
|
|
77
126
|
- Use `--overwrite` flag to regenerate if needed
|
|
127
|
+
|
|
128
|
+
## Troubleshooting
|
|
129
|
+
|
|
130
|
+
### Issue: No PRD found in `.clavix/outputs/`
|
|
131
|
+
**Cause**: User hasn't generated a PRD yet
|
|
132
|
+
**Solution** (inline - already in template):
|
|
133
|
+
- Show error: "No PRD found in `.clavix/outputs/`"
|
|
134
|
+
- Suggest: "Use `/clavix:prd` or `/clavix:summarize` to generate one first"
|
|
135
|
+
- Do not proceed with plan generation
|
|
136
|
+
|
|
137
|
+
### Issue: Generated tasks are too granular (100+ tasks)
|
|
138
|
+
**Cause**: Over-decomposition or large project scope
|
|
139
|
+
**Solution**:
|
|
140
|
+
- Group related micro-tasks into larger atomic tasks
|
|
141
|
+
- Each task should be 15-60 minutes, not 5 minutes
|
|
142
|
+
- Combine setup/configuration tasks
|
|
143
|
+
- Suggest breaking project into multiple PRDs if truly massive
|
|
144
|
+
|
|
145
|
+
### Issue: Generated tasks are too high-level (only 3-4 tasks)
|
|
146
|
+
**Cause**: PRD was too vague or task breakdown too coarse
|
|
147
|
+
**Solution**:
|
|
148
|
+
- Review PRD - if vague, regenerate with more detail
|
|
149
|
+
- Break each high-level task into 3-5 concrete sub-tasks
|
|
150
|
+
- Each task should have a clear, testable deliverable
|
|
151
|
+
|
|
152
|
+
### Issue: Tasks don't follow logical dependency order
|
|
153
|
+
**Cause**: Generator didn't detect dependencies correctly
|
|
154
|
+
**Solution**:
|
|
155
|
+
- Manually reorder in tasks.md (database before API, API before UI)
|
|
156
|
+
- Follow CLEAR [L] Logic principle: ensure sequential coherence
|
|
157
|
+
- Group by technical layers or feature completion
|
|
158
|
+
|
|
159
|
+
### Issue: Tasks conflict with PRD or duplicate work
|
|
160
|
+
**Cause**: Misinterpretation of PRD or redundant task generation
|
|
161
|
+
**Solution**:
|
|
162
|
+
- Review PRD and tasks side-by-side
|
|
163
|
+
- Remove duplicate tasks
|
|
164
|
+
- Align tasks with PRD requirements
|
|
165
|
+
- Use `--overwrite` to regenerate after PRD clarification
|
|
166
|
+
|
|
167
|
+
### Issue: `tasks.md` already exists, unsure if should regenerate
|
|
168
|
+
**Cause**: Previous plan exists for this PRD
|
|
169
|
+
**Solution**:
|
|
170
|
+
- Check if tasks.md has progress (any [x] checkboxes)
|
|
171
|
+
- If no progress: Safe to use `--overwrite`
|
|
172
|
+
- If progress exists: Review carefully before overwriting
|
|
173
|
+
- Consider manual edits instead of full regeneration
|
|
@@ -9,19 +9,63 @@ You are helping the user create a Product Requirements Document (PRD) using Clav
|
|
|
9
9
|
|
|
10
10
|
## Instructions
|
|
11
11
|
|
|
12
|
-
1. Guide the user through these strategic questions, one at a time:
|
|
13
|
-
|
|
14
|
-
**Question 1**:
|
|
15
|
-
|
|
16
|
-
**
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
12
|
+
1. Guide the user through these strategic questions, **one at a time** with validation:
|
|
13
|
+
|
|
14
|
+
**Question 1**: What are we building and why? (Problem + goal in 2-3 sentences)
|
|
15
|
+
|
|
16
|
+
- **Validation**: Must have both problem AND goal stated clearly
|
|
17
|
+
- **If vague/short** (e.g., "a dashboard"): Ask probing questions:
|
|
18
|
+
- "What specific problem does this dashboard solve?"
|
|
19
|
+
- "Who will use this and what decisions will they make with it?"
|
|
20
|
+
- "What happens if this doesn't exist?"
|
|
21
|
+
- **If "I don't know"**: Ask:
|
|
22
|
+
- "What triggered the need for this?"
|
|
23
|
+
- "Can you describe the current pain point or opportunity?"
|
|
24
|
+
- **Good answer example**: "Sales managers can't quickly identify at-risk deals in our 10K+ deal pipeline. Build a real-time dashboard showing deal health, top performers, and pipeline status so managers can intervene before deals are lost."
|
|
25
|
+
|
|
26
|
+
**Question 2**: What are the must-have core features? (List 3-5 critical features)
|
|
27
|
+
|
|
28
|
+
- **Validation**: At least 2 concrete features provided
|
|
29
|
+
- **If vague** (e.g., "user management"): Probe deeper:
|
|
30
|
+
- "What specific user management capabilities? (registration, roles, permissions, profile management?)"
|
|
31
|
+
- "Which feature would you build first if you could only build one?"
|
|
32
|
+
- **If too many** (7+ features): Help prioritize:
|
|
33
|
+
- "If you had to launch with only 3 features, which would they be?"
|
|
34
|
+
- "Which features are launch-blockers vs nice-to-have?"
|
|
35
|
+
- **If "I don't know"**: Ask:
|
|
36
|
+
- "Walk me through how someone would use this - what would they do first?"
|
|
37
|
+
- "What's the core value this provides?"
|
|
38
|
+
|
|
39
|
+
**Question 3**: Tech stack and requirements? (Technologies, integrations, constraints)
|
|
40
|
+
|
|
41
|
+
- **Optional**: Can skip if extending existing project
|
|
42
|
+
- **If vague** (e.g., "modern stack"): Probe:
|
|
43
|
+
- "What technologies are already in use that this must integrate with?"
|
|
44
|
+
- "Any specific frameworks or languages your team prefers?"
|
|
45
|
+
- "Are there performance requirements (load time, concurrent users)?"
|
|
46
|
+
- **If "I don't know"**: Suggest common stacks based on project type or skip
|
|
47
|
+
|
|
48
|
+
**Question 4**: What is explicitly OUT of scope? (What are we NOT building?)
|
|
49
|
+
|
|
50
|
+
- **Validation**: At least 1 explicit exclusion
|
|
51
|
+
- **Why important**: Prevents scope creep and clarifies boundaries
|
|
52
|
+
- **If stuck**: Suggest common exclusions:
|
|
53
|
+
- "Are we building admin dashboards? Mobile apps? API integrations?"
|
|
54
|
+
- "Are we handling payments? User authentication? Email notifications?"
|
|
55
|
+
- **If "I don't know"**: Provide project-specific prompts based on previous answers
|
|
56
|
+
|
|
57
|
+
**Question 5**: Any additional context or requirements?
|
|
58
|
+
|
|
59
|
+
- **Optional**: Press Enter to skip
|
|
60
|
+
- **Helpful areas**: Compliance needs, accessibility, localization, deadlines, team constraints
|
|
61
|
+
|
|
62
|
+
2. **Before proceeding to document generation**, verify minimum viable answers:
|
|
63
|
+
- Q1: Both problem AND goal stated
|
|
64
|
+
- Q2: At least 2 concrete features
|
|
65
|
+
- Q4: At least 1 explicit scope exclusion
|
|
66
|
+
- If missing critical info, ask targeted follow-ups
|
|
67
|
+
|
|
68
|
+
3. After collecting and validating all answers, generate TWO documents:
|
|
25
69
|
|
|
26
70
|
**Full PRD** (comprehensive):
|
|
27
71
|
```markdown
|
|
@@ -72,9 +116,63 @@ You are helping the user create a Product Requirements Document (PRD) using Clav
|
|
|
72
116
|
|
|
73
117
|
**Note:** Adaptive (A) and Reflective (R) components are not applicable to PRDs. For prompt-level CLEAR analysis with all 5 components, use `/clavix:deep` instead.
|
|
74
118
|
|
|
119
|
+
## Workflow Navigation
|
|
120
|
+
|
|
121
|
+
**You are here:** PRD Generation (Strategic Planning)
|
|
122
|
+
|
|
123
|
+
**Common workflows:**
|
|
124
|
+
- **Full PRD workflow**: `/clavix:prd` → `/clavix:plan` → `/clavix:implement` → `/clavix:archive`
|
|
125
|
+
- **From deep mode**: `/clavix:deep` → (strategic scope detected) → `/clavix:prd`
|
|
126
|
+
- **Quick to strategic**: `/clavix:fast` → (realizes complexity) → `/clavix:prd`
|
|
127
|
+
|
|
128
|
+
**Related commands:**
|
|
129
|
+
- `/clavix:plan` - Generate task breakdown from PRD (next step)
|
|
130
|
+
- `/clavix:implement` - Execute tasks (after plan)
|
|
131
|
+
- `/clavix:summarize` - Alternative: Extract PRD from conversation instead of Q&A
|
|
132
|
+
|
|
75
133
|
## Tips
|
|
76
134
|
|
|
77
135
|
- Ask follow-up questions if answers are too vague
|
|
78
136
|
- Help users think through edge cases
|
|
79
137
|
- Keep the process conversational and supportive
|
|
80
138
|
- Generated PRDs are automatically CLEAR-validated for optimal AI consumption
|
|
139
|
+
|
|
140
|
+
## Troubleshooting
|
|
141
|
+
|
|
142
|
+
### Issue: User's answers to Q1 are too vague ("make an app")
|
|
143
|
+
**Cause**: User hasn't thought through the problem/goal deeply enough
|
|
144
|
+
**Solution** (inline):
|
|
145
|
+
- Stop and ask probing questions before proceeding
|
|
146
|
+
- "What specific problem does this app solve?"
|
|
147
|
+
- "Who will use this and what pain point does it address?"
|
|
148
|
+
- Don't proceed until both problem AND goal are clear
|
|
149
|
+
|
|
150
|
+
### Issue: User lists 10+ features in Q2
|
|
151
|
+
**Cause**: Unclear priorities or scope creep
|
|
152
|
+
**Solution** (inline):
|
|
153
|
+
- Help prioritize: "If you could only launch with 3 features, which would they be?"
|
|
154
|
+
- Separate must-have from nice-to-have
|
|
155
|
+
- Document extras in "Additional Context" or "Out of scope"
|
|
156
|
+
|
|
157
|
+
### Issue: User says "I don't know" to critical questions
|
|
158
|
+
**Cause**: Genuine uncertainty or needs exploration
|
|
159
|
+
**Solution**:
|
|
160
|
+
- For Q1: Ask about what triggered the need, current pain points
|
|
161
|
+
- For Q2: Walk through user journey step-by-step
|
|
162
|
+
- For Q4: Suggest common exclusions based on project type
|
|
163
|
+
- Consider suggesting `/clavix:start` for conversational exploration first
|
|
164
|
+
|
|
165
|
+
### Issue: CLEAR validation shows low scores after generation
|
|
166
|
+
**Cause**: Answers were too vague or incomplete
|
|
167
|
+
**Solution**:
|
|
168
|
+
- Review the generated PRD
|
|
169
|
+
- Identify specific gaps (missing context, vague requirements)
|
|
170
|
+
- Ask targeted follow-up questions
|
|
171
|
+
- Regenerate PRD with enhanced answers
|
|
172
|
+
|
|
173
|
+
### Issue: Generated PRD doesn't match user's vision
|
|
174
|
+
**Cause**: Miscommunication during Q&A or assumptions made
|
|
175
|
+
**Solution**:
|
|
176
|
+
- Review each section with user
|
|
177
|
+
- Ask "What's missing or inaccurate?"
|
|
178
|
+
- Update PRD manually or regenerate with corrected answers
|
|
@@ -24,7 +24,9 @@ You are starting a Clavix conversational session for iterative prompt and requir
|
|
|
24
24
|
- Help them think through user needs
|
|
25
25
|
- Identify potential challenges
|
|
26
26
|
|
|
27
|
-
3.
|
|
27
|
+
3. **Track conversation topics and manage complexity**:
|
|
28
|
+
|
|
29
|
+
**Key points to track:**
|
|
28
30
|
- Problem statement
|
|
29
31
|
- Target users
|
|
30
32
|
- Core features
|
|
@@ -32,6 +34,27 @@ You are starting a Clavix conversational session for iterative prompt and requir
|
|
|
32
34
|
- Success criteria
|
|
33
35
|
- Constraints and scope
|
|
34
36
|
|
|
37
|
+
**Multi-topic detection** (track distinct topics being discussed):
|
|
38
|
+
- Consider topics distinct if they address different problems/features/user needs
|
|
39
|
+
- Examples: "dashboard for sales" + "API for integrations" + "mobile app" = 3 topics
|
|
40
|
+
|
|
41
|
+
**When 3+ distinct topics detected**:
|
|
42
|
+
Auto-suggest focusing: "I notice we're discussing multiple distinct areas: [Topic A: summary], [Topic B: summary], and [Topic C: summary]. To ensure we develop clear requirements for each, would you like to:
|
|
43
|
+
- **Focus on one** - Pick the most important topic to explore thoroughly first
|
|
44
|
+
- **Continue multi-topic** - We'll track all of them, but the resulting prompt may need refinement
|
|
45
|
+
- **Create separate sessions** - Start fresh for each topic with dedicated focus"
|
|
46
|
+
|
|
47
|
+
**Complexity indicators** (suggest wrapping up/summarizing):
|
|
48
|
+
- Conversation > 15 exchanges
|
|
49
|
+
- Requirements for 5+ major features discussed
|
|
50
|
+
- Multiple technology stacks mentioned
|
|
51
|
+
- Significant scope changes or pivots occurred
|
|
52
|
+
|
|
53
|
+
When complexity threshold reached: "We've covered substantial ground. Would you like to:
|
|
54
|
+
- Continue exploring
|
|
55
|
+
- Use `/clavix:summarize` to extract what we have so far
|
|
56
|
+
- Switch to `/clavix:prd` for more structured planning"
|
|
57
|
+
|
|
35
58
|
4. Be conversational and supportive:
|
|
36
59
|
- Don't interrogate - have a natural discussion
|
|
37
60
|
- Build on their ideas
|
|
@@ -61,6 +84,59 @@ After the conversational session, `/clavix:summarize` will:
|
|
|
61
84
|
|
|
62
85
|
[Continue conversational refinement...]
|
|
63
86
|
|
|
87
|
+
## Workflow Navigation
|
|
88
|
+
|
|
89
|
+
**You are here:** Conversational Mode (Iterative Exploration)
|
|
90
|
+
|
|
91
|
+
**Common workflows:**
|
|
92
|
+
- **Exploration to prompt**: `/clavix:start` → [conversation] → `/clavix:summarize` → CLEAR-optimized prompt
|
|
93
|
+
- **Exploration to PRD**: `/clavix:start` → [conversation] → `/clavix:prd` (answer questions with discussed info)
|
|
94
|
+
- **Exploration to planning**: `/clavix:start` → `/clavix:summarize` → `/clavix:plan` → Implement
|
|
95
|
+
|
|
96
|
+
**Related commands:**
|
|
97
|
+
- `/clavix:summarize` - Extract and CLEAR-optimize conversation (typical next step)
|
|
98
|
+
- `/clavix:prd` - Switch to structured PRD generation
|
|
99
|
+
- `/clavix:fast` or `/clavix:deep` - Direct prompt improvement instead of conversation
|
|
100
|
+
|
|
64
101
|
## Note
|
|
65
102
|
|
|
66
103
|
The goal is natural exploration of requirements, not a rigid questionnaire. Follow the user's lead while gently guiding toward clarity.
|
|
104
|
+
|
|
105
|
+
## Troubleshooting
|
|
106
|
+
|
|
107
|
+
### Issue: Conversation going in circles without progress
|
|
108
|
+
**Cause**: Unclear focus or too many topics being explored
|
|
109
|
+
**Solution** (inline):
|
|
110
|
+
- Pause and summarize: "So far we've discussed [A], [B], [C]. Which should we focus on?"
|
|
111
|
+
- Suggest focusing on one topic at a time
|
|
112
|
+
- Or suggest `/clavix:summarize` to extract what's been discussed
|
|
113
|
+
|
|
114
|
+
### Issue: User provides very high-level descriptions ("build something cool")
|
|
115
|
+
**Cause**: User hasn't crystallized their ideas yet
|
|
116
|
+
**Solution**:
|
|
117
|
+
- Ask open-ended questions: "What made you think of this?"
|
|
118
|
+
- Probe for use cases: "Walk me through how someone would use this"
|
|
119
|
+
- Be patient - this mode is for exploration
|
|
120
|
+
- Multiple exchanges are normal and expected
|
|
121
|
+
|
|
122
|
+
### Issue: Detecting 3+ distinct topics but user keeps adding more
|
|
123
|
+
**Cause**: Brainstorming mode or unclear priorities
|
|
124
|
+
**Solution** (inline):
|
|
125
|
+
- Interrupt after 3+ topics detected (per multi-topic protocol)
|
|
126
|
+
- Strongly suggest focusing on one topic
|
|
127
|
+
- Alternative: Document all topics and help prioritize
|
|
128
|
+
- Consider suggesting `/clavix:prd` for each topic separately
|
|
129
|
+
|
|
130
|
+
### Issue: Conversation exceeds 20 exchanges without clarity
|
|
131
|
+
**Cause**: Too exploratory without convergence
|
|
132
|
+
**Solution**:
|
|
133
|
+
- Suggest wrapping up: "We've covered a lot. Ready to `/clavix:summarize`?"
|
|
134
|
+
- Or pivot to `/clavix:prd` for structured planning
|
|
135
|
+
- Or focus conversation: "Let's nail down the core problem first"
|
|
136
|
+
|
|
137
|
+
### Issue: User wants to switch topics mid-conversation
|
|
138
|
+
**Cause**: New idea occurred or original topic wasn't right
|
|
139
|
+
**Solution**:
|
|
140
|
+
- Note what was discussed so far
|
|
141
|
+
- Ask: "Should we continue with [original topic] or switch to [new topic]?"
|
|
142
|
+
- Suggest summarizing current topic first before switching
|