clavix 4.8.1 โ 4.10.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/dist/cli/commands/analyze.d.ts +14 -0
- package/dist/cli/commands/analyze.js +127 -0
- package/dist/templates/slash-commands/_canonical/archive.md +67 -81
- package/dist/templates/slash-commands/_canonical/deep.md +88 -47
- package/dist/templates/slash-commands/_canonical/execute.md +200 -155
- package/dist/templates/slash-commands/_canonical/fast.md +78 -37
- package/dist/templates/slash-commands/_canonical/implement.md +310 -300
- package/dist/templates/slash-commands/_canonical/plan.md +33 -17
- package/dist/templates/slash-commands/_canonical/prd.md +36 -21
- package/dist/templates/slash-commands/_canonical/start.md +34 -33
- package/dist/templates/slash-commands/_canonical/summarize.md +39 -47
- package/dist/templates/slash-commands/_canonical/verify.md +324 -186
- package/dist/templates/slash-commands/_components/agent-protocols/cli-reference.md +214 -0
- package/dist/templates/slash-commands/_components/agent-protocols/error-handling.md +145 -88
- package/dist/templates/slash-commands/_components/agent-protocols/self-correction.md +20 -1
- package/dist/templates/slash-commands/_components/agent-protocols/supportive-companion.md +216 -0
- package/dist/templates/slash-commands/_components/agent-protocols/task-blocking.md +224 -0
- package/dist/templates/slash-commands/_components/references/quality-dimensions.md +152 -44
- package/dist/templates/slash-commands/_components/sections/conversation-examples.md +302 -0
- package/dist/templates/slash-commands/_components/sections/escalation-factors.md +119 -87
- package/dist/templates/slash-commands/_components/sections/improvement-explanations.md +171 -0
- package/dist/templates/slash-commands/_components/sections/pattern-impact.md +208 -0
- package/dist/templates/slash-commands/_components/sections/prd-examples.md +289 -0
- package/dist/templates/slash-commands/_components/troubleshooting/vibecoder-recovery.md +223 -0
- package/package.json +1 -1
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
## What Made the Biggest Difference
|
|
2
|
+
|
|
3
|
+
When showing improvements, categorize by impact so users understand the value.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
### Impact Categories
|
|
8
|
+
|
|
9
|
+
#### High-Impact Improvements (Made a Big Difference)
|
|
10
|
+
|
|
11
|
+
These changes significantly improve how well the AI will understand and respond.
|
|
12
|
+
|
|
13
|
+
| Icon | Improvement | What It Means |
|
|
14
|
+
|------|-------------|---------------|
|
|
15
|
+
| ๐ฏ | **Made your goal clearer** | AI now knows exactly what you want |
|
|
16
|
+
| ๐ | **Added missing details** | Filled gaps that would have confused AI |
|
|
17
|
+
| โ๏ธ | **Removed confusing parts** | Took out things that were sending mixed signals |
|
|
18
|
+
| ๐ | **Fixed vague language** | Changed "make it good" to specific requirements |
|
|
19
|
+
| โ ๏ธ | **Spotted potential problems** | Added handling for edge cases |
|
|
20
|
+
|
|
21
|
+
**Show these first - they matter most.**
|
|
22
|
+
|
|
23
|
+
#### Medium-Impact Improvements (Helpful Polish)
|
|
24
|
+
|
|
25
|
+
These changes make the prompt better but weren't critical.
|
|
26
|
+
|
|
27
|
+
| Icon | Improvement | What It Means |
|
|
28
|
+
|------|-------------|---------------|
|
|
29
|
+
| ๐ | **Better organization** | Rearranged for easier understanding |
|
|
30
|
+
| ๐ท๏ธ | **Clearer labels** | Added sections so AI can scan quickly |
|
|
31
|
+
| โ
| **Added success criteria** | AI knows when it's done |
|
|
32
|
+
| ๐ | **Made it more specific** | General โ Concrete details |
|
|
33
|
+
| ๐ | **Added context** | Background info that helps AI understand |
|
|
34
|
+
|
|
35
|
+
**Show these second - nice improvements.**
|
|
36
|
+
|
|
37
|
+
#### Light Polish (Small but Nice)
|
|
38
|
+
|
|
39
|
+
These are minor tweaks that add a bit of quality.
|
|
40
|
+
|
|
41
|
+
| Icon | Improvement | What It Means |
|
|
42
|
+
|------|-------------|---------------|
|
|
43
|
+
| ๐ฌ | **Smoother wording** | Reads better, same meaning |
|
|
44
|
+
| ๐งน | **Cleaned up formatting** | Easier to read |
|
|
45
|
+
| ๐ | **Minor clarifications** | Small details filled in |
|
|
46
|
+
|
|
47
|
+
**Mention briefly or skip if too minor.**
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### How to Present Impact
|
|
52
|
+
|
|
53
|
+
**For Fast Mode (Quick Overview):**
|
|
54
|
+
```
|
|
55
|
+
โจ **What I improved:**
|
|
56
|
+
|
|
57
|
+
๐ฏ Made your goal clearer - AI will know exactly what you want
|
|
58
|
+
๐ Added missing tech details - Framework, database, API format
|
|
59
|
+
โ
Added success criteria - How to know when it's done
|
|
60
|
+
|
|
61
|
+
Your prompt is ready!
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**For Deep Mode (Detailed Breakdown):**
|
|
65
|
+
```
|
|
66
|
+
## Improvement Summary
|
|
67
|
+
|
|
68
|
+
### High-Impact Changes (3)
|
|
69
|
+
๐ฏ **Clarified the goal**
|
|
70
|
+
Before: "make a better search"
|
|
71
|
+
After: "build a search feature that returns relevant results in under 200ms"
|
|
72
|
+
|
|
73
|
+
๐ **Added missing requirements**
|
|
74
|
+
- Tech stack: React + Node.js + Elasticsearch
|
|
75
|
+
- Data source: Product catalog API
|
|
76
|
+
- User context: Logged-in customers
|
|
77
|
+
|
|
78
|
+
โ ๏ธ **Identified edge cases**
|
|
79
|
+
- Empty search results
|
|
80
|
+
- Special characters in queries
|
|
81
|
+
- Very long queries (>200 chars)
|
|
82
|
+
|
|
83
|
+
### Medium-Impact Changes (2)
|
|
84
|
+
๐ **Reorganized structure**
|
|
85
|
+
Grouped related requirements together
|
|
86
|
+
|
|
87
|
+
โ
**Added success criteria**
|
|
88
|
+
- Response time < 200ms
|
|
89
|
+
- Relevance score > 80%
|
|
90
|
+
- Works on mobile and desktop
|
|
91
|
+
|
|
92
|
+
### Overall
|
|
93
|
+
Your prompt went from **vague** to **production-ready**.
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
### Mapping Patterns to Impact Descriptions
|
|
99
|
+
|
|
100
|
+
When these patterns are applied, use these descriptions:
|
|
101
|
+
|
|
102
|
+
| Pattern | Impact | User-Friendly Description |
|
|
103
|
+
|---------|--------|--------------------------|
|
|
104
|
+
| ObjectiveClarifier | ๐ฏ High | "Made your goal clearer" |
|
|
105
|
+
| CompletenessValidator | ๐ High | "Added missing details" |
|
|
106
|
+
| AmbiguityDetector | ๐ High | "Fixed vague language" |
|
|
107
|
+
| EdgeCaseIdentifier | โ ๏ธ High | "Spotted potential problems" |
|
|
108
|
+
| ConcisenessFilter | โ๏ธ High | "Removed confusing parts" |
|
|
109
|
+
| StructureOrganizer | ๐ Medium | "Better organization" |
|
|
110
|
+
| ActionabilityEnhancer | ๐ฏ High | "Made it actionable" |
|
|
111
|
+
| SuccessCriteriaEnforcer | โ
Medium | "Added success criteria" |
|
|
112
|
+
| TechnicalContextEnricher | ๐ Medium | "Added context" |
|
|
113
|
+
| ScopeDefiner | ๐ Medium | "Made it more specific" |
|
|
114
|
+
| AlternativePhrasingGenerator | ๐ฌ Light | "Offered alternatives" |
|
|
115
|
+
| OutputFormatEnforcer | ๐ท๏ธ Medium | "Clearer output format" |
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
### When to Show Full vs Summary Impact
|
|
120
|
+
|
|
121
|
+
**Show Full Impact When:**
|
|
122
|
+
- Deep mode analysis
|
|
123
|
+
- Quality improved significantly (>20% jump)
|
|
124
|
+
- User asked "what did you change?"
|
|
125
|
+
- Multiple high-impact changes made
|
|
126
|
+
|
|
127
|
+
**Show Summary When:**
|
|
128
|
+
- Fast mode (keep it quick)
|
|
129
|
+
- Minor improvements only
|
|
130
|
+
- User seems to want to move on
|
|
131
|
+
- Quality was already good
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
### Example: Fast Mode Summary
|
|
136
|
+
|
|
137
|
+
```
|
|
138
|
+
โจ Your prompt is now better:
|
|
139
|
+
|
|
140
|
+
๐ฏ Clearer goal - AI knows exactly what to build
|
|
141
|
+
๐ Tech details added - Framework, database, hosting
|
|
142
|
+
โ
Success criteria - How to know when it's done
|
|
143
|
+
|
|
144
|
+
**Before:** 45/100 โ **After:** 85/100
|
|
145
|
+
|
|
146
|
+
Ready to use!
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
### Example: Deep Mode Full Breakdown
|
|
152
|
+
|
|
153
|
+
```
|
|
154
|
+
## ๐ Improvement Analysis
|
|
155
|
+
|
|
156
|
+
### What I Changed (7 improvements)
|
|
157
|
+
|
|
158
|
+
**High Impact (3 changes):**
|
|
159
|
+
1. ๐ฏ **Clarified the objective**
|
|
160
|
+
Your original: "build something for managing tasks"
|
|
161
|
+
Now: "build a task management API with CRUD operations, user assignment, and due date tracking"
|
|
162
|
+
|
|
163
|
+
2. ๐ **Added missing technical requirements**
|
|
164
|
+
- Framework: Express.js
|
|
165
|
+
- Database: PostgreSQL
|
|
166
|
+
- Auth: JWT tokens
|
|
167
|
+
- API format: REST with JSON responses
|
|
168
|
+
|
|
169
|
+
3. โ ๏ธ **Identified edge cases to handle**
|
|
170
|
+
- Task assigned to deleted user
|
|
171
|
+
- Past due dates
|
|
172
|
+
- Empty task lists
|
|
173
|
+
- Concurrent edits
|
|
174
|
+
|
|
175
|
+
**Medium Impact (3 changes):**
|
|
176
|
+
4. ๐ **Reorganized for clarity** - Grouped features logically
|
|
177
|
+
5. โ
**Added success criteria** - Response times, test coverage
|
|
178
|
+
6. ๐ท๏ธ **Structured the output** - Clear sections for AI to follow
|
|
179
|
+
|
|
180
|
+
**Light Polish (1 change):**
|
|
181
|
+
7. ๐ฌ **Smoothed wording** - Minor readability improvements
|
|
182
|
+
|
|
183
|
+
### Quality Score
|
|
184
|
+
| Dimension | Before | After |
|
|
185
|
+
|-----------|--------|-------|
|
|
186
|
+
| Clarity | 4/10 | 9/10 |
|
|
187
|
+
| Completeness | 3/10 | 9/10 |
|
|
188
|
+
| Actionability | 5/10 | 9/10 |
|
|
189
|
+
|
|
190
|
+
**Your prompt went from 40% to 90% quality.**
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
---
|
|
194
|
+
|
|
195
|
+
### Handling "No Changes Needed"
|
|
196
|
+
|
|
197
|
+
Sometimes the prompt is already good:
|
|
198
|
+
|
|
199
|
+
```
|
|
200
|
+
โ
**Your prompt looks great!**
|
|
201
|
+
|
|
202
|
+
I checked for common issues and your prompt:
|
|
203
|
+
- Has a clear goal
|
|
204
|
+
- Includes necessary details
|
|
205
|
+
- Is well-organized
|
|
206
|
+
|
|
207
|
+
No improvements needed - ready to use as-is!
|
|
208
|
+
```
|
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
## PRD Examples
|
|
2
|
+
|
|
3
|
+
Real examples of mini-PRDs to help users understand what good planning looks like.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
### Example 1: Simple Mobile App
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
# Mini-PRD: Habit Tracker App
|
|
11
|
+
|
|
12
|
+
## What We're Building
|
|
13
|
+
A mobile app that helps people build good habits without the guilt.
|
|
14
|
+
Unlike other trackers that shame you for breaking streaks, this one
|
|
15
|
+
celebrates your wins and keeps things positive.
|
|
16
|
+
|
|
17
|
+
## Who It's For
|
|
18
|
+
- People who've tried habit apps but felt judged
|
|
19
|
+
- Anyone who wants to build small daily habits
|
|
20
|
+
- People who prefer encouragement over pressure
|
|
21
|
+
|
|
22
|
+
## The Problem We're Solving
|
|
23
|
+
Most habit trackers use streaks and "don't break the chain" psychology.
|
|
24
|
+
When users miss a day, they feel like failures and often give up entirely.
|
|
25
|
+
We need an app that acknowledges life happens and celebrates progress
|
|
26
|
+
instead of perfection.
|
|
27
|
+
|
|
28
|
+
## Must-Have Features (v1)
|
|
29
|
+
1. **Add habits to track** - Simple creation with name and reminder time
|
|
30
|
+
2. **Mark habits complete** - One tap to check off
|
|
31
|
+
3. **Positive progress view** - "You've done this 15 times!" not "Day 3 of streak"
|
|
32
|
+
4. **Gentle reminders** - Optional notifications, easy to snooze
|
|
33
|
+
5. **Weekly celebration** - End-of-week summary highlighting wins
|
|
34
|
+
|
|
35
|
+
## Nice-to-Have Features (Later)
|
|
36
|
+
- Share progress with friends
|
|
37
|
+
- Habit insights and patterns
|
|
38
|
+
- Custom celebration messages
|
|
39
|
+
- Dark mode
|
|
40
|
+
|
|
41
|
+
## How We'll Know It's Working
|
|
42
|
+
- Users can add a habit in under 10 seconds
|
|
43
|
+
- App never shows negative language (no "streak broken")
|
|
44
|
+
- 70% of users who try it stick around for 2+ weeks
|
|
45
|
+
- Users report feeling "encouraged" in feedback
|
|
46
|
+
|
|
47
|
+
## Technical Approach
|
|
48
|
+
- React Native for iOS and Android
|
|
49
|
+
- Local storage for data (no account required)
|
|
50
|
+
- Simple, cheerful UI with soft colors
|
|
51
|
+
- Push notifications via device native APIs
|
|
52
|
+
|
|
53
|
+
## What's NOT In Scope
|
|
54
|
+
- Social features (v1 is personal only)
|
|
55
|
+
- Data export
|
|
56
|
+
- Web version
|
|
57
|
+
- Integrations with other apps
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
### Example 2: API/Backend Service
|
|
63
|
+
|
|
64
|
+
```markdown
|
|
65
|
+
# Mini-PRD: User Management API
|
|
66
|
+
|
|
67
|
+
## What We're Building
|
|
68
|
+
A REST API for managing users in our web application. Handles
|
|
69
|
+
registration, authentication, and user profiles with role-based
|
|
70
|
+
access control.
|
|
71
|
+
|
|
72
|
+
## Who It's For
|
|
73
|
+
- Frontend developers building our web app
|
|
74
|
+
- Admin team managing user accounts
|
|
75
|
+
- Other services that need user data
|
|
76
|
+
|
|
77
|
+
## The Problem We're Solving
|
|
78
|
+
Our current auth is scattered across multiple files with no clear
|
|
79
|
+
structure. We need a proper API that handles all user operations
|
|
80
|
+
in one place with consistent patterns.
|
|
81
|
+
|
|
82
|
+
## Must-Have Features (v1)
|
|
83
|
+
1. **User registration** - Email + password, email verification
|
|
84
|
+
2. **Authentication** - Login, logout, password reset
|
|
85
|
+
3. **JWT tokens** - Access (15min) + refresh (7 days)
|
|
86
|
+
4. **User profiles** - View and update own profile
|
|
87
|
+
5. **Role-based access** - Admin, Editor, Viewer levels
|
|
88
|
+
6. **Admin operations** - List users, change roles, disable accounts
|
|
89
|
+
|
|
90
|
+
## Nice-to-Have Features (Later)
|
|
91
|
+
- OAuth (Google, GitHub login)
|
|
92
|
+
- Two-factor authentication
|
|
93
|
+
- Audit logging
|
|
94
|
+
- API rate limiting per user
|
|
95
|
+
|
|
96
|
+
## How We'll Know It's Working
|
|
97
|
+
- All endpoints respond in under 100ms
|
|
98
|
+
- 100% test coverage on auth flows
|
|
99
|
+
- Zero security vulnerabilities in penetration testing
|
|
100
|
+
- Frontend team can integrate in under 1 day
|
|
101
|
+
|
|
102
|
+
## Technical Approach
|
|
103
|
+
- Node.js with Express framework
|
|
104
|
+
- PostgreSQL database
|
|
105
|
+
- JWT for auth tokens
|
|
106
|
+
- bcrypt for password hashing
|
|
107
|
+
- Jest for testing
|
|
108
|
+
|
|
109
|
+
## API Endpoints Overview
|
|
110
|
+
- POST /auth/register
|
|
111
|
+
- POST /auth/login
|
|
112
|
+
- POST /auth/logout
|
|
113
|
+
- POST /auth/refresh
|
|
114
|
+
- POST /auth/forgot-password
|
|
115
|
+
- GET/PUT /users/me
|
|
116
|
+
- GET /users (admin only)
|
|
117
|
+
- PUT /users/:id/role (admin only)
|
|
118
|
+
|
|
119
|
+
## What's NOT In Scope
|
|
120
|
+
- Frontend UI for auth
|
|
121
|
+
- Email service (will use existing)
|
|
122
|
+
- User analytics
|
|
123
|
+
- Multi-tenancy
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
### Example 3: Feature Addition
|
|
129
|
+
|
|
130
|
+
```markdown
|
|
131
|
+
# Mini-PRD: Search Feature for E-commerce Site
|
|
132
|
+
|
|
133
|
+
## What We're Building
|
|
134
|
+
A search feature that lets customers find products quickly. Should
|
|
135
|
+
be fast, relevant, and work well on mobile.
|
|
136
|
+
|
|
137
|
+
## Who It's For
|
|
138
|
+
- Customers shopping on our site
|
|
139
|
+
- Especially mobile users (60% of our traffic)
|
|
140
|
+
- People who know what they want and don't want to browse
|
|
141
|
+
|
|
142
|
+
## The Problem We're Solving
|
|
143
|
+
Customers are abandoning our site because they can't find products.
|
|
144
|
+
Current browse-only experience doesn't work when you have 5000+
|
|
145
|
+
products. We need search.
|
|
146
|
+
|
|
147
|
+
## Must-Have Features (v1)
|
|
148
|
+
1. **Search box** - Visible on every page, especially mobile
|
|
149
|
+
2. **Instant results** - Show results as user types
|
|
150
|
+
3. **Product cards** - Image, name, price in results
|
|
151
|
+
4. **Filters** - Category, price range, in-stock only
|
|
152
|
+
5. **No results page** - Helpful suggestions when search fails
|
|
153
|
+
|
|
154
|
+
## Nice-to-Have Features (Later)
|
|
155
|
+
- Search suggestions/autocomplete
|
|
156
|
+
- Recent searches
|
|
157
|
+
- "Did you mean?" for typos
|
|
158
|
+
- Voice search on mobile
|
|
159
|
+
|
|
160
|
+
## How We'll Know It's Working
|
|
161
|
+
- Results appear in under 200ms
|
|
162
|
+
- 80%+ of searches return relevant results
|
|
163
|
+
- Conversion rate from search > browse
|
|
164
|
+
- Mobile search usage > 30% of all searches
|
|
165
|
+
|
|
166
|
+
## Technical Approach
|
|
167
|
+
- Elasticsearch for search backend
|
|
168
|
+
- React components for UI
|
|
169
|
+
- Debounced search (300ms delay while typing)
|
|
170
|
+
- Server-side filtering for performance
|
|
171
|
+
|
|
172
|
+
## Integration Points
|
|
173
|
+
- Product database (PostgreSQL)
|
|
174
|
+
- Image CDN for product thumbnails
|
|
175
|
+
- Analytics for search tracking
|
|
176
|
+
|
|
177
|
+
## What's NOT In Scope
|
|
178
|
+
- Personalized results (same results for everyone)
|
|
179
|
+
- Search within categories (just global search)
|
|
180
|
+
- Advanced operators ("AND", "OR", quotes)
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
### Example 4: Internal Tool
|
|
186
|
+
|
|
187
|
+
```markdown
|
|
188
|
+
# Mini-PRD: Team Task Board
|
|
189
|
+
|
|
190
|
+
## What We're Building
|
|
191
|
+
A simple Kanban board for our team to track tasks. Think Trello
|
|
192
|
+
but just for us, without all the features we don't use.
|
|
193
|
+
|
|
194
|
+
## Who It's For
|
|
195
|
+
- Our development team (8 people)
|
|
196
|
+
- Project manager for oversight
|
|
197
|
+
- Occasionally stakeholders for status updates
|
|
198
|
+
|
|
199
|
+
## The Problem We're Solving
|
|
200
|
+
We're paying for Trello but only use 10% of it. Tasks get lost,
|
|
201
|
+
people forget to update cards, and it's overkill for our needs.
|
|
202
|
+
We want something simpler that fits how we actually work.
|
|
203
|
+
|
|
204
|
+
## Must-Have Features (v1)
|
|
205
|
+
1. **Three columns** - To Do, In Progress, Done
|
|
206
|
+
2. **Task cards** - Title, description, assignee
|
|
207
|
+
3. **Drag and drop** - Move cards between columns
|
|
208
|
+
4. **Comments** - Discuss tasks without leaving the board
|
|
209
|
+
5. **Slack notifications** - When tasks move or get assigned
|
|
210
|
+
|
|
211
|
+
## Nice-to-Have Features (Later)
|
|
212
|
+
- Due dates with reminders
|
|
213
|
+
- Labels/tags
|
|
214
|
+
- Multiple boards per project
|
|
215
|
+
- Time tracking
|
|
216
|
+
|
|
217
|
+
## How We'll Know It's Working
|
|
218
|
+
- Team adopts it within 1 week
|
|
219
|
+
- No tasks "fall through the cracks"
|
|
220
|
+
- Status meetings take 50% less time
|
|
221
|
+
- Nobody asks "what are you working on?"
|
|
222
|
+
|
|
223
|
+
## Technical Approach
|
|
224
|
+
- React frontend
|
|
225
|
+
- Node.js backend
|
|
226
|
+
- MongoDB for flexibility
|
|
227
|
+
- Socket.io for real-time updates
|
|
228
|
+
- Slack API integration
|
|
229
|
+
|
|
230
|
+
## What's NOT In Scope
|
|
231
|
+
- Mobile app (desktop only for now)
|
|
232
|
+
- Reporting/analytics
|
|
233
|
+
- Time tracking
|
|
234
|
+
- Multiple teams/permissions
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
---
|
|
238
|
+
|
|
239
|
+
### PRD Template (Blank)
|
|
240
|
+
|
|
241
|
+
Copy and fill in:
|
|
242
|
+
|
|
243
|
+
```markdown
|
|
244
|
+
# Mini-PRD: [Project Name]
|
|
245
|
+
|
|
246
|
+
## What We're Building
|
|
247
|
+
[1-2 sentences describing the product/feature]
|
|
248
|
+
|
|
249
|
+
## Who It's For
|
|
250
|
+
- [Primary user type]
|
|
251
|
+
- [Secondary user type]
|
|
252
|
+
- [Use case context]
|
|
253
|
+
|
|
254
|
+
## The Problem We're Solving
|
|
255
|
+
[What's the pain point? Why does this need to exist?]
|
|
256
|
+
|
|
257
|
+
## Must-Have Features (v1)
|
|
258
|
+
1. **[Feature]** - [Brief description]
|
|
259
|
+
2. **[Feature]** - [Brief description]
|
|
260
|
+
3. **[Feature]** - [Brief description]
|
|
261
|
+
|
|
262
|
+
## Nice-to-Have Features (Later)
|
|
263
|
+
- [Feature]
|
|
264
|
+
- [Feature]
|
|
265
|
+
|
|
266
|
+
## How We'll Know It's Working
|
|
267
|
+
- [Measurable success criteria]
|
|
268
|
+
- [Measurable success criteria]
|
|
269
|
+
- [Measurable success criteria]
|
|
270
|
+
|
|
271
|
+
## Technical Approach
|
|
272
|
+
- [Key technology choices]
|
|
273
|
+
- [Architecture notes]
|
|
274
|
+
|
|
275
|
+
## What's NOT In Scope
|
|
276
|
+
- [Explicitly excluded feature]
|
|
277
|
+
- [Explicitly excluded feature]
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
---
|
|
281
|
+
|
|
282
|
+
### Key Elements of a Good Mini-PRD
|
|
283
|
+
|
|
284
|
+
1. **Clear problem statement** - Why are we building this?
|
|
285
|
+
2. **Specific users** - Who exactly will use it?
|
|
286
|
+
3. **Prioritized features** - What's essential vs nice-to-have?
|
|
287
|
+
4. **Success metrics** - How do we measure success?
|
|
288
|
+
5. **Technical direction** - Enough detail to start, not over-specified
|
|
289
|
+
6. **Explicit scope** - What we're NOT doing is as important as what we are
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
## Recovery Patterns for Vibecoders
|
|
2
|
+
|
|
3
|
+
When something goes wrong, help users gracefully. Always try to fix it yourself first.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
### Prompt Save Issues
|
|
8
|
+
|
|
9
|
+
#### Can't Save Prompt
|
|
10
|
+
**What happened:** Failed to save the improved prompt to disk
|
|
11
|
+
**You try first:**
|
|
12
|
+
1. Create the missing directory: `mkdir -p .clavix/outputs/prompts/fast`
|
|
13
|
+
2. Retry the save operation
|
|
14
|
+
|
|
15
|
+
**If still fails, say:**
|
|
16
|
+
> "I had trouble saving your prompt, but no worries - here's your improved version.
|
|
17
|
+
> You can copy it and I'll try saving again next time:
|
|
18
|
+
>
|
|
19
|
+
> [Show the improved prompt]"
|
|
20
|
+
|
|
21
|
+
#### Prompt Not Found
|
|
22
|
+
**What happened:** User asked about a prompt that doesn't exist
|
|
23
|
+
**You try first:**
|
|
24
|
+
1. Run `clavix prompts list` to see what's available
|
|
25
|
+
2. Check if there's a similar prompt ID
|
|
26
|
+
|
|
27
|
+
**Say:**
|
|
28
|
+
> "I can't find that prompt. Here's what I have saved:
|
|
29
|
+
> [List available prompts]
|
|
30
|
+
>
|
|
31
|
+
> Which one were you looking for?"
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
### Task Issues
|
|
36
|
+
|
|
37
|
+
#### Task Not Found
|
|
38
|
+
**What happened:** Tried to complete a task that doesn't exist
|
|
39
|
+
**You try first:**
|
|
40
|
+
1. Run `clavix implement --list` to get current tasks
|
|
41
|
+
2. Check for typos in task ID
|
|
42
|
+
|
|
43
|
+
**Say:**
|
|
44
|
+
> "I can't find that task. Let me show you the available tasks:
|
|
45
|
+
> [List tasks]
|
|
46
|
+
>
|
|
47
|
+
> Which one did you mean?"
|
|
48
|
+
|
|
49
|
+
#### Task Already Done
|
|
50
|
+
**What happened:** Task was already marked complete
|
|
51
|
+
**You say:**
|
|
52
|
+
> "Good news - that task is already done! Here's what's left:
|
|
53
|
+
> [Show remaining tasks]"
|
|
54
|
+
|
|
55
|
+
#### Wrong Task Order
|
|
56
|
+
**What happened:** User wants to skip ahead or go back
|
|
57
|
+
**You say:**
|
|
58
|
+
> "I'd recommend doing the tasks in order since [task X] depends on [task Y].
|
|
59
|
+
> Want me to:
|
|
60
|
+
> 1. Continue with the current task
|
|
61
|
+
> 2. Skip ahead anyway (might cause issues)"
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
### Project Issues
|
|
66
|
+
|
|
67
|
+
#### No PRD Found
|
|
68
|
+
**What happened:** Tried to plan tasks but no PRD exists
|
|
69
|
+
**You say:**
|
|
70
|
+
> "I don't see a plan for this project yet.
|
|
71
|
+
> Want me to help you create one? Just describe what you're building
|
|
72
|
+
> and I'll put together a proper plan."
|
|
73
|
+
|
|
74
|
+
#### Multiple Projects
|
|
75
|
+
**What happened:** Found more than one project, not sure which to use
|
|
76
|
+
**You say:**
|
|
77
|
+
> "I found a few projects here:
|
|
78
|
+
> 1. **todo-app** - 3 tasks done, 2 remaining
|
|
79
|
+
> 2. **auth-feature** - Not started yet
|
|
80
|
+
>
|
|
81
|
+
> Which one should we work on?"
|
|
82
|
+
|
|
83
|
+
#### Project Not Initialized
|
|
84
|
+
**What happened:** Clavix isn't set up in this folder
|
|
85
|
+
**You try first:**
|
|
86
|
+
1. Run `clavix init` to set up automatically
|
|
87
|
+
|
|
88
|
+
**Say:**
|
|
89
|
+
> "Let me set up Clavix for this project real quick...
|
|
90
|
+
> [After init completes]
|
|
91
|
+
> All set! Now, what would you like to do?"
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
### Verification Issues
|
|
96
|
+
|
|
97
|
+
#### Tests Failing
|
|
98
|
+
**What happened:** Automated verification found failing tests
|
|
99
|
+
**You say:**
|
|
100
|
+
> "Some tests didn't pass. Here's what I found:
|
|
101
|
+
>
|
|
102
|
+
> โ **[Test name]** - [Brief explanation]
|
|
103
|
+
>
|
|
104
|
+
> Would you like me to:
|
|
105
|
+
> 1. Try to fix these issues
|
|
106
|
+
> 2. Show you more details about what failed
|
|
107
|
+
> 3. Skip verification for now (not recommended)"
|
|
108
|
+
|
|
109
|
+
#### Can't Run Verification
|
|
110
|
+
**What happened:** Verification hooks couldn't run
|
|
111
|
+
**You try first:**
|
|
112
|
+
1. Check if package.json exists
|
|
113
|
+
2. Check for npm/yarn/pnpm lock files
|
|
114
|
+
|
|
115
|
+
**Say:**
|
|
116
|
+
> "I couldn't run the automatic checks. This usually means:
|
|
117
|
+
> - No test command is set up
|
|
118
|
+
> - Dependencies aren't installed
|
|
119
|
+
>
|
|
120
|
+
> Want me to check if everything is set up correctly?"
|
|
121
|
+
|
|
122
|
+
#### Verification Timeout
|
|
123
|
+
**What happened:** Verification took too long
|
|
124
|
+
**You say:**
|
|
125
|
+
> "The checks are taking longer than expected. This might be a big test suite.
|
|
126
|
+
> Want me to:
|
|
127
|
+
> 1. Keep waiting
|
|
128
|
+
> 2. Cancel and mark for manual verification"
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
### File System Issues
|
|
133
|
+
|
|
134
|
+
#### Permission Denied
|
|
135
|
+
**What happened:** Can't write to a file or directory
|
|
136
|
+
**You say:**
|
|
137
|
+
> "I don't have permission to write to that location.
|
|
138
|
+
> This is usually a folder permissions issue.
|
|
139
|
+
>
|
|
140
|
+
> The file I'm trying to create: [path]
|
|
141
|
+
>
|
|
142
|
+
> You might need to check the folder permissions, or we can try a different location."
|
|
143
|
+
|
|
144
|
+
#### Disk Full
|
|
145
|
+
**What happened:** No space left on device
|
|
146
|
+
**You say:**
|
|
147
|
+
> "Looks like the disk is full! I can't save anything right now.
|
|
148
|
+
>
|
|
149
|
+
> Once you free up some space, we can continue where we left off."
|
|
150
|
+
|
|
151
|
+
#### File Corrupted
|
|
152
|
+
**What happened:** A config file is invalid JSON or corrupted
|
|
153
|
+
**You try first:**
|
|
154
|
+
1. Check if it's a simple syntax error
|
|
155
|
+
2. Try to recover valid data
|
|
156
|
+
|
|
157
|
+
**If can't recover, say:**
|
|
158
|
+
> "One of the config files got corrupted. I can:
|
|
159
|
+
> 1. Start fresh (you'll lose saved settings)
|
|
160
|
+
> 2. Show you the file so you can try to fix it manually
|
|
161
|
+
>
|
|
162
|
+
> What would you prefer?"
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
### Git Issues
|
|
167
|
+
|
|
168
|
+
#### Not a Git Repository
|
|
169
|
+
**What happened:** Git commands fail because no repo exists
|
|
170
|
+
**You say:**
|
|
171
|
+
> "This folder isn't set up with Git yet.
|
|
172
|
+
> Want me to initialize it? This will let me track your changes."
|
|
173
|
+
|
|
174
|
+
#### Git Conflicts
|
|
175
|
+
**What happened:** Merge conflicts detected
|
|
176
|
+
**You say:**
|
|
177
|
+
> "There are some merge conflicts that need your attention.
|
|
178
|
+
> I can't automatically resolve these because they need human judgment.
|
|
179
|
+
>
|
|
180
|
+
> Files with conflicts:
|
|
181
|
+
> [List files]
|
|
182
|
+
>
|
|
183
|
+
> Once you resolve them, let me know and we'll continue."
|
|
184
|
+
|
|
185
|
+
#### Nothing to Commit
|
|
186
|
+
**What happened:** Tried to commit but no changes
|
|
187
|
+
**You say:**
|
|
188
|
+
> "No changes to save - everything's already up to date!"
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
### Network Issues
|
|
193
|
+
|
|
194
|
+
#### Timeout
|
|
195
|
+
**What happened:** Network request timed out
|
|
196
|
+
**You try first:**
|
|
197
|
+
1. Retry the request once
|
|
198
|
+
|
|
199
|
+
**If still fails, say:**
|
|
200
|
+
> "Having trouble connecting. This might be a temporary network issue.
|
|
201
|
+
> Want me to try again, or should we continue without this?"
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
205
|
+
### General Recovery Protocol
|
|
206
|
+
|
|
207
|
+
For ANY unexpected error:
|
|
208
|
+
|
|
209
|
+
1. **Don't panic the user** - Stay calm, be helpful
|
|
210
|
+
2. **Explain simply** - No technical jargon
|
|
211
|
+
3. **Offer options** - Give 2-3 clear choices
|
|
212
|
+
4. **Preserve their work** - Never lose user's content
|
|
213
|
+
5. **Provide a path forward** - Always suggest next steps
|
|
214
|
+
|
|
215
|
+
**Template:**
|
|
216
|
+
> "Hmm, something unexpected happened. [Brief, friendly explanation]
|
|
217
|
+
>
|
|
218
|
+
> Don't worry - your work is safe. Here's what we can do:
|
|
219
|
+
> 1. [Option A - usually try again]
|
|
220
|
+
> 2. [Option B - alternative approach]
|
|
221
|
+
> 3. [Option C - skip for now]
|
|
222
|
+
>
|
|
223
|
+
> What sounds good?"
|