@dedesfr/prompter 0.8.7 → 0.8.8
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/CHANGELOG.md +20 -0
- package/dist/cli/index.js +1 -1
- package/package.json +1 -1
- package/skills/design-md/README.md +34 -0
- package/skills/design-md/SKILL.md +172 -0
- package/skills/design-md/examples/DESIGN.md +154 -0
- package/skills/enhance-prompt/README.md +34 -0
- package/skills/enhance-prompt/SKILL.md +204 -0
- package/skills/enhance-prompt/references/KEYWORDS.md +114 -0
- package/skills/feature-planner/SKILL.md +305 -0
- package/skills/feature-planner/assets/implementation-plan-template.md +85 -0
- package/src/cli/index.ts +1 -1
- package/skills/skill-creator/LICENSE.txt +0 -202
- package/skills/skill-creator/SKILL.md +0 -485
- package/skills/skill-creator/agents/analyzer.md +0 -274
- package/skills/skill-creator/agents/comparator.md +0 -202
- package/skills/skill-creator/agents/grader.md +0 -223
- package/skills/skill-creator/assets/eval_review.html +0 -146
- package/skills/skill-creator/eval-viewer/generate_review.py +0 -471
- package/skills/skill-creator/eval-viewer/viewer.html +0 -1325
- package/skills/skill-creator/references/schemas.md +0 -430
- package/skills/skill-creator/scripts/__init__.py +0 -0
- package/skills/skill-creator/scripts/aggregate_benchmark.py +0 -401
- package/skills/skill-creator/scripts/generate_report.py +0 -326
- package/skills/skill-creator/scripts/improve_description.py +0 -247
- package/skills/skill-creator/scripts/package_skill.py +0 -136
- package/skills/skill-creator/scripts/quick_validate.py +0 -103
- package/skills/skill-creator/scripts/run_eval.py +0 -310
- package/skills/skill-creator/scripts/run_loop.py +0 -328
- package/skills/skill-creator/scripts/utils.py +0 -47
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# UI/UX Keywords Reference
|
|
2
|
+
|
|
3
|
+
Progressive disclosure reference for common UI terminology and adjective palettes.
|
|
4
|
+
|
|
5
|
+
## Component Keywords
|
|
6
|
+
|
|
7
|
+
### Navigation
|
|
8
|
+
- navigation bar, nav menu, header
|
|
9
|
+
- breadcrumbs, tabs, sidebar
|
|
10
|
+
- hamburger menu, dropdown menu
|
|
11
|
+
- back button, close button
|
|
12
|
+
|
|
13
|
+
### Content Containers
|
|
14
|
+
- hero section, hero banner
|
|
15
|
+
- card, card grid, tile
|
|
16
|
+
- modal, dialog, popup
|
|
17
|
+
- accordion, collapsible section
|
|
18
|
+
- carousel, slider
|
|
19
|
+
|
|
20
|
+
### Forms
|
|
21
|
+
- input field, text input
|
|
22
|
+
- dropdown, select menu
|
|
23
|
+
- checkbox, radio button
|
|
24
|
+
- toggle switch
|
|
25
|
+
- date picker, time picker
|
|
26
|
+
- search bar, search input
|
|
27
|
+
- submit button, form actions
|
|
28
|
+
|
|
29
|
+
### Calls to Action
|
|
30
|
+
- primary button, secondary button
|
|
31
|
+
- ghost button, text link
|
|
32
|
+
- floating action button (FAB)
|
|
33
|
+
- icon button
|
|
34
|
+
|
|
35
|
+
### Feedback
|
|
36
|
+
- toast notification, snackbar
|
|
37
|
+
- alert banner, warning message
|
|
38
|
+
- loading spinner, skeleton loader
|
|
39
|
+
- progress bar, step indicator
|
|
40
|
+
|
|
41
|
+
### Layout
|
|
42
|
+
- grid layout, flexbox
|
|
43
|
+
- sidebar layout, split view
|
|
44
|
+
- sticky header, fixed footer
|
|
45
|
+
- full-width, contained width
|
|
46
|
+
- centered content, max-width container
|
|
47
|
+
|
|
48
|
+
## Adjective Palettes
|
|
49
|
+
|
|
50
|
+
### Minimal / Clean
|
|
51
|
+
- minimal, clean, uncluttered
|
|
52
|
+
- generous whitespace, breathing room
|
|
53
|
+
- subtle, understated, refined
|
|
54
|
+
- simple, focused, distraction-free
|
|
55
|
+
|
|
56
|
+
### Professional / Corporate
|
|
57
|
+
- sophisticated, polished, trustworthy
|
|
58
|
+
- corporate, business-like, formal
|
|
59
|
+
- subtle shadows, clean lines
|
|
60
|
+
- structured, organized, hierarchical
|
|
61
|
+
|
|
62
|
+
### Playful / Fun
|
|
63
|
+
- vibrant, colorful, energetic
|
|
64
|
+
- rounded corners, soft edges
|
|
65
|
+
- bold, expressive, dynamic
|
|
66
|
+
- friendly, approachable, warm
|
|
67
|
+
|
|
68
|
+
### Premium / Luxury
|
|
69
|
+
- elegant, luxurious, high-end
|
|
70
|
+
- dramatic, bold contrasts
|
|
71
|
+
- sleek, modern, cutting-edge
|
|
72
|
+
- exclusive, boutique, curated
|
|
73
|
+
|
|
74
|
+
### Dark Mode
|
|
75
|
+
- dark theme, night mode
|
|
76
|
+
- high-contrast accents
|
|
77
|
+
- soft glows, subtle highlights
|
|
78
|
+
- deep backgrounds, muted surfaces
|
|
79
|
+
|
|
80
|
+
### Organic / Natural
|
|
81
|
+
- earthy tones, natural colors
|
|
82
|
+
- warm, inviting, cozy
|
|
83
|
+
- textured, tactile, handcrafted
|
|
84
|
+
- flowing, organic shapes
|
|
85
|
+
|
|
86
|
+
## Color Role Terminology
|
|
87
|
+
|
|
88
|
+
### Backgrounds
|
|
89
|
+
- page background, canvas
|
|
90
|
+
- surface color, card background
|
|
91
|
+
- overlay, scrim
|
|
92
|
+
|
|
93
|
+
### Text
|
|
94
|
+
- primary text, heading color
|
|
95
|
+
- secondary text, body copy
|
|
96
|
+
- muted text, placeholder
|
|
97
|
+
- inverse text (on dark backgrounds)
|
|
98
|
+
|
|
99
|
+
### Accents
|
|
100
|
+
- primary accent, brand color
|
|
101
|
+
- secondary accent, highlight
|
|
102
|
+
- success, error, warning colors
|
|
103
|
+
- hover state, active state
|
|
104
|
+
|
|
105
|
+
## Shape Descriptions
|
|
106
|
+
|
|
107
|
+
| Technical | Natural Language |
|
|
108
|
+
|-----------|------------------|
|
|
109
|
+
| `rounded-none` | sharp, squared-off edges |
|
|
110
|
+
| `rounded-sm` | slightly softened corners |
|
|
111
|
+
| `rounded-md` | gently rounded corners |
|
|
112
|
+
| `rounded-lg` | generously rounded corners |
|
|
113
|
+
| `rounded-xl` | very rounded, pillow-like |
|
|
114
|
+
| `rounded-full` | pill-shaped, circular |
|
|
@@ -0,0 +1,305 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: feature-planner
|
|
3
|
+
description: Plan feature development on existing projects. Interview users about what they want to build, analyze the codebase to understand tech stack, patterns, and affected areas, then produce a structured implementation plan with phased tasks. Optionally scaffolds a Prompter change proposal. Use when a user wants to add a feature, make a change, or plan development work on a project that already exists.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Feature Developer
|
|
7
|
+
|
|
8
|
+
Interview the user about what they want to build, analyze the existing codebase, then produce a phased implementation plan with concrete tasks and file references.
|
|
9
|
+
|
|
10
|
+
## Quick Start
|
|
11
|
+
|
|
12
|
+
1. **DESCRIBE** -- Ask what the user wants to build and why
|
|
13
|
+
2. **ANALYZE** -- Scan the codebase: structure, tech stack, patterns, existing specs
|
|
14
|
+
3. **SCOPE** -- Present what's in/out of scope, identify affected files
|
|
15
|
+
4. **PLAN** -- Break down into phased implementation tasks
|
|
16
|
+
5. **REVIEW** -- Present the plan and iterate until approved
|
|
17
|
+
6. **PROPOSAL** -- Optionally create a Prompter change proposal
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Before You Begin (REQUIRED)
|
|
22
|
+
|
|
23
|
+
Before starting the interview:
|
|
24
|
+
|
|
25
|
+
1. **Read `AGENTS.md`** at the project root (if it exists) to understand the tech stack, conventions, and architecture.
|
|
26
|
+
2. **Read `prompter/project.md`** (if it exists) to understand project conventions.
|
|
27
|
+
3. **Scan the project structure** using Glob to understand the directory layout and key files.
|
|
28
|
+
|
|
29
|
+
Store what you learn -- you'll reference it when identifying affected files and patterns.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Interactive Terminal Tool (REQUIRED)
|
|
34
|
+
|
|
35
|
+
Use the `AskUserQuestion` tool for **every question** in the interview. This renders an interactive UI in the terminal.
|
|
36
|
+
|
|
37
|
+
### How to Use AskUserQuestion
|
|
38
|
+
|
|
39
|
+
- **Single-choice questions**: Set `multiSelect: false`. Use for yes/no, pick-one decisions.
|
|
40
|
+
- **Multi-choice questions**: Set `multiSelect: true`. Use for checklists.
|
|
41
|
+
- **Free-text input**: When you need the user to describe something open-ended (like the feature itself), ask as a plain message and wait for their response. Only use `AskUserQuestion` for structured choices.
|
|
42
|
+
- **Keep options concise**: Labels should be 1-5 words. Add detail in the `description` field.
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Core Rules
|
|
47
|
+
|
|
48
|
+
- Use `AskUserQuestion` for every structured question -- never ask choice questions as plain text.
|
|
49
|
+
- Ask one question or one small grouped set at a time. Never overwhelm.
|
|
50
|
+
- After every answer, acknowledge what you understood before moving on.
|
|
51
|
+
- Ground every suggestion in what you observed in the codebase -- don't guess patterns.
|
|
52
|
+
- If unsure about something, look at the code before asking the user.
|
|
53
|
+
- Keep the interview short -- 3 to 5 questions max before producing the plan.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Step 1: Feature Description (REQUIRED)
|
|
58
|
+
|
|
59
|
+
Open with:
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
What feature or change do you want to build? Tell me:
|
|
63
|
+
|
|
64
|
+
1. What it does (the user-visible behavior or system change)
|
|
65
|
+
2. Why you need it (the problem it solves or value it adds)
|
|
66
|
+
3. Any constraints or preferences (e.g., "must use existing auth system", "keep it simple")
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Wait for the user's response. Summarize what you understood in 2-3 sentences.
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Step 2: Codebase Analysis (REQUIRED)
|
|
74
|
+
|
|
75
|
+
After understanding the feature, **silently analyze the codebase**. Do NOT ask the user about the tech stack -- discover it yourself.
|
|
76
|
+
|
|
77
|
+
### What to Analyze
|
|
78
|
+
|
|
79
|
+
1. **Project structure** -- Use Glob to map the directory layout (e.g., `src/**`, `app/**`, `resources/**`)
|
|
80
|
+
2. **Tech stack** -- Identify framework, language, database, styling from config files:
|
|
81
|
+
- `package.json`, `composer.json`, `Cargo.toml`, `go.mod`, `requirements.txt`
|
|
82
|
+
- Framework configs: `next.config.*`, `vite.config.*`, `artisan`, `convex/`
|
|
83
|
+
- Database: migrations folder, schema files, ORM config
|
|
84
|
+
3. **Existing patterns** -- Read 2-3 files similar to what you'll need to create/modify:
|
|
85
|
+
- If adding an API endpoint, read an existing endpoint
|
|
86
|
+
- If adding a UI component, read an existing component
|
|
87
|
+
- If adding a model, read an existing model
|
|
88
|
+
4. **Related code** -- Use Grep to find code related to the feature (e.g., if adding notifications, search for existing notification code)
|
|
89
|
+
5. **Existing specs** -- Check `prompter/specs/` for relevant capability specs
|
|
90
|
+
|
|
91
|
+
### Present Findings
|
|
92
|
+
|
|
93
|
+
After analysis, present a brief summary:
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
Here's what I found in your codebase:
|
|
97
|
+
|
|
98
|
+
**Stack**: [e.g., Laravel 12 + Filament + PostgreSQL + Docker]
|
|
99
|
+
**Structure**: [e.g., Standard Laravel with domain-driven modules under app/Domains/]
|
|
100
|
+
**Relevant patterns**:
|
|
101
|
+
- [e.g., Controllers follow single-action pattern (app/Http/Controllers/)]
|
|
102
|
+
- [e.g., All models use UUIDs as primary keys]
|
|
103
|
+
- [e.g., Tests use Pest with factories]
|
|
104
|
+
|
|
105
|
+
**Related existing code**:
|
|
106
|
+
- [e.g., Similar notification system exists at app/Notifications/]
|
|
107
|
+
- [e.g., No existing code for webhooks -- this is net new]
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Then ask using `AskUserQuestion`:
|
|
111
|
+
|
|
112
|
+
```json
|
|
113
|
+
{
|
|
114
|
+
"questions": [
|
|
115
|
+
{
|
|
116
|
+
"question": "Does this look right? Anything I missed about how your project works?",
|
|
117
|
+
"header": "Codebase Analysis",
|
|
118
|
+
"multiSelect": false,
|
|
119
|
+
"options": [
|
|
120
|
+
{ "label": "Looks correct", "description": "Move on to scoping" },
|
|
121
|
+
{ "label": "Need to correct something", "description": "I'll clarify what's different" }
|
|
122
|
+
]
|
|
123
|
+
}
|
|
124
|
+
]
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
If the user corrects something, update your understanding and move on.
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## Step 3: Scope & Affected Areas
|
|
133
|
+
|
|
134
|
+
Based on the feature description and codebase analysis, present the scope:
|
|
135
|
+
|
|
136
|
+
```
|
|
137
|
+
Here's what I'd include for this feature:
|
|
138
|
+
|
|
139
|
+
**In scope:**
|
|
140
|
+
- [change 1]
|
|
141
|
+
- [change 2]
|
|
142
|
+
- [change 3]
|
|
143
|
+
|
|
144
|
+
**Out of scope (can do later):**
|
|
145
|
+
- [deferred item 1] -- [reason]
|
|
146
|
+
|
|
147
|
+
**Files that will be affected:**
|
|
148
|
+
- `path/to/file.ext` -- [what changes: new / modify / delete]
|
|
149
|
+
- `path/to/file.ext` -- [what changes]
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Then ask:
|
|
153
|
+
|
|
154
|
+
```json
|
|
155
|
+
{
|
|
156
|
+
"questions": [
|
|
157
|
+
{
|
|
158
|
+
"question": "Does this scope match what you had in mind?",
|
|
159
|
+
"header": "Feature Scope",
|
|
160
|
+
"multiSelect": false,
|
|
161
|
+
"options": [
|
|
162
|
+
{ "label": "Looks good", "description": "Proceed to implementation plan" },
|
|
163
|
+
{ "label": "Too much", "description": "I want to trim the scope" },
|
|
164
|
+
{ "label": "Missing something", "description": "I'll tell you what to add" }
|
|
165
|
+
]
|
|
166
|
+
}
|
|
167
|
+
]
|
|
168
|
+
}
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
Iterate until the user confirms the scope.
|
|
172
|
+
|
|
173
|
+
---
|
|
174
|
+
|
|
175
|
+
## Step 4: Implementation Plan (REQUIRED)
|
|
176
|
+
|
|
177
|
+
Produce the implementation plan using the template in `assets/implementation-plan-template.md`.
|
|
178
|
+
|
|
179
|
+
### Planning Rules
|
|
180
|
+
|
|
181
|
+
- **Phase tasks logically**: database/schema first, then backend logic, then frontend, then tests.
|
|
182
|
+
- **Reference specific files**: Every task should mention the file path where the work happens. Use existing file paths for modifications; propose paths that follow existing conventions for new files.
|
|
183
|
+
- **Follow existing patterns**: If the project uses a specific pattern (e.g., repository pattern, single-action controllers), your plan must follow it.
|
|
184
|
+
- **Be concrete**: "Create UserNotification model with `user_id`, `type`, `message`, `read_at` columns" is better than "Create notification model".
|
|
185
|
+
- **Include test tasks**: Always include at least one testing phase.
|
|
186
|
+
- **Keep it achievable**: Aim for a plan that can be completed in a single session. If the feature is large, suggest splitting it and plan only the first part.
|
|
187
|
+
|
|
188
|
+
### Present the Plan
|
|
189
|
+
|
|
190
|
+
Output the filled-in implementation plan template, then ask:
|
|
191
|
+
|
|
192
|
+
```json
|
|
193
|
+
{
|
|
194
|
+
"questions": [
|
|
195
|
+
{
|
|
196
|
+
"question": "Does this implementation plan look correct?",
|
|
197
|
+
"header": "Plan Review",
|
|
198
|
+
"multiSelect": false,
|
|
199
|
+
"options": [
|
|
200
|
+
{ "label": "Approved", "description": "Save the plan and optionally create a proposal" },
|
|
201
|
+
{ "label": "Needs changes", "description": "I'll tell you what to adjust" }
|
|
202
|
+
]
|
|
203
|
+
}
|
|
204
|
+
]
|
|
205
|
+
}
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
Iterate if the user requests changes.
|
|
209
|
+
|
|
210
|
+
---
|
|
211
|
+
|
|
212
|
+
## Step 5: Save & Next Steps (REQUIRED)
|
|
213
|
+
|
|
214
|
+
Once approved, save the plan based on what's available in the project.
|
|
215
|
+
|
|
216
|
+
### If Prompter is installed
|
|
217
|
+
|
|
218
|
+
Check whether `prompter/core/proposal.md` exists using Glob.
|
|
219
|
+
|
|
220
|
+
If it exists, ask:
|
|
221
|
+
|
|
222
|
+
```json
|
|
223
|
+
{
|
|
224
|
+
"questions": [
|
|
225
|
+
{
|
|
226
|
+
"question": "How would you like to proceed?",
|
|
227
|
+
"header": "Next Steps",
|
|
228
|
+
"multiSelect": false,
|
|
229
|
+
"options": [
|
|
230
|
+
{ "label": "Create proposal", "description": "Scaffold a Prompter change proposal from this plan" },
|
|
231
|
+
{ "label": "Start building", "description": "Jump straight into implementation using this plan" },
|
|
232
|
+
{ "label": "Save plan only", "description": "Save the plan to a file for later" }
|
|
233
|
+
]
|
|
234
|
+
}
|
|
235
|
+
]
|
|
236
|
+
}
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
**If "Create proposal"**: Read `prompter/core/proposal.md` and `prompter/AGENTS.md`, then follow their instructions to scaffold a full change proposal. Use the implementation plan as context to derive:
|
|
240
|
+
- `change-id` (verb-led, kebab-case)
|
|
241
|
+
- `proposal.md` (why, what changes, impact)
|
|
242
|
+
- `tasks.md` (from the implementation phases)
|
|
243
|
+
- `design.md` (only if needed per Prompter criteria)
|
|
244
|
+
- Spec deltas under `specs/[capability]/spec.md`
|
|
245
|
+
|
|
246
|
+
After scaffolding, run `prompter validate <change-id> --strict --no-interactive` and fix any issues.
|
|
247
|
+
|
|
248
|
+
**If "Start building"**: Begin implementing the tasks from the plan sequentially. Read the plan as your checklist and complete each task in order.
|
|
249
|
+
|
|
250
|
+
**If "Save plan only"**: Write the plan to `implementation-plan.md` in the project root.
|
|
251
|
+
|
|
252
|
+
### If Prompter is NOT installed
|
|
253
|
+
|
|
254
|
+
Ask:
|
|
255
|
+
|
|
256
|
+
```json
|
|
257
|
+
{
|
|
258
|
+
"questions": [
|
|
259
|
+
{
|
|
260
|
+
"question": "What would you like to do next?",
|
|
261
|
+
"header": "Next Steps",
|
|
262
|
+
"multiSelect": false,
|
|
263
|
+
"options": [
|
|
264
|
+
{ "label": "Start building", "description": "Begin implementing the tasks now" },
|
|
265
|
+
{ "label": "Save plan only", "description": "Save the plan to a file for later" }
|
|
266
|
+
]
|
|
267
|
+
}
|
|
268
|
+
]
|
|
269
|
+
}
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
**If "Start building"**: Begin implementing tasks sequentially.
|
|
273
|
+
|
|
274
|
+
**If "Save plan only"**: Write the plan to `implementation-plan.md` in the project root.
|
|
275
|
+
|
|
276
|
+
---
|
|
277
|
+
|
|
278
|
+
## Conversation Tips
|
|
279
|
+
|
|
280
|
+
### Handling Large Features
|
|
281
|
+
- Suggest splitting into multiple increments.
|
|
282
|
+
- Plan only the first increment in detail.
|
|
283
|
+
- Note follow-up work in the "Out of scope" section.
|
|
284
|
+
- Use: "This is a big feature. I'd suggest we tackle [core part] first and add [extras] after."
|
|
285
|
+
|
|
286
|
+
### Handling Vague Requests
|
|
287
|
+
- Look at the codebase first to infer what the user might mean.
|
|
288
|
+
- If still unclear after codebase analysis, ask ONE focused clarifying question.
|
|
289
|
+
- Never ask more than 2 clarifying questions before producing a draft plan -- it's easier to iterate on a concrete plan than to keep asking questions.
|
|
290
|
+
|
|
291
|
+
### Handling Technical Users
|
|
292
|
+
- Skip obvious explanations.
|
|
293
|
+
- Focus on file paths, patterns, and concrete decisions.
|
|
294
|
+
- Be direct about tradeoffs.
|
|
295
|
+
|
|
296
|
+
### Handling Unfamiliar Codebases
|
|
297
|
+
- Spend more time in Step 2 (analysis).
|
|
298
|
+
- Read more example files to understand patterns.
|
|
299
|
+
- Be explicit about assumptions: "I'm assuming X based on what I see in Y -- correct me if wrong."
|
|
300
|
+
|
|
301
|
+
---
|
|
302
|
+
|
|
303
|
+
## Resources
|
|
304
|
+
|
|
305
|
+
- **Implementation plan template**: [implementation-plan-template.md](assets/implementation-plan-template.md) -- Structured output format for the plan
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# Implementation Plan: [Feature Name]
|
|
2
|
+
|
|
3
|
+
## Feature Overview
|
|
4
|
+
[1-2 sentence summary of what is being built and why]
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Scope
|
|
9
|
+
|
|
10
|
+
### In Scope
|
|
11
|
+
- [ ] [Change 1]
|
|
12
|
+
- [ ] [Change 2]
|
|
13
|
+
- [ ] [Change 3]
|
|
14
|
+
|
|
15
|
+
### Out of Scope
|
|
16
|
+
- [Deferred item 1] -- [reason]
|
|
17
|
+
- [Deferred item 2] -- [reason]
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Codebase Analysis
|
|
22
|
+
|
|
23
|
+
### Tech Stack Detected
|
|
24
|
+
| Layer | Technology |
|
|
25
|
+
|-------|-----------|
|
|
26
|
+
| Frontend | [e.g., Next.js, React] |
|
|
27
|
+
| Backend | [e.g., Laravel, Express] |
|
|
28
|
+
| Database | [e.g., PostgreSQL, MySQL] |
|
|
29
|
+
| Other | [e.g., Redis, Docker] |
|
|
30
|
+
|
|
31
|
+
### Affected Files & Modules
|
|
32
|
+
| File / Module | Change Type | Description |
|
|
33
|
+
|---------------|-------------|-------------|
|
|
34
|
+
| [path/to/file] | New / Modify / Delete | [What changes] |
|
|
35
|
+
|
|
36
|
+
### Existing Patterns to Follow
|
|
37
|
+
- [Pattern 1 observed in codebase -- e.g., "Controllers use single-action pattern"]
|
|
38
|
+
- [Pattern 2 -- e.g., "All API responses use ApiResource wrapper"]
|
|
39
|
+
- [Pattern 3 -- e.g., "Tests use factories with specific naming convention"]
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Data Model Changes
|
|
44
|
+
> Skip this section if no database changes are needed.
|
|
45
|
+
|
|
46
|
+
### New Tables / Collections
|
|
47
|
+
- **[table_name]**: [key columns/fields]
|
|
48
|
+
|
|
49
|
+
### Modified Tables / Collections
|
|
50
|
+
- **[table_name]**: Add [column] ([type]) -- [reason]
|
|
51
|
+
|
|
52
|
+
### New Relationships
|
|
53
|
+
- [Entity A] has many [Entity B]
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Implementation Tasks
|
|
58
|
+
|
|
59
|
+
### Phase 1: [Foundation / Database / Setup]
|
|
60
|
+
- [ ] 1.1 [Task description] -- `path/to/file`
|
|
61
|
+
- [ ] 1.2 [Task description] -- `path/to/file`
|
|
62
|
+
|
|
63
|
+
### Phase 2: [Core Logic / Backend]
|
|
64
|
+
- [ ] 2.1 [Task description] -- `path/to/file`
|
|
65
|
+
- [ ] 2.2 [Task description] -- `path/to/file`
|
|
66
|
+
|
|
67
|
+
### Phase 3: [Frontend / UI]
|
|
68
|
+
- [ ] 3.1 [Task description] -- `path/to/file`
|
|
69
|
+
- [ ] 3.2 [Task description] -- `path/to/file`
|
|
70
|
+
|
|
71
|
+
### Phase 4: [Tests / Validation]
|
|
72
|
+
- [ ] 4.1 [Task description] -- `path/to/file`
|
|
73
|
+
- [ ] 4.2 [Task description] -- `path/to/file`
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## Dependencies & Risks
|
|
78
|
+
| Risk | Impact | Mitigation |
|
|
79
|
+
|------|--------|------------|
|
|
80
|
+
| [Risk 1] | [High/Med/Low] | [How to handle] |
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## Notes
|
|
85
|
+
- [Any additional context, edge cases, or decisions made during planning]
|