mindsystem-cc 3.0.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 +501 -0
- package/agents/ms-codebase-mapper.md +739 -0
- package/agents/ms-debugger.md +1184 -0
- package/agents/ms-designer.md +414 -0
- package/agents/ms-executor.md +760 -0
- package/agents/ms-integration-checker.md +423 -0
- package/agents/ms-milestone-auditor.md +448 -0
- package/agents/ms-mock-generator.md +182 -0
- package/agents/ms-plan-checker.md +746 -0
- package/agents/ms-research-synthesizer.md +248 -0
- package/agents/ms-researcher.md +962 -0
- package/agents/ms-roadmapper.md +606 -0
- package/agents/ms-verifier.md +779 -0
- package/agents/ms-verify-fixer.md +124 -0
- package/bin/install.js +296 -0
- package/commands/ms/add-phase.md +207 -0
- package/commands/ms/add-todo.md +182 -0
- package/commands/ms/audit-milestone.md +318 -0
- package/commands/ms/check-phase.md +162 -0
- package/commands/ms/check-todos.md +217 -0
- package/commands/ms/complete-milestone.md +137 -0
- package/commands/ms/create-roadmap.md +273 -0
- package/commands/ms/debug.md +149 -0
- package/commands/ms/define-requirements.md +121 -0
- package/commands/ms/design-phase.md +341 -0
- package/commands/ms/discuss-milestone.md +48 -0
- package/commands/ms/discuss-phase.md +60 -0
- package/commands/ms/do-work.md +90 -0
- package/commands/ms/execute-phase.md +289 -0
- package/commands/ms/help.md +623 -0
- package/commands/ms/insert-phase.md +227 -0
- package/commands/ms/list-phase-assumptions.md +50 -0
- package/commands/ms/map-codebase.md +71 -0
- package/commands/ms/new-milestone.md +193 -0
- package/commands/ms/new-project.md +338 -0
- package/commands/ms/pause-work.md +123 -0
- package/commands/ms/plan-milestone-gaps.md +285 -0
- package/commands/ms/plan-phase.md +105 -0
- package/commands/ms/progress.md +370 -0
- package/commands/ms/remove-phase.md +338 -0
- package/commands/ms/research-phase.md +175 -0
- package/commands/ms/research-project.md +339 -0
- package/commands/ms/resume-work.md +40 -0
- package/commands/ms/review-design.md +484 -0
- package/commands/ms/simplify-flutter.md +193 -0
- package/commands/ms/update.md +159 -0
- package/commands/ms/verify-work.md +92 -0
- package/commands/ms/whats-new.md +124 -0
- package/mindsystem/references/checkpoints.md +788 -0
- package/mindsystem/references/continuation-format.md +255 -0
- package/mindsystem/references/debugging/debugging-mindset.md +11 -0
- package/mindsystem/references/debugging/hypothesis-testing.md +11 -0
- package/mindsystem/references/debugging/investigation-techniques.md +11 -0
- package/mindsystem/references/debugging/verification-patterns.md +11 -0
- package/mindsystem/references/debugging/when-to-research.md +11 -0
- package/mindsystem/references/git-integration.md +254 -0
- package/mindsystem/references/goal-backward.md +286 -0
- package/mindsystem/references/mock-patterns.md +294 -0
- package/mindsystem/references/plan-format.md +473 -0
- package/mindsystem/references/principles.md +73 -0
- package/mindsystem/references/questioning.md +140 -0
- package/mindsystem/references/research-pitfalls.md +233 -0
- package/mindsystem/references/scope-estimation.md +256 -0
- package/mindsystem/references/tdd.md +263 -0
- package/mindsystem/references/verification-patterns.md +595 -0
- package/mindsystem/templates/DEBUG.md +159 -0
- package/mindsystem/templates/UAT.md +403 -0
- package/mindsystem/templates/adhoc-summary.md +153 -0
- package/mindsystem/templates/codebase/architecture.md +255 -0
- package/mindsystem/templates/codebase/concerns.md +310 -0
- package/mindsystem/templates/codebase/conventions.md +307 -0
- package/mindsystem/templates/codebase/integrations.md +280 -0
- package/mindsystem/templates/codebase/stack.md +186 -0
- package/mindsystem/templates/codebase/structure.md +285 -0
- package/mindsystem/templates/codebase/testing.md +480 -0
- package/mindsystem/templates/config.json +26 -0
- package/mindsystem/templates/context.md +140 -0
- package/mindsystem/templates/continue-here.md +78 -0
- package/mindsystem/templates/debug-subagent-prompt.md +91 -0
- package/mindsystem/templates/design-iteration.md +208 -0
- package/mindsystem/templates/design.md +417 -0
- package/mindsystem/templates/discovery.md +146 -0
- package/mindsystem/templates/milestone-archive.md +123 -0
- package/mindsystem/templates/milestone-context.md +93 -0
- package/mindsystem/templates/milestone.md +115 -0
- package/mindsystem/templates/phase-prompt.md +574 -0
- package/mindsystem/templates/project.md +184 -0
- package/mindsystem/templates/requirements.md +231 -0
- package/mindsystem/templates/research-project/ARCHITECTURE.md +204 -0
- package/mindsystem/templates/research-project/FEATURES.md +147 -0
- package/mindsystem/templates/research-project/PITFALLS.md +200 -0
- package/mindsystem/templates/research-project/STACK.md +120 -0
- package/mindsystem/templates/research-project/SUMMARY.md +170 -0
- package/mindsystem/templates/research-subagent-prompt.md +92 -0
- package/mindsystem/templates/research.md +529 -0
- package/mindsystem/templates/roadmap.md +214 -0
- package/mindsystem/templates/state.md +224 -0
- package/mindsystem/templates/summary.md +269 -0
- package/mindsystem/templates/user-setup.md +323 -0
- package/mindsystem/templates/verification-report.md +322 -0
- package/mindsystem/workflows/complete-milestone.md +759 -0
- package/mindsystem/workflows/create-milestone.md +203 -0
- package/mindsystem/workflows/debug.md +14 -0
- package/mindsystem/workflows/define-requirements.md +330 -0
- package/mindsystem/workflows/diagnose-issues.md +241 -0
- package/mindsystem/workflows/discovery-phase.md +293 -0
- package/mindsystem/workflows/discuss-milestone.md +310 -0
- package/mindsystem/workflows/discuss-phase.md +237 -0
- package/mindsystem/workflows/do-work.md +359 -0
- package/mindsystem/workflows/execute-phase.md +644 -0
- package/mindsystem/workflows/execute-plan.md +1828 -0
- package/mindsystem/workflows/generate-mocks.md +187 -0
- package/mindsystem/workflows/list-phase-assumptions.md +178 -0
- package/mindsystem/workflows/map-codebase.md +289 -0
- package/mindsystem/workflows/plan-phase.md +876 -0
- package/mindsystem/workflows/research-phase.md +17 -0
- package/mindsystem/workflows/research-project.md +23 -0
- package/mindsystem/workflows/resume-project.md +311 -0
- package/mindsystem/workflows/transition.md +564 -0
- package/mindsystem/workflows/verify-phase.md +629 -0
- package/mindsystem/workflows/verify-work.md +823 -0
- package/package.json +32 -0
- package/scripts/generate-phase-patch.sh +169 -0
- package/scripts/ms-lookup/README.md +112 -0
- package/scripts/ms-lookup/ms_lookup/__init__.py +3 -0
- package/scripts/ms-lookup/ms_lookup/__main__.py +6 -0
- package/scripts/ms-lookup/ms_lookup/backends/__init__.py +6 -0
- package/scripts/ms-lookup/ms_lookup/backends/context7.py +219 -0
- package/scripts/ms-lookup/ms_lookup/backends/perplexity.py +145 -0
- package/scripts/ms-lookup/ms_lookup/cache.py +48 -0
- package/scripts/ms-lookup/ms_lookup/cli.py +219 -0
- package/scripts/ms-lookup/ms_lookup/config.py +23 -0
- package/scripts/ms-lookup/ms_lookup/errors.py +24 -0
- package/scripts/ms-lookup/ms_lookup/output.py +49 -0
- package/scripts/ms-lookup/ms_lookup/tokens.py +56 -0
- package/scripts/ms-lookup/pyproject.toml +17 -0
- package/scripts/ms-lookup/uv.lock +207 -0
- package/scripts/ms-lookup-wrapper.sh +21 -0
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# Debug Subagent Prompt Template
|
|
2
|
+
|
|
3
|
+
Template for spawning ms-debugger agent. The agent contains all debugging expertise - this template provides problem context only.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Template
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
<objective>
|
|
11
|
+
Investigate issue: {issue_id}
|
|
12
|
+
|
|
13
|
+
**Summary:** {issue_summary}
|
|
14
|
+
</objective>
|
|
15
|
+
|
|
16
|
+
<symptoms>
|
|
17
|
+
expected: {expected}
|
|
18
|
+
actual: {actual}
|
|
19
|
+
errors: {errors}
|
|
20
|
+
reproduction: {reproduction}
|
|
21
|
+
timeline: {timeline}
|
|
22
|
+
</symptoms>
|
|
23
|
+
|
|
24
|
+
<mode>
|
|
25
|
+
symptoms_prefilled: {true_or_false}
|
|
26
|
+
goal: {find_root_cause_only | find_and_fix}
|
|
27
|
+
</mode>
|
|
28
|
+
|
|
29
|
+
<debug_file>
|
|
30
|
+
Create: .planning/debug/{slug}.md
|
|
31
|
+
</debug_file>
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Placeholders
|
|
37
|
+
|
|
38
|
+
| Placeholder | Source | Example |
|
|
39
|
+
|-------------|--------|---------|
|
|
40
|
+
| `{issue_id}` | Orchestrator-assigned | `auth-screen-dark` |
|
|
41
|
+
| `{issue_summary}` | User description | `Auth screen is too dark` |
|
|
42
|
+
| `{expected}` | From symptoms | `See logo clearly` |
|
|
43
|
+
| `{actual}` | From symptoms | `Screen is dark` |
|
|
44
|
+
| `{errors}` | From symptoms | `None in console` |
|
|
45
|
+
| `{reproduction}` | From symptoms | `Open /auth page` |
|
|
46
|
+
| `{timeline}` | From symptoms | `After recent deploy` |
|
|
47
|
+
| `{goal}` | Orchestrator sets | `find_and_fix` |
|
|
48
|
+
| `{slug}` | Generated | `auth-screen-dark` |
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Usage
|
|
53
|
+
|
|
54
|
+
**From /ms:debug:**
|
|
55
|
+
```python
|
|
56
|
+
Task(
|
|
57
|
+
prompt=filled_template,
|
|
58
|
+
subagent_type="ms-debugger",
|
|
59
|
+
description="Debug {slug}"
|
|
60
|
+
)
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
**From diagnose-issues (UAT):**
|
|
64
|
+
```python
|
|
65
|
+
Task(prompt=template, subagent_type="ms-debugger", description="Debug UAT-001")
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## Continuation
|
|
71
|
+
|
|
72
|
+
For checkpoints, spawn fresh agent with:
|
|
73
|
+
|
|
74
|
+
```markdown
|
|
75
|
+
<objective>
|
|
76
|
+
Continue debugging {slug}. Evidence is in the debug file.
|
|
77
|
+
</objective>
|
|
78
|
+
|
|
79
|
+
<prior_state>
|
|
80
|
+
Debug file: @.planning/debug/{slug}.md
|
|
81
|
+
</prior_state>
|
|
82
|
+
|
|
83
|
+
<checkpoint_response>
|
|
84
|
+
**Type:** {checkpoint_type}
|
|
85
|
+
**Response:** {user_response}
|
|
86
|
+
</checkpoint_response>
|
|
87
|
+
|
|
88
|
+
<mode>
|
|
89
|
+
goal: {goal}
|
|
90
|
+
</mode>
|
|
91
|
+
```
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
# Design Iteration Template
|
|
2
|
+
|
|
3
|
+
Template for structured feedback when refining a design. Use this for major redesigns or when multiple aspects need adjustment.
|
|
4
|
+
|
|
5
|
+
**When to use:**
|
|
6
|
+
- User requests significant changes to DESIGN.md
|
|
7
|
+
- Multiple feedback points need to be captured
|
|
8
|
+
- Context from previous iteration should be preserved
|
|
9
|
+
|
|
10
|
+
**When NOT to use:**
|
|
11
|
+
- Single small tweak (edit DESIGN.md directly)
|
|
12
|
+
- Typo or value correction (edit DESIGN.md directly)
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Iteration Prompt Structure
|
|
17
|
+
|
|
18
|
+
When spawning ms-designer for a redesign, assemble this context:
|
|
19
|
+
|
|
20
|
+
```markdown
|
|
21
|
+
<iteration_context>
|
|
22
|
+
Product: [From PROJECT.md - What This Is]
|
|
23
|
+
Phase: [N]: [Phase name]
|
|
24
|
+
Iteration: v[N] (previous: v[N-1])
|
|
25
|
+
</iteration_context>
|
|
26
|
+
|
|
27
|
+
<previous_design>
|
|
28
|
+
[Include key sections from current DESIGN.md that are relevant to the changes]
|
|
29
|
+
|
|
30
|
+
Visual Identity:
|
|
31
|
+
[Current visual identity section]
|
|
32
|
+
|
|
33
|
+
Relevant screens/components:
|
|
34
|
+
[Sections being modified]
|
|
35
|
+
</previous_design>
|
|
36
|
+
|
|
37
|
+
<feedback_on_previous>
|
|
38
|
+
## What Worked Well (KEEP)
|
|
39
|
+
|
|
40
|
+
[List aspects that should be preserved - be specific]
|
|
41
|
+
- [Aspect 1]: [Why it works]
|
|
42
|
+
- [Aspect 2]: [Why it works]
|
|
43
|
+
|
|
44
|
+
## What Needs Improvement (FIX)
|
|
45
|
+
|
|
46
|
+
[List specific issues with actionable direction]
|
|
47
|
+
- [Issue 1]: [What's wrong] → [How to fix]
|
|
48
|
+
- [Issue 2]: [What's wrong] → [How to fix]
|
|
49
|
+
|
|
50
|
+
## New Requirements (ADD)
|
|
51
|
+
|
|
52
|
+
[List any new elements not in previous design]
|
|
53
|
+
- [New requirement 1]: [What and why]
|
|
54
|
+
- [New requirement 2]: [What and why]
|
|
55
|
+
|
|
56
|
+
If none: "No new requirements - this is refinement only."
|
|
57
|
+
</feedback_on_previous>
|
|
58
|
+
|
|
59
|
+
<specific_focus>
|
|
60
|
+
## Primary Focus for This Iteration
|
|
61
|
+
|
|
62
|
+
[The single most important thing that must improve]
|
|
63
|
+
|
|
64
|
+
This is the ONE thing that determines if this iteration succeeds.
|
|
65
|
+
</specific_focus>
|
|
66
|
+
|
|
67
|
+
<constraints>
|
|
68
|
+
## Constraints
|
|
69
|
+
|
|
70
|
+
- Preserve: [Aspects that must NOT change]
|
|
71
|
+
- Budget: [Any limitations on scope]
|
|
72
|
+
- Timeline: [If relevant]
|
|
73
|
+
</constraints>
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## Example Usage
|
|
79
|
+
|
|
80
|
+
### Example 1: Color Refinement
|
|
81
|
+
|
|
82
|
+
```markdown
|
|
83
|
+
<iteration_context>
|
|
84
|
+
Product: Analytics Dashboard
|
|
85
|
+
Phase: 3: User Dashboard
|
|
86
|
+
Iteration: v2 (previous: v1)
|
|
87
|
+
</iteration_context>
|
|
88
|
+
|
|
89
|
+
<previous_design>
|
|
90
|
+
Visual Identity:
|
|
91
|
+
Professional analytics dashboard with dark mode. Deep navy background (#0a0f1a) with amber accent (#F59E0B).
|
|
92
|
+
|
|
93
|
+
Design System Colors:
|
|
94
|
+
- Primary: #0a0f1a
|
|
95
|
+
- Secondary: #1a1f2e
|
|
96
|
+
- Text: #ffffff
|
|
97
|
+
- Accent: #F59E0B
|
|
98
|
+
</previous_design>
|
|
99
|
+
|
|
100
|
+
<feedback_on_previous>
|
|
101
|
+
## What Worked Well (KEEP)
|
|
102
|
+
|
|
103
|
+
- Deep navy background (#0a0f1a): Distinctive, not generic black
|
|
104
|
+
- Overall layout structure: Information hierarchy is clear
|
|
105
|
+
- Component spacing (16px gaps): Feels intentional
|
|
106
|
+
|
|
107
|
+
## What Needs Improvement (FIX)
|
|
108
|
+
|
|
109
|
+
- Amber accent (#F59E0B): Too warm, clashes with navy → Try cooler accent (teal or cyan)
|
|
110
|
+
- Card backgrounds (#1a1f2e): Not enough contrast with primary → Increase lightness
|
|
111
|
+
- Text secondary (#8b95a8): Too muted, hard to read → Brighten to #a0aec0
|
|
112
|
+
|
|
113
|
+
## New Requirements (ADD)
|
|
114
|
+
|
|
115
|
+
No new requirements - this is refinement only.
|
|
116
|
+
</feedback_on_previous>
|
|
117
|
+
|
|
118
|
+
<specific_focus>
|
|
119
|
+
## Primary Focus for This Iteration
|
|
120
|
+
|
|
121
|
+
Fix the accent color. The amber feels disconnected from the cool navy palette. Find an accent that energizes without clashing.
|
|
122
|
+
</specific_focus>
|
|
123
|
+
|
|
124
|
+
<constraints>
|
|
125
|
+
## Constraints
|
|
126
|
+
|
|
127
|
+
- Preserve: Deep navy primary, overall layout structure
|
|
128
|
+
- Budget: Color changes only, no layout modifications
|
|
129
|
+
</constraints>
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### Example 2: Layout Restructure
|
|
133
|
+
|
|
134
|
+
```markdown
|
|
135
|
+
<iteration_context>
|
|
136
|
+
Product: Task Management App
|
|
137
|
+
Phase: 5: Kanban Board
|
|
138
|
+
Iteration: v3 (previous: v2)
|
|
139
|
+
</iteration_context>
|
|
140
|
+
|
|
141
|
+
<previous_design>
|
|
142
|
+
Screen Layout (Kanban Board):
|
|
143
|
+
+------------------------------------------+
|
|
144
|
+
| [Header] |
|
|
145
|
+
+------------------------------------------+
|
|
146
|
+
| [Col 1] | [Col 2] | [Col 3] | [Col 4] |
|
|
147
|
+
| Card | Card | Card | Card |
|
|
148
|
+
| Card | Card | | |
|
|
149
|
+
+------------------------------------------+
|
|
150
|
+
</previous_design>
|
|
151
|
+
|
|
152
|
+
<feedback_on_previous>
|
|
153
|
+
## What Worked Well (KEEP)
|
|
154
|
+
|
|
155
|
+
- Card design: Clean, readable, good use of labels
|
|
156
|
+
- Column headers: Clear status indication
|
|
157
|
+
- Drag handles: Obvious affordance
|
|
158
|
+
|
|
159
|
+
## What Needs Improvement (FIX)
|
|
160
|
+
|
|
161
|
+
- Fixed 4-column layout: Doesn't scale on smaller screens → Make columns scrollable horizontally
|
|
162
|
+
- No column collapse: Too much visual noise → Add ability to collapse columns
|
|
163
|
+
- Cards too tall: Take too much vertical space → Compact mode option
|
|
164
|
+
|
|
165
|
+
## New Requirements (ADD)
|
|
166
|
+
|
|
167
|
+
- Swimlanes: Group cards by assignee (horizontal rows within columns)
|
|
168
|
+
- Quick add: Inline card creation without modal
|
|
169
|
+
</feedback_on_previous>
|
|
170
|
+
|
|
171
|
+
<specific_focus>
|
|
172
|
+
## Primary Focus for This Iteration
|
|
173
|
+
|
|
174
|
+
Make the board work on tablet (768px). Current fixed 4-column breaks completely.
|
|
175
|
+
</specific_focus>
|
|
176
|
+
|
|
177
|
+
<constraints>
|
|
178
|
+
## Constraints
|
|
179
|
+
|
|
180
|
+
- Preserve: Card visual design, drag-drop interaction
|
|
181
|
+
- Budget: Layout changes, no new visual styling
|
|
182
|
+
</constraints>
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## Guidelines
|
|
188
|
+
|
|
189
|
+
**Feedback should be:**
|
|
190
|
+
- **Specific:** "Amber accent clashes" not "colors are wrong"
|
|
191
|
+
- **Actionable:** Include direction, not just criticism
|
|
192
|
+
- **Prioritized:** Primary focus identifies the ONE thing
|
|
193
|
+
|
|
194
|
+
**Preserve section is critical:**
|
|
195
|
+
- Explicitly list what must NOT change
|
|
196
|
+
- Prevents accidental regression of working aspects
|
|
197
|
+
- Designer knows boundaries
|
|
198
|
+
|
|
199
|
+
**Primary focus drives success:**
|
|
200
|
+
- If this ONE thing improves, iteration succeeds
|
|
201
|
+
- Keeps designer from getting lost in details
|
|
202
|
+
- Enables focused refinement
|
|
203
|
+
|
|
204
|
+
**After iteration:**
|
|
205
|
+
- Compare v[N] to v[N-1] against feedback
|
|
206
|
+
- Verify "what worked well" was preserved
|
|
207
|
+
- Verify "what needs improvement" was addressed
|
|
208
|
+
- Update design version in DESIGN.md frontmatter
|
|
@@ -0,0 +1,417 @@
|
|
|
1
|
+
# Design Template
|
|
2
|
+
|
|
3
|
+
Template for `.planning/phases/XX-name/{phase}-DESIGN.md` - captures visual/UX design specifications for a phase.
|
|
4
|
+
|
|
5
|
+
**Purpose:** Translate user vision into concrete, implementable design specifications. This is design context, not technical implementation. Technical details come from research and planning.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## File Template
|
|
10
|
+
|
|
11
|
+
```markdown
|
|
12
|
+
# Phase [X]: [Name] - Design Specification
|
|
13
|
+
|
|
14
|
+
**Designed:** [date]
|
|
15
|
+
**Platform:** [web / mobile / both]
|
|
16
|
+
**Aesthetic source:** [implement-ui skill / codebase analysis / fresh design]
|
|
17
|
+
|
|
18
|
+
## Visual Identity
|
|
19
|
+
|
|
20
|
+
[2-3 sentences describing the design philosophy and feelings evoked. What's the vibe? What should users feel when they see this interface?]
|
|
21
|
+
|
|
22
|
+
**Design direction:**
|
|
23
|
+
- Overall feel: [e.g., "Professional yet approachable"]
|
|
24
|
+
- Key differentiator: [e.g., "Generous whitespace, subtle animations"]
|
|
25
|
+
- Inspiration: [e.g., "Linear's clean density, Notion's approachability"]
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Screen Layouts
|
|
30
|
+
|
|
31
|
+
### [Screen 1 Name]
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
+--------------------------------------------------+
|
|
35
|
+
| [Header Area] |
|
|
36
|
+
| Logo Nav Items User Avatar |
|
|
37
|
+
+--------------------------------------------------+
|
|
38
|
+
| |
|
|
39
|
+
| [Main Content Area] |
|
|
40
|
+
| |
|
|
41
|
+
| +---------------------+ +-------------------+ |
|
|
42
|
+
| | | | | |
|
|
43
|
+
| | Primary Card | | Secondary Card | |
|
|
44
|
+
| | | | | |
|
|
45
|
+
| +---------------------+ +-------------------+ |
|
|
46
|
+
| |
|
|
47
|
+
| +---------------------------------------------+ |
|
|
48
|
+
| | Full-width Section | |
|
|
49
|
+
| +---------------------------------------------+ |
|
|
50
|
+
| |
|
|
51
|
+
+--------------------------------------------------+
|
|
52
|
+
| [Footer] |
|
|
53
|
+
+--------------------------------------------------+
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**Dimensions:** [width x height or responsive]
|
|
57
|
+
**Edge padding:** [value]px
|
|
58
|
+
**Component gaps:** [value]px
|
|
59
|
+
**Components used:**
|
|
60
|
+
- Header: [component names]
|
|
61
|
+
- Cards: [component names]
|
|
62
|
+
- Footer: [component names]
|
|
63
|
+
|
|
64
|
+
**Responsive behavior:**
|
|
65
|
+
- Desktop (1024px+): [layout description]
|
|
66
|
+
- Tablet (768-1024px): [layout changes]
|
|
67
|
+
- Mobile (<768px): [layout changes]
|
|
68
|
+
|
|
69
|
+
### [Screen 2 Name]
|
|
70
|
+
|
|
71
|
+
[Repeat structure for each screen]
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Component Specifications
|
|
76
|
+
|
|
77
|
+
### [Component Name]
|
|
78
|
+
|
|
79
|
+
**Purpose:** [what this component does]
|
|
80
|
+
|
|
81
|
+
**Visual:**
|
|
82
|
+
- Background: [color/gradient]
|
|
83
|
+
- Border: [style, color, radius]
|
|
84
|
+
- Shadow: [depth level]
|
|
85
|
+
- Size: [min/max dimensions]
|
|
86
|
+
|
|
87
|
+
**States:**
|
|
88
|
+
| State | Visual Change | Trigger |
|
|
89
|
+
|-------|--------------|---------|
|
|
90
|
+
| Default | [base appearance] | Initial |
|
|
91
|
+
| Hover | [change description] | Mouse over (web) |
|
|
92
|
+
| Active | [change description] | Click/tap |
|
|
93
|
+
| Disabled | [change description] | Interaction blocked |
|
|
94
|
+
| Loading | [change description] | Async operation |
|
|
95
|
+
|
|
96
|
+
**Content:**
|
|
97
|
+
- Typography: [font, size, weight, color]
|
|
98
|
+
- Icons: [if any, which ones, sizing]
|
|
99
|
+
- Spacing: [internal padding]
|
|
100
|
+
|
|
101
|
+
**Platform notes:**
|
|
102
|
+
- Web: [specific considerations]
|
|
103
|
+
- iOS: [specific considerations]
|
|
104
|
+
- Android: [specific considerations]
|
|
105
|
+
|
|
106
|
+
### [Next Component]
|
|
107
|
+
|
|
108
|
+
[Repeat for each component]
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## UX Flows
|
|
113
|
+
|
|
114
|
+
### [Flow Name]
|
|
115
|
+
|
|
116
|
+
**Entry point:** [what triggers this flow]
|
|
117
|
+
**Goal:** [what user is trying to accomplish]
|
|
118
|
+
|
|
119
|
+
**Steps:**
|
|
120
|
+
1. User sees [initial screen/state]
|
|
121
|
+
2. User [action] on [element]
|
|
122
|
+
3. App responds with [feedback/transition]
|
|
123
|
+
4. User sees [next screen/state]
|
|
124
|
+
5. [Continue as needed]
|
|
125
|
+
|
|
126
|
+
**Decision points:**
|
|
127
|
+
- At step [N]: If [condition], go to step [X]; else continue
|
|
128
|
+
- [Additional branches]
|
|
129
|
+
|
|
130
|
+
**Success state:**
|
|
131
|
+
- User sees: [what appears]
|
|
132
|
+
- System state: [what changed]
|
|
133
|
+
|
|
134
|
+
**Error handling:**
|
|
135
|
+
- If [error condition]: Show [error message/state]
|
|
136
|
+
- Recovery: [how user recovers]
|
|
137
|
+
|
|
138
|
+
### [Next Flow]
|
|
139
|
+
|
|
140
|
+
[Repeat for each flow]
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## Design System Decisions
|
|
145
|
+
|
|
146
|
+
| Category | Decision | Values | Rationale |
|
|
147
|
+
|----------|----------|--------|-----------|
|
|
148
|
+
| **Colors** | Primary | `#[hex]` | [why this color] |
|
|
149
|
+
| | Secondary | `#[hex]` | [why this color] |
|
|
150
|
+
| | Background | `#[hex]` | [why this color] |
|
|
151
|
+
| | Text | `#[hex]` | [why this color] |
|
|
152
|
+
| | Accent | `#[hex]` | [why this color] |
|
|
153
|
+
| | Error | `#[hex]` | [standard red variant] |
|
|
154
|
+
| | Success | `#[hex]` | [standard green variant] |
|
|
155
|
+
| **Typography** | Headings | [font family] | [why chosen] |
|
|
156
|
+
| | Body | [font family] | [why chosen] |
|
|
157
|
+
| | H1 | [size/weight] | [hierarchy purpose] |
|
|
158
|
+
| | H2 | [size/weight] | [hierarchy purpose] |
|
|
159
|
+
| | Body | [size/weight] | [hierarchy purpose] |
|
|
160
|
+
| | Caption | [size/weight] | [hierarchy purpose] |
|
|
161
|
+
| **Spacing** | Base unit | [4px / 8px] | [scaling approach] |
|
|
162
|
+
| | Edge padding | [value]px | [breathing room] |
|
|
163
|
+
| | Component gap | [value]px | [relationship] |
|
|
164
|
+
| | Section gap | [value]px | [separation] |
|
|
165
|
+
| **Borders** | Radius | [value]px | [style approach] |
|
|
166
|
+
| | Width | [value]px | [visibility] |
|
|
167
|
+
| **Shadows** | Elevation 1 | [values] | [subtle depth] |
|
|
168
|
+
| | Elevation 2 | [values] | [prominent depth] |
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## Platform-Specific Notes
|
|
173
|
+
|
|
174
|
+
### Web (React + Tailwind)
|
|
175
|
+
|
|
176
|
+
**Responsive breakpoints:**
|
|
177
|
+
- Mobile: `< 640px`
|
|
178
|
+
- Tablet: `640px - 1024px`
|
|
179
|
+
- Desktop: `> 1024px`
|
|
180
|
+
|
|
181
|
+
**Touch targets:** Minimum 44x44px for interactive elements
|
|
182
|
+
|
|
183
|
+
**Keyboard navigation:**
|
|
184
|
+
- [Which elements should be focusable]
|
|
185
|
+
- [Focus order/flow]
|
|
186
|
+
|
|
187
|
+
**Accessibility:**
|
|
188
|
+
- Color contrast: WCAG AA (4.5:1 body text, 3:1 large text)
|
|
189
|
+
- Screen reader: [aria labels needed]
|
|
190
|
+
|
|
191
|
+
### Mobile (Flutter)
|
|
192
|
+
|
|
193
|
+
**iOS considerations:**
|
|
194
|
+
- Follow HIG for [specific patterns]
|
|
195
|
+
- Safe area insets: Respect notch/home indicator
|
|
196
|
+
- Navigation: [pattern - stack, tabs, drawer]
|
|
197
|
+
|
|
198
|
+
**Android considerations:**
|
|
199
|
+
- Follow Material Design 3 for [specific patterns]
|
|
200
|
+
- System bars: [edge-to-edge consideration]
|
|
201
|
+
- Back gesture: [handling]
|
|
202
|
+
|
|
203
|
+
**Shared:**
|
|
204
|
+
- Touch targets: 48x48dp minimum
|
|
205
|
+
- Text sizes: 16sp minimum for body text
|
|
206
|
+
|
|
207
|
+
---
|
|
208
|
+
|
|
209
|
+
## Verification Criteria
|
|
210
|
+
|
|
211
|
+
Observable behaviors that prove this design was implemented correctly:
|
|
212
|
+
|
|
213
|
+
### Visual Verification
|
|
214
|
+
- [ ] Color palette matches specification exactly
|
|
215
|
+
- [ ] Typography hierarchy is clearly visible
|
|
216
|
+
- [ ] Spacing follows specified scale consistently
|
|
217
|
+
- [ ] Components match specified states and transitions
|
|
218
|
+
|
|
219
|
+
### Functional Verification
|
|
220
|
+
- [ ] [Screen 1]: User can [primary action]
|
|
221
|
+
- [ ] [Screen 2]: User can [primary action]
|
|
222
|
+
- [ ] [Flow 1]: User can complete [goal]
|
|
223
|
+
- [ ] Error states display correctly when [condition]
|
|
224
|
+
|
|
225
|
+
### Platform Verification
|
|
226
|
+
- [ ] Web: Responsive layout works at all breakpoints
|
|
227
|
+
- [ ] Web: Keyboard navigation functional
|
|
228
|
+
- [ ] Mobile: Touch targets meet minimum size
|
|
229
|
+
- [ ] Mobile: Safe areas respected
|
|
230
|
+
|
|
231
|
+
### Accessibility Verification
|
|
232
|
+
- [ ] Color contrast meets WCAG AA
|
|
233
|
+
- [ ] Screen reader can navigate all interactive elements
|
|
234
|
+
- [ ] Focus states are visible
|
|
235
|
+
|
|
236
|
+
---
|
|
237
|
+
|
|
238
|
+
*Phase: XX-name*
|
|
239
|
+
*Design created: [date]*
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
<good_examples>
|
|
243
|
+
```markdown
|
|
244
|
+
# Phase 3: User Dashboard - Design Specification
|
|
245
|
+
|
|
246
|
+
**Designed:** 2026-01-19
|
|
247
|
+
**Platform:** Web (React + Tailwind)
|
|
248
|
+
**Aesthetic source:** Codebase analysis + fresh design
|
|
249
|
+
|
|
250
|
+
## Visual Identity
|
|
251
|
+
|
|
252
|
+
Professional analytics dashboard with approachable data visualization. Clean density inspired by Linear, with generous whitespace that doesn't sacrifice information. Dark mode primary (analysts work long hours), with a distinctive deep navy (`#0a0f1a`) instead of generic black. Amber accent (`#F59E0B`) for energy and warmth.
|
|
253
|
+
|
|
254
|
+
**Design direction:**
|
|
255
|
+
- Overall feel: "Powerful yet approachable"
|
|
256
|
+
- Key differentiator: "Data-dense without feeling cluttered"
|
|
257
|
+
- Inspiration: Linear's information hierarchy, Stripe's professional polish
|
|
258
|
+
|
|
259
|
+
---
|
|
260
|
+
|
|
261
|
+
## Screen Layouts
|
|
262
|
+
|
|
263
|
+
### Dashboard Overview
|
|
264
|
+
|
|
265
|
+
```
|
|
266
|
+
+------------------------------------------------------------------+
|
|
267
|
+
| [Sidebar] | [Header: Page Title Date Picker [Export]] |
|
|
268
|
+
| |--------------------------------------------------------|
|
|
269
|
+
| [Logo] | |
|
|
270
|
+
| | [KPI Card 1] [KPI Card 2] [KPI Card 3] [KPI 4] |
|
|
271
|
+
| Dashboard | |
|
|
272
|
+
| Campaigns |--------------------------------------------------------|
|
|
273
|
+
| Reports | |
|
|
274
|
+
| Settings | +--------------------------------------------+ |
|
|
275
|
+
| | | | |
|
|
276
|
+
| [Avatar] | | Main Chart Area | |
|
|
277
|
+
| | | (Trend over time) | |
|
|
278
|
+
| | | | |
|
|
279
|
+
| | +--------------------------------------------+ |
|
|
280
|
+
| | |
|
|
281
|
+
| | +---------------------+ +---------------------+ |
|
|
282
|
+
| | | Secondary Chart 1 | | Secondary Chart 2 | |
|
|
283
|
+
| | | (Funnel) | | (Top Campaigns) | |
|
|
284
|
+
| | +---------------------+ +---------------------+ |
|
|
285
|
+
+------------------------------------------------------------------+
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
**Dimensions:** 1440x900 primary, responsive to 1024px
|
|
289
|
+
**Edge padding:** 24px
|
|
290
|
+
**Component gaps:** 16px
|
|
291
|
+
**Sidebar width:** 240px (collapsible to 64px on tablet)
|
|
292
|
+
|
|
293
|
+
**Components used:**
|
|
294
|
+
- Sidebar: NavSidebar, Logo, UserAvatar
|
|
295
|
+
- Header: PageHeader, DateRangePicker, ExportButton
|
|
296
|
+
- KPIs: MetricCard (x4)
|
|
297
|
+
- Charts: AreaChart, FunnelChart, BarChart
|
|
298
|
+
|
|
299
|
+
**Responsive behavior:**
|
|
300
|
+
- Desktop (1024px+): Full sidebar, 4 KPI cards in row, 2-column secondary charts
|
|
301
|
+
- Tablet (768-1024px): Collapsed sidebar (icons only), 2 KPI cards per row
|
|
302
|
+
- Mobile (<768px): Bottom nav replaces sidebar, stacked layout
|
|
303
|
+
|
|
304
|
+
---
|
|
305
|
+
|
|
306
|
+
## Component Specifications
|
|
307
|
+
|
|
308
|
+
### MetricCard
|
|
309
|
+
|
|
310
|
+
**Purpose:** Display single KPI with trend indicator
|
|
311
|
+
|
|
312
|
+
**Visual:**
|
|
313
|
+
- Background: `#1a1f2e` (dark navy)
|
|
314
|
+
- Border: 1px `#2a3142`, 8px radius
|
|
315
|
+
- Shadow: none (flat design)
|
|
316
|
+
- Size: min 180px width, 120px height
|
|
317
|
+
|
|
318
|
+
**States:**
|
|
319
|
+
| State | Visual Change | Trigger |
|
|
320
|
+
|-------|--------------|---------|
|
|
321
|
+
| Default | Base appearance | Initial |
|
|
322
|
+
| Hover | Border brightens to `#3a4152` | Mouse over |
|
|
323
|
+
| Loading | Content replaced with skeleton | Data fetching |
|
|
324
|
+
|
|
325
|
+
**Content:**
|
|
326
|
+
- Label: 12px, 500 weight, `#8b95a8`
|
|
327
|
+
- Value: 32px, 600 weight, `#ffffff`
|
|
328
|
+
- Trend: 14px, `#22c55e` (up) or `#ef4444` (down)
|
|
329
|
+
- Spacing: 16px padding all sides
|
|
330
|
+
|
|
331
|
+
---
|
|
332
|
+
|
|
333
|
+
## Design System Decisions
|
|
334
|
+
|
|
335
|
+
| Category | Decision | Values | Rationale |
|
|
336
|
+
|----------|----------|--------|-----------|
|
|
337
|
+
| **Colors** | Primary | `#0a0f1a` | Deep navy instead of pure black - warmer, more sophisticated |
|
|
338
|
+
| | Secondary | `#1a1f2e` | Card backgrounds - slight contrast from primary |
|
|
339
|
+
| | Text | `#ffffff` | Primary text |
|
|
340
|
+
| | Text Secondary | `#8b95a8` | Labels, captions |
|
|
341
|
+
| | Accent | `#F59E0B` | Amber - warm, energetic, stands out from cool tones |
|
|
342
|
+
| **Typography** | All | Inter | Clean, professional, excellent number rendering |
|
|
343
|
+
| | H1 | 32px/600 | Page titles |
|
|
344
|
+
| | H2 | 24px/600 | Section headers |
|
|
345
|
+
| | Body | 14px/400 | General content |
|
|
346
|
+
| | Caption | 12px/500 | Labels, metadata |
|
|
347
|
+
| **Spacing** | Base unit | 4px | 4/8/12/16/24/32/48 scale |
|
|
348
|
+
| | Edge padding | 24px | Breathing room at edges |
|
|
349
|
+
| | Component gap | 16px | Related items |
|
|
350
|
+
| | Section gap | 32px | Distinct sections |
|
|
351
|
+
|
|
352
|
+
---
|
|
353
|
+
|
|
354
|
+
## Verification Criteria
|
|
355
|
+
|
|
356
|
+
### Visual Verification
|
|
357
|
+
- [ ] Background is deep navy `#0a0f1a`, not generic black
|
|
358
|
+
- [ ] Accent color is amber `#F59E0B`, visible in buttons and highlights
|
|
359
|
+
- [ ] Cards have consistent 16px internal padding
|
|
360
|
+
- [ ] Typography uses Inter font family
|
|
361
|
+
|
|
362
|
+
### Functional Verification
|
|
363
|
+
- [ ] Dashboard: All 4 KPI cards display with correct values
|
|
364
|
+
- [ ] Dashboard: Main chart shows trend data with interactive tooltips
|
|
365
|
+
- [ ] Dashboard: Date picker filters all displayed data
|
|
366
|
+
|
|
367
|
+
### Platform Verification
|
|
368
|
+
- [ ] Responsive: Sidebar collapses to icons at 1024px
|
|
369
|
+
- [ ] Responsive: Layout stacks vertically below 768px
|
|
370
|
+
- [ ] Touch: All interactive elements meet 44px minimum
|
|
371
|
+
|
|
372
|
+
---
|
|
373
|
+
|
|
374
|
+
*Phase: 03-user-dashboard*
|
|
375
|
+
*Design created: 2026-01-19*
|
|
376
|
+
```
|
|
377
|
+
</good_examples>
|
|
378
|
+
|
|
379
|
+
<guidelines>
|
|
380
|
+
**This template captures DESIGN, not technical implementation.**
|
|
381
|
+
|
|
382
|
+
The design phase produces:
|
|
383
|
+
- How it should look (visual identity, layouts)
|
|
384
|
+
- How it should behave (states, transitions)
|
|
385
|
+
- How it should feel (UX flows, interactions)
|
|
386
|
+
- What proves it's correct (verification criteria)
|
|
387
|
+
|
|
388
|
+
The design phase does NOT produce:
|
|
389
|
+
- Library choices (that's research)
|
|
390
|
+
- Task breakdown (that's planning)
|
|
391
|
+
- Code architecture (that's execution)
|
|
392
|
+
|
|
393
|
+
**Content should read like:**
|
|
394
|
+
- A design specification a developer can implement
|
|
395
|
+
- "The card has 16px padding, 8px border radius, and a subtle shadow"
|
|
396
|
+
- "On hover, the border brightens from #2a3142 to #3a4152"
|
|
397
|
+
- ASCII wireframes showing exact layout structure
|
|
398
|
+
|
|
399
|
+
**Content should NOT read like:**
|
|
400
|
+
- A technical architecture document
|
|
401
|
+
- A list of npm packages to install
|
|
402
|
+
- Code snippets or implementation details
|
|
403
|
+
- Vague descriptions ("make it look nice")
|
|
404
|
+
|
|
405
|
+
**Quality markers:**
|
|
406
|
+
- Specific color values (hex codes), not "blue" or "primary"
|
|
407
|
+
- Exact spacing values (16px), not "some padding"
|
|
408
|
+
- All component states defined (default, hover, active, disabled)
|
|
409
|
+
- ASCII wireframes with labeled regions
|
|
410
|
+
- Verification criteria that are observable and testable
|
|
411
|
+
|
|
412
|
+
**After creation:**
|
|
413
|
+
- File lives in phase directory: `.planning/phases/XX-name/{phase}-DESIGN.md`
|
|
414
|
+
- Research phase adds technical details (which libraries enable this design)
|
|
415
|
+
- Planning phase creates tasks that reference design specs
|
|
416
|
+
- Execute phase implements to match design exactly
|
|
417
|
+
</guidelines>
|