bmad-method 6.7.1-next.0 → 6.7.1-next.2
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/.claude-plugin/marketplace.json +1 -1
- package/package.json +1 -1
- package/removals.txt +5 -0
- package/src/bmm-skills/1-analysis/bmad-product-brief/SKILL.md +1 -1
- package/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/customize.toml +1 -1
- package/src/bmm-skills/2-plan-workflows/bmad-prd/SKILL.md +5 -3
- package/src/bmm-skills/2-plan-workflows/bmad-prd/assets/prd-template.md +4 -7
- package/src/bmm-skills/2-plan-workflows/bmad-prd/assets/prd-validation-checklist.md +4 -4
- package/src/bmm-skills/2-plan-workflows/bmad-prd/references/headless.md +2 -2
- package/src/bmm-skills/2-plan-workflows/bmad-ux/SKILL.md +87 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/color-themes.md +9 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/design-directions.md +9 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/design-example-editorial.md +158 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/design-example-mobile.md +93 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/design-example-shadcn.md +109 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/excalidraw-wireframe.md +19 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/experience-example-mobile.md +112 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/experience-example-shadcn.md +133 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/headless-schemas.md +84 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/key-screens.md +29 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/validation-report-template.html +319 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/customize.toml +100 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/references/creative-tools.md +19 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/references/design-md-spec.md +50 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/references/headless.md +37 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/references/validate.md +115 -0
- package/src/bmm-skills/module-help.csv +1 -1
- package/src/core-skills/bmad-spec/SKILL.md +126 -0
- package/src/core-skills/bmad-spec/assets/headless-schemas.md +33 -0
- package/src/core-skills/bmad-spec/assets/spec-template.md +49 -0
- package/src/core-skills/bmad-spec/customize.toml +53 -0
- package/src/core-skills/module-help.csv +1 -1
- package/tools/skill-validator.md +1 -19
- package/tools/validate-skills.js +1 -40
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/SKILL.md +0 -75
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/customize.toml +0 -41
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-01-init.md +0 -135
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-01b-continue.md +0 -127
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-02-discovery.md +0 -190
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-03-core-experience.md +0 -217
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-04-emotional-response.md +0 -220
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-05-inspiration.md +0 -235
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-06-design-system.md +0 -253
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-07-defining-experience.md +0 -255
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-08-visual-foundation.md +0 -225
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-09-design-directions.md +0 -225
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-10-user-journeys.md +0 -242
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-11-component-strategy.md +0 -249
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-12-ux-patterns.md +0 -238
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-13-responsive-accessibility.md +0 -265
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-14-complete.md +0 -177
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/ux-design-template.md +0 -13
- package/src/core-skills/bmad-distillator/SKILL.md +0 -177
- package/src/core-skills/bmad-distillator/agents/distillate-compressor.md +0 -116
- package/src/core-skills/bmad-distillator/agents/round-trip-reconstructor.md +0 -68
- package/src/core-skills/bmad-distillator/resources/compression-rules.md +0 -51
- package/src/core-skills/bmad-distillator/resources/distillate-format-reference.md +0 -227
- package/src/core-skills/bmad-distillator/resources/splitting-strategy.md +0 -78
- package/src/core-skills/bmad-distillator/scripts/analyze_sources.py +0 -300
- package/src/core-skills/bmad-distillator/scripts/tests/test_analyze_sources.py +0 -204
|
@@ -1,265 +0,0 @@
|
|
|
1
|
-
# Step 13: Responsive Design & Accessibility
|
|
2
|
-
|
|
3
|
-
## MANDATORY EXECUTION RULES (READ FIRST):
|
|
4
|
-
|
|
5
|
-
- 🛑 NEVER generate content without user input
|
|
6
|
-
|
|
7
|
-
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
|
8
|
-
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
|
9
|
-
- ✅ ALWAYS treat this as collaborative discovery between UX facilitator and stakeholder
|
|
10
|
-
- 📋 YOU ARE A UX FACILITATOR, not a content generator
|
|
11
|
-
- 💬 FOCUS on responsive design strategy and accessibility compliance
|
|
12
|
-
- 🎯 COLLABORATIVE strategy definition, not assumption-based design
|
|
13
|
-
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
|
14
|
-
- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
|
|
15
|
-
|
|
16
|
-
## EXECUTION PROTOCOLS:
|
|
17
|
-
|
|
18
|
-
- 🎯 Show your analysis before taking any action
|
|
19
|
-
- ⚠️ Present A/P/C menu after generating responsive/accessibility content
|
|
20
|
-
- 💾 ONLY save when user chooses C (Continue)
|
|
21
|
-
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
|
22
|
-
- 🚫 FORBIDDEN to load next step until C is selected
|
|
23
|
-
|
|
24
|
-
## COLLABORATION MENUS (A/P/C):
|
|
25
|
-
|
|
26
|
-
This step will generate content and present choices:
|
|
27
|
-
|
|
28
|
-
- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper responsive/accessibility insights
|
|
29
|
-
- **P (Party Mode)**: Bring multiple perspectives to define responsive/accessibility strategy
|
|
30
|
-
- **C (Continue)**: Save the content to the document and proceed to final step
|
|
31
|
-
|
|
32
|
-
## PROTOCOL INTEGRATION:
|
|
33
|
-
|
|
34
|
-
- When 'A' selected: Invoke the `bmad-advanced-elicitation` skill
|
|
35
|
-
- When 'P' selected: Invoke the `bmad-party-mode` skill
|
|
36
|
-
- PROTOCOLS always return to this step's A/P/C menu
|
|
37
|
-
- User accepts/rejects protocol changes before proceeding
|
|
38
|
-
|
|
39
|
-
## CONTEXT BOUNDARIES:
|
|
40
|
-
|
|
41
|
-
- Current document and frontmatter from previous steps are available
|
|
42
|
-
- Platform requirements from step 3 inform responsive design
|
|
43
|
-
- Design direction from step 9 influences responsive layout choices
|
|
44
|
-
- Focus on cross-device adaptation and accessibility compliance
|
|
45
|
-
|
|
46
|
-
## YOUR TASK:
|
|
47
|
-
|
|
48
|
-
Define responsive design strategy and accessibility requirements for the product.
|
|
49
|
-
|
|
50
|
-
## RESPONSIVE & ACCESSIBILITY SEQUENCE:
|
|
51
|
-
|
|
52
|
-
### 1. Define Responsive Strategy
|
|
53
|
-
|
|
54
|
-
Establish how the design adapts across devices:
|
|
55
|
-
"Let's define how {{project_name}} adapts across different screen sizes and devices.
|
|
56
|
-
|
|
57
|
-
**Responsive Design Questions:**
|
|
58
|
-
|
|
59
|
-
**Desktop Strategy:**
|
|
60
|
-
|
|
61
|
-
- How should we use extra screen real estate?
|
|
62
|
-
- Multi-column layouts, side navigation, or content density?
|
|
63
|
-
- What desktop-specific features can we include?
|
|
64
|
-
|
|
65
|
-
**Tablet Strategy:**
|
|
66
|
-
|
|
67
|
-
- Should we use simplified layouts or touch-optimized interfaces?
|
|
68
|
-
- How do gestures and touch interactions work on tablets?
|
|
69
|
-
- What's the optimal information density for tablet screens?
|
|
70
|
-
|
|
71
|
-
**Mobile Strategy:**
|
|
72
|
-
|
|
73
|
-
- Bottom navigation or hamburger menu?
|
|
74
|
-
- How do layouts collapse on small screens?
|
|
75
|
-
- What's the most critical information to show mobile-first?"
|
|
76
|
-
|
|
77
|
-
### 2. Establish Breakpoint Strategy
|
|
78
|
-
|
|
79
|
-
Define when and how layouts change:
|
|
80
|
-
"**Breakpoint Strategy:**
|
|
81
|
-
We need to define screen size breakpoints where layouts adapt.
|
|
82
|
-
|
|
83
|
-
**Common Breakpoints:**
|
|
84
|
-
|
|
85
|
-
- Mobile: 320px - 767px
|
|
86
|
-
- Tablet: 768px - 1023px
|
|
87
|
-
- Desktop: 1024px+
|
|
88
|
-
|
|
89
|
-
**For {{project_name}}, should we:**
|
|
90
|
-
|
|
91
|
-
- Use standard breakpoints or custom ones?
|
|
92
|
-
- Focus on mobile-first or desktop-first design?
|
|
93
|
-
- Have specific breakpoints for your key use cases?"
|
|
94
|
-
|
|
95
|
-
### 3. Design Accessibility Strategy
|
|
96
|
-
|
|
97
|
-
Define accessibility requirements and compliance level:
|
|
98
|
-
"**Accessibility Strategy:**
|
|
99
|
-
What level of WCAG compliance does {{project_name}} need?
|
|
100
|
-
|
|
101
|
-
**WCAG Levels:**
|
|
102
|
-
|
|
103
|
-
- **Level A (Basic)** - Essential accessibility for legal compliance
|
|
104
|
-
- **Level AA (Recommended)** - Industry standard for good UX
|
|
105
|
-
- **Level AAA (Highest)** - Exceptional accessibility (rarely needed)
|
|
106
|
-
|
|
107
|
-
**Based on your product:**
|
|
108
|
-
|
|
109
|
-
- [Recommendation based on user base, legal requirements, etc.]
|
|
110
|
-
|
|
111
|
-
**Key Accessibility Considerations:**
|
|
112
|
-
|
|
113
|
-
- Color contrast ratios (4.5:1 for normal text)
|
|
114
|
-
- Keyboard navigation support
|
|
115
|
-
- Screen reader compatibility
|
|
116
|
-
- Touch target sizes (minimum 44x44px)
|
|
117
|
-
- Focus indicators and skip links"
|
|
118
|
-
|
|
119
|
-
### 4. Define Testing Strategy
|
|
120
|
-
|
|
121
|
-
Plan how to ensure responsive design and accessibility:
|
|
122
|
-
"**Testing Strategy:**
|
|
123
|
-
|
|
124
|
-
**Responsive Testing:**
|
|
125
|
-
|
|
126
|
-
- Device testing on actual phones/tablets
|
|
127
|
-
- Browser testing across Chrome, Firefox, Safari, Edge
|
|
128
|
-
- Real device network performance testing
|
|
129
|
-
|
|
130
|
-
**Accessibility Testing:**
|
|
131
|
-
|
|
132
|
-
- Automated accessibility testing tools
|
|
133
|
-
- Screen reader testing (VoiceOver, NVDA, JAWS)
|
|
134
|
-
- Keyboard-only navigation testing
|
|
135
|
-
- Color blindness simulation testing
|
|
136
|
-
|
|
137
|
-
**User Testing:**
|
|
138
|
-
|
|
139
|
-
- Include users with disabilities in testing
|
|
140
|
-
- Test with diverse assistive technologies
|
|
141
|
-
- Validate with actual target devices"
|
|
142
|
-
|
|
143
|
-
### 5. Document Implementation Guidelines
|
|
144
|
-
|
|
145
|
-
Create specific guidelines for developers:
|
|
146
|
-
"**Implementation Guidelines:**
|
|
147
|
-
|
|
148
|
-
**Responsive Development:**
|
|
149
|
-
|
|
150
|
-
- Use relative units (rem, %, vw, vh) over fixed pixels
|
|
151
|
-
- Implement mobile-first media queries
|
|
152
|
-
- Test touch targets and gesture areas
|
|
153
|
-
- Optimize images and assets for different devices
|
|
154
|
-
|
|
155
|
-
**Accessibility Development:**
|
|
156
|
-
|
|
157
|
-
- Semantic HTML structure
|
|
158
|
-
- ARIA labels and roles
|
|
159
|
-
- Keyboard navigation implementation
|
|
160
|
-
- Focus management and skip links
|
|
161
|
-
- High contrast mode support"
|
|
162
|
-
|
|
163
|
-
### 6. Generate Responsive & Accessibility Content
|
|
164
|
-
|
|
165
|
-
Prepare the content to append to the document:
|
|
166
|
-
|
|
167
|
-
#### Content Structure:
|
|
168
|
-
|
|
169
|
-
When saving to document, append these Level 2 and Level 3 sections:
|
|
170
|
-
|
|
171
|
-
```markdown
|
|
172
|
-
## Responsive Design & Accessibility
|
|
173
|
-
|
|
174
|
-
### Responsive Strategy
|
|
175
|
-
|
|
176
|
-
[Responsive strategy based on conversation]
|
|
177
|
-
|
|
178
|
-
### Breakpoint Strategy
|
|
179
|
-
|
|
180
|
-
[Breakpoint strategy based on conversation]
|
|
181
|
-
|
|
182
|
-
### Accessibility Strategy
|
|
183
|
-
|
|
184
|
-
[Accessibility strategy based on conversation]
|
|
185
|
-
|
|
186
|
-
### Testing Strategy
|
|
187
|
-
|
|
188
|
-
[Testing strategy based on conversation]
|
|
189
|
-
|
|
190
|
-
### Implementation Guidelines
|
|
191
|
-
|
|
192
|
-
[Implementation guidelines based on conversation]
|
|
193
|
-
```
|
|
194
|
-
|
|
195
|
-
### 7. Present Content and Menu
|
|
196
|
-
|
|
197
|
-
Show the generated responsive and accessibility content and present choices:
|
|
198
|
-
"I've defined the responsive design and accessibility strategy for {{project_name}}. This ensures your product works beautifully across all devices and is accessible to all users.
|
|
199
|
-
|
|
200
|
-
**Here's what I'll add to the document:**
|
|
201
|
-
|
|
202
|
-
[Show the complete markdown content from step 6]
|
|
203
|
-
|
|
204
|
-
**What would you like to do?**
|
|
205
|
-
[A] Advanced Elicitation - Let's refine our responsive/accessibility strategy
|
|
206
|
-
[P] Party Mode - Bring different perspectives on inclusive design
|
|
207
|
-
[C] Continue - Save this to the document and complete the workflow
|
|
208
|
-
|
|
209
|
-
### 8. Handle Menu Selection
|
|
210
|
-
|
|
211
|
-
#### If 'A' (Advanced Elicitation):
|
|
212
|
-
|
|
213
|
-
- Invoke the `bmad-advanced-elicitation` skill with the current responsive/accessibility content
|
|
214
|
-
- Process the enhanced insights that come back
|
|
215
|
-
- Ask user: "Accept these improvements to the responsive/accessibility strategy? (y/n)"
|
|
216
|
-
- If yes: Update content with improvements, then return to A/P/C menu
|
|
217
|
-
- If no: Keep original content, then return to A/P/C menu
|
|
218
|
-
|
|
219
|
-
#### If 'P' (Party Mode):
|
|
220
|
-
|
|
221
|
-
- Invoke the `bmad-party-mode` skill with the current responsive/accessibility strategy
|
|
222
|
-
- Process the collaborative insights that come back
|
|
223
|
-
- Ask user: "Accept these changes to the responsive/accessibility strategy? (y/n)"
|
|
224
|
-
- If yes: Update content with improvements, then return to A/P/C menu
|
|
225
|
-
- If no: Keep original content, then return to A/P/C menu
|
|
226
|
-
|
|
227
|
-
#### If 'C' (Continue):
|
|
228
|
-
|
|
229
|
-
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
|
230
|
-
- Update frontmatter: append step to end of stepsCompleted array
|
|
231
|
-
- Load `./step-14-complete.md`
|
|
232
|
-
|
|
233
|
-
## APPEND TO DOCUMENT:
|
|
234
|
-
|
|
235
|
-
When user selects 'C', append the content directly to the document using the structure from step 6.
|
|
236
|
-
|
|
237
|
-
## SUCCESS METRICS:
|
|
238
|
-
|
|
239
|
-
✅ Responsive strategy clearly defined for all device types
|
|
240
|
-
✅ Appropriate breakpoint strategy established
|
|
241
|
-
✅ Accessibility requirements determined and documented
|
|
242
|
-
✅ Comprehensive testing strategy planned
|
|
243
|
-
✅ Implementation guidelines provided for Developer agent
|
|
244
|
-
✅ A/P/C menu presented and handled correctly
|
|
245
|
-
✅ Content properly appended to document when C selected
|
|
246
|
-
|
|
247
|
-
## FAILURE MODES:
|
|
248
|
-
|
|
249
|
-
❌ Not considering all device types and screen sizes
|
|
250
|
-
❌ Accessibility requirements not properly researched
|
|
251
|
-
❌ Testing strategy not comprehensive enough
|
|
252
|
-
❌ Implementation guidelines too generic or unclear
|
|
253
|
-
❌ Not addressing specific accessibility challenges for your product
|
|
254
|
-
❌ Not presenting A/P/C menu after content generation
|
|
255
|
-
❌ Appending content without user selecting 'C'
|
|
256
|
-
|
|
257
|
-
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
|
258
|
-
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
|
259
|
-
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
|
260
|
-
|
|
261
|
-
## NEXT STEP:
|
|
262
|
-
|
|
263
|
-
After user selects 'C' and content is saved to document, load `./step-14-complete.md` to finalize the UX design workflow.
|
|
264
|
-
|
|
265
|
-
Remember: Do NOT proceed to step-14 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
|
@@ -1,177 +0,0 @@
|
|
|
1
|
-
# Step 14: Workflow Completion
|
|
2
|
-
|
|
3
|
-
## MANDATORY EXECUTION RULES (READ FIRST):
|
|
4
|
-
|
|
5
|
-
- ✅ THIS IS A FINAL STEP - Workflow completion required
|
|
6
|
-
|
|
7
|
-
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
|
8
|
-
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
|
9
|
-
- 🛑 NO content generation - this is a wrap-up step
|
|
10
|
-
- 📋 FINALIZE document and update workflow status
|
|
11
|
-
- 💬 FOCUS on completion, validation, and next steps
|
|
12
|
-
- 🎯 UPDATE workflow status files with completion information
|
|
13
|
-
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
|
14
|
-
|
|
15
|
-
## EXECUTION PROTOCOLS:
|
|
16
|
-
|
|
17
|
-
- 🎯 Show your analysis before taking any action
|
|
18
|
-
- 💾 Update the main workflow status file with completion information
|
|
19
|
-
- 📖 Suggest potential next workflow steps for the user
|
|
20
|
-
- 🚫 DO NOT load additional steps after this one
|
|
21
|
-
|
|
22
|
-
## TERMINATION STEP PROTOCOLS:
|
|
23
|
-
|
|
24
|
-
- This is a FINAL step - workflow completion required
|
|
25
|
-
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted to indicate all is finished..
|
|
26
|
-
- Output completion summary and next step guidance
|
|
27
|
-
- Update the main workflow status file with finalized document
|
|
28
|
-
- Suggest potential next workflow steps for the user
|
|
29
|
-
- Mark workflow as complete in status tracking
|
|
30
|
-
|
|
31
|
-
## CONTEXT BOUNDARIES:
|
|
32
|
-
|
|
33
|
-
- Complete UX design specification is available from all previous steps
|
|
34
|
-
- Workflow frontmatter shows all completed steps
|
|
35
|
-
- All collaborative content has been generated and saved
|
|
36
|
-
- Focus on completion, validation, and next steps
|
|
37
|
-
|
|
38
|
-
## YOUR TASK:
|
|
39
|
-
|
|
40
|
-
Complete the UX design workflow, update status files, and suggest next steps for the project.
|
|
41
|
-
|
|
42
|
-
## WORKFLOW COMPLETION SEQUENCE:
|
|
43
|
-
|
|
44
|
-
### 1. Announce Workflow Completion
|
|
45
|
-
|
|
46
|
-
Inform user that the UX design is complete:
|
|
47
|
-
"🎉 **UX Design Complete, {{user_name}}!**
|
|
48
|
-
|
|
49
|
-
I've successfully collaborated with you to create a comprehensive UX design specification for {{project_name}}.
|
|
50
|
-
|
|
51
|
-
**What we've accomplished:**
|
|
52
|
-
|
|
53
|
-
- ✅ Project understanding and user insights
|
|
54
|
-
- ✅ Core experience and emotional response definition
|
|
55
|
-
- ✅ UX pattern analysis and inspiration
|
|
56
|
-
- ✅ Design system choice and implementation strategy
|
|
57
|
-
- ✅ Core interaction definition and experience mechanics
|
|
58
|
-
- ✅ Visual design foundation (colors, typography, spacing)
|
|
59
|
-
- ✅ Design direction mockups and visual explorations
|
|
60
|
-
- ✅ User journey flows and interaction design
|
|
61
|
-
- ✅ Component strategy and custom component specifications
|
|
62
|
-
- ✅ UX consistency patterns for common interactions
|
|
63
|
-
- ✅ Responsive design and accessibility strategy
|
|
64
|
-
|
|
65
|
-
**The complete UX design specification is now available at:** `{planning_artifacts}/ux-design-specification.md`
|
|
66
|
-
|
|
67
|
-
**Supporting Visual Assets:**
|
|
68
|
-
|
|
69
|
-
- Color themes visualizer: `{planning_artifacts}/ux-color-themes.html`
|
|
70
|
-
- Design directions mockups: `{planning_artifacts}/ux-design-directions.html`
|
|
71
|
-
|
|
72
|
-
This specification is now ready to guide visual design, implementation, and development."
|
|
73
|
-
|
|
74
|
-
### 2. Workflow Status Update
|
|
75
|
-
|
|
76
|
-
Update the main workflow status file:
|
|
77
|
-
|
|
78
|
-
- Load the project's workflow status file (if one exists)
|
|
79
|
-
- Update workflow_status["create-ux-design"] = `{planning_artifacts}/ux-design-specification.md`
|
|
80
|
-
- Save file, preserving all comments and structure
|
|
81
|
-
- Mark current timestamp as completion time
|
|
82
|
-
|
|
83
|
-
### 3. Suggest Next Steps
|
|
84
|
-
|
|
85
|
-
UX Design complete. Invoke the `bmad-help` skill.
|
|
86
|
-
|
|
87
|
-
### 5. Final Completion Confirmation
|
|
88
|
-
|
|
89
|
-
Congratulate the user on the completion you both completed together of the UX.
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
## SUCCESS METRICS:
|
|
94
|
-
|
|
95
|
-
✅ UX design specification contains all required sections
|
|
96
|
-
✅ All collaborative content properly saved to document
|
|
97
|
-
✅ Workflow status file updated with completion information
|
|
98
|
-
✅ Clear next step guidance provided to user
|
|
99
|
-
✅ Document quality validation completed
|
|
100
|
-
✅ User acknowledges completion and understands next options
|
|
101
|
-
|
|
102
|
-
## FAILURE MODES:
|
|
103
|
-
|
|
104
|
-
❌ Not updating workflow status file with completion information
|
|
105
|
-
❌ Missing clear next step guidance for user
|
|
106
|
-
❌ Not confirming document completeness with user
|
|
107
|
-
❌ Workflow not properly marked as complete in status tracking
|
|
108
|
-
❌ User unclear about what happens next
|
|
109
|
-
|
|
110
|
-
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
|
111
|
-
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
|
112
|
-
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
|
113
|
-
|
|
114
|
-
## WORKFLOW COMPLETION CHECKLIST:
|
|
115
|
-
|
|
116
|
-
### Design Specification Complete:
|
|
117
|
-
|
|
118
|
-
- [ ] Executive summary and project understanding
|
|
119
|
-
- [ ] Core experience and emotional response definition
|
|
120
|
-
- [ ] UX pattern analysis and inspiration
|
|
121
|
-
- [ ] Design system choice and strategy
|
|
122
|
-
- [ ] Core interaction mechanics definition
|
|
123
|
-
- [ ] Visual design foundation (colors, typography, spacing)
|
|
124
|
-
- [ ] Design direction decisions and mockups
|
|
125
|
-
- [ ] User journey flows and interaction design
|
|
126
|
-
- [ ] Component strategy and specifications
|
|
127
|
-
- [ ] UX consistency patterns documentation
|
|
128
|
-
- [ ] Responsive design and accessibility strategy
|
|
129
|
-
|
|
130
|
-
### Process Complete:
|
|
131
|
-
|
|
132
|
-
- [ ] All steps completed with user confirmation
|
|
133
|
-
- [ ] All content saved to specification document
|
|
134
|
-
- [ ] Frontmatter properly updated with all steps
|
|
135
|
-
- [ ] Workflow status file updated with completion
|
|
136
|
-
- [ ] Next steps clearly communicated
|
|
137
|
-
|
|
138
|
-
## NEXT STEPS GUIDANCE:
|
|
139
|
-
|
|
140
|
-
**Immediate Options:**
|
|
141
|
-
|
|
142
|
-
1. **Wireframe Generation** - Create low-fidelity layouts based on UX spec
|
|
143
|
-
2. **Interactive Prototype** - Build clickable prototypes for testing
|
|
144
|
-
3. **Solution Architecture** - Technical design with UX context
|
|
145
|
-
4. **Figma Visual Design** - High-fidelity UI implementation
|
|
146
|
-
5. **Epic Creation** - Break down UX requirements for development
|
|
147
|
-
|
|
148
|
-
**Recommended Sequence:**
|
|
149
|
-
For design-focused teams: Wireframes → Prototypes → Figma Design → Development
|
|
150
|
-
For technical teams: Architecture → Epic Creation → Development
|
|
151
|
-
|
|
152
|
-
Consider team capacity, timeline, and whether user validation is needed before implementation.
|
|
153
|
-
|
|
154
|
-
## WORKFLOW FINALIZATION:
|
|
155
|
-
|
|
156
|
-
- Set `lastStep = 14` in document frontmatter
|
|
157
|
-
- Update workflow status file with completion timestamp
|
|
158
|
-
- Provide completion summary to user
|
|
159
|
-
- Do NOT load any additional steps
|
|
160
|
-
|
|
161
|
-
## FINAL REMINDER:
|
|
162
|
-
|
|
163
|
-
This UX design workflow is now complete. The specification serves as the foundation for all visual and development work. All design decisions, patterns, and requirements are documented to ensure consistent, accessible, and user-centered implementation.
|
|
164
|
-
|
|
165
|
-
**Congratulations on completing the UX Design Specification for {{project_name}}!** 🎉
|
|
166
|
-
|
|
167
|
-
**Core Deliverables:**
|
|
168
|
-
|
|
169
|
-
- ✅ UX Design Specification: `{planning_artifacts}/ux-design-specification.md`
|
|
170
|
-
- ✅ Color Themes Visualizer: `{planning_artifacts}/ux-color-themes.html`
|
|
171
|
-
- ✅ Design Directions: `{planning_artifacts}/ux-design-directions.html`
|
|
172
|
-
|
|
173
|
-
## On Complete
|
|
174
|
-
|
|
175
|
-
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
|
176
|
-
|
|
177
|
-
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
stepsCompleted: []
|
|
3
|
-
inputDocuments: []
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# UX Design Specification {{project_name}}
|
|
7
|
-
|
|
8
|
-
**Author:** {{user_name}}
|
|
9
|
-
**Date:** {{date}}
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
<!-- UX design content will be appended sequentially through collaborative workflow steps -->
|
|
@@ -1,177 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: bmad-distillator
|
|
3
|
-
description: Lossless LLM-optimized compression of source documents. Use when the user requests to 'distill documents' or 'create a distillate'.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Distillator: A Document Distillation Engine
|
|
7
|
-
|
|
8
|
-
## Overview
|
|
9
|
-
|
|
10
|
-
This skill produces hyper-compressed, token-efficient documents (distillates) from any set of source documents. A distillate preserves every fact, decision, constraint, and relationship from the sources while stripping all overhead that humans need and LLMs don't. Act as an information extraction and compression specialist. The output is a single dense document (or semantically-split set) that a downstream LLM workflow can consume as sole context input without information loss.
|
|
11
|
-
|
|
12
|
-
This is a compression task, not a summarization task. Summaries are lossy. Distillates are lossless compression optimized for LLM consumption.
|
|
13
|
-
|
|
14
|
-
## On Activation
|
|
15
|
-
|
|
16
|
-
1. **Validate inputs.** The caller must provide:
|
|
17
|
-
- **source_documents** (required) — One or more file paths, folder paths, or glob patterns to distill
|
|
18
|
-
- **downstream_consumer** (optional) — What workflow/agent consumes this distillate (e.g., "PRD creation", "architecture design"). When provided, use it to judge signal vs noise. When omitted, preserve everything.
|
|
19
|
-
- **token_budget** (optional) — Approximate target size. When provided and the distillate would exceed it, trigger semantic splitting.
|
|
20
|
-
- **output_path** (optional) — Where to save. When omitted, save adjacent to the primary source document with `-distillate.md` suffix.
|
|
21
|
-
- **--validate** (flag) — Run round-trip reconstruction test after producing the distillate.
|
|
22
|
-
|
|
23
|
-
2. **Route** — proceed to Stage 1.
|
|
24
|
-
|
|
25
|
-
## Stages
|
|
26
|
-
|
|
27
|
-
| # | Stage | Purpose |
|
|
28
|
-
|---|-------|---------|
|
|
29
|
-
| 1 | Analyze | Run analysis script, determine routing and splitting |
|
|
30
|
-
| 2 | Compress | Spawn compressor agent(s) to produce the distillate |
|
|
31
|
-
| 3 | Verify & Output | Completeness check, format check, save output |
|
|
32
|
-
| 4 | Round-Trip Validate | (--validate only) Reconstruct and diff against originals |
|
|
33
|
-
|
|
34
|
-
### Stage 1: Analyze
|
|
35
|
-
|
|
36
|
-
Run `scripts/analyze_sources.py --help` then run it with the source paths. Use its routing recommendation and grouping output to drive Stage 2. Do NOT read the source documents yourself.
|
|
37
|
-
|
|
38
|
-
### Stage 2: Compress
|
|
39
|
-
|
|
40
|
-
**Single mode** (routing = `"single"`, ≤3 files, ≤15K estimated tokens):
|
|
41
|
-
|
|
42
|
-
Spawn one subagent using `agents/distillate-compressor.md` with all source file paths.
|
|
43
|
-
|
|
44
|
-
**Fan-out mode** (routing = `"fan-out"`):
|
|
45
|
-
|
|
46
|
-
1. Spawn one compressor subagent per group from the analysis output. Each compressor receives only its group's file paths and produces an intermediate distillate.
|
|
47
|
-
|
|
48
|
-
2. After all compressors return, spawn one final **merge compressor** subagent using `agents/distillate-compressor.md`. Pass it the intermediate distillate contents as its input (not the original files). Its job is cross-group deduplication, thematic regrouping, and final compression.
|
|
49
|
-
|
|
50
|
-
3. Clean up intermediate distillate content (it exists only in memory, not saved to disk).
|
|
51
|
-
|
|
52
|
-
**Graceful degradation:** If subagent spawning is unavailable, read the source documents and perform the compression work directly using the same instructions from `agents/distillate-compressor.md`. For fan-out, process groups sequentially then merge.
|
|
53
|
-
|
|
54
|
-
The compressor returns a structured JSON result containing the distillate content, source headings, named entities, and token estimate.
|
|
55
|
-
|
|
56
|
-
### Stage 3: Verify & Output
|
|
57
|
-
|
|
58
|
-
After the compressor (or merge compressor) returns:
|
|
59
|
-
|
|
60
|
-
1. **Completeness check.** Using the headings and named entities list returned by the compressor, verify each appears in the distillate content. If gaps are found, send them back to the compressor for a targeted fix pass — not a full recompression. Limit to 2 fix passes maximum.
|
|
61
|
-
|
|
62
|
-
2. **Format check.** Verify the output follows distillate format rules:
|
|
63
|
-
- No prose paragraphs (only bullets)
|
|
64
|
-
- No decorative formatting
|
|
65
|
-
- No repeated information
|
|
66
|
-
- Each bullet is self-contained
|
|
67
|
-
- Themes are clearly delineated with `##` headings
|
|
68
|
-
|
|
69
|
-
3. **Determine output format.** Using the split prediction from Stage 1 and actual distillate size:
|
|
70
|
-
|
|
71
|
-
**Single distillate** (≤~5,000 tokens or token_budget not exceeded):
|
|
72
|
-
|
|
73
|
-
Save as a single file with frontmatter:
|
|
74
|
-
|
|
75
|
-
```yaml
|
|
76
|
-
---
|
|
77
|
-
type: bmad-distillate
|
|
78
|
-
sources:
|
|
79
|
-
- "{relative path to source file 1}"
|
|
80
|
-
- "{relative path to source file 2}"
|
|
81
|
-
downstream_consumer: "{consumer or 'general'}"
|
|
82
|
-
created: "{date}"
|
|
83
|
-
token_estimate: {approximate token count}
|
|
84
|
-
parts: 1
|
|
85
|
-
---
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
**Split distillate** (>~5,000 tokens, or token_budget requires it):
|
|
89
|
-
|
|
90
|
-
Create a folder `{base-name}-distillate/` containing:
|
|
91
|
-
|
|
92
|
-
```
|
|
93
|
-
{base-name}-distillate/
|
|
94
|
-
├── _index.md # Orientation, cross-cutting items, section manifest
|
|
95
|
-
├── 01-{topic-slug}.md # Self-contained section
|
|
96
|
-
├── 02-{topic-slug}.md
|
|
97
|
-
└── 03-{topic-slug}.md
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
The `_index.md` contains:
|
|
101
|
-
- Frontmatter with sources (relative paths from the distillate folder to the originals)
|
|
102
|
-
- 3-5 bullet orientation (what was distilled, from what)
|
|
103
|
-
- Section manifest: each section's filename + 1-line description
|
|
104
|
-
- Cross-cutting items that span multiple sections
|
|
105
|
-
|
|
106
|
-
Each section file is self-contained — loadable independently. Include a 1-line context header: "This section covers [topic]. Part N of M."
|
|
107
|
-
|
|
108
|
-
Source paths in frontmatter must be relative to the distillate's location.
|
|
109
|
-
|
|
110
|
-
4. **Measure distillate.** Run `scripts/analyze_sources.py` on the final distillate file(s) to get accurate token counts for the output. Use the `total_estimated_tokens` from this analysis as `distillate_total_tokens`.
|
|
111
|
-
|
|
112
|
-
5. **Report results.** Always return structured JSON output:
|
|
113
|
-
|
|
114
|
-
```json
|
|
115
|
-
{
|
|
116
|
-
"status": "complete",
|
|
117
|
-
"distillate": "{path or folder path}",
|
|
118
|
-
"section_distillates": ["{path1}", "{path2}"] or null,
|
|
119
|
-
"source_total_tokens": N,
|
|
120
|
-
"distillate_total_tokens": N,
|
|
121
|
-
"compression_ratio": "X:1",
|
|
122
|
-
"source_documents": ["{path1}", "{path2}"],
|
|
123
|
-
"completeness_check": "pass" or "pass_with_additions"
|
|
124
|
-
}
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
Where `source_total_tokens` is from the Stage 1 analysis and `distillate_total_tokens` is from step 4. The `compression_ratio` is `source_total_tokens / distillate_total_tokens` formatted as "X:1" (e.g., "3.2:1").
|
|
128
|
-
|
|
129
|
-
6. If `--validate` flag was set, proceed to Stage 4. Otherwise, done.
|
|
130
|
-
|
|
131
|
-
### Stage 4: Round-Trip Validation (--validate only)
|
|
132
|
-
|
|
133
|
-
This stage proves the distillate is lossless by reconstructing source documents from the distillate alone. Use for critical documents where information loss is unacceptable, or as a quality gate for high-stakes downstream workflows. Not for routine use — it adds significant token cost.
|
|
134
|
-
|
|
135
|
-
1. **Spawn the reconstructor agent** using `agents/round-trip-reconstructor.md`. Pass it ONLY the distillate file path (or `_index.md` path for split distillates) — it must NOT have access to the original source documents.
|
|
136
|
-
|
|
137
|
-
For split distillates, spawn one reconstructor per section in parallel. Each receives its section file plus the `_index.md` for cross-cutting context.
|
|
138
|
-
|
|
139
|
-
**Graceful degradation:** If subagent spawning is unavailable, this stage cannot be performed by the main agent (it has already seen the originals). Report that round-trip validation requires subagent support and skip.
|
|
140
|
-
|
|
141
|
-
2. **Receive reconstructions.** The reconstructor returns reconstruction file paths saved adjacent to the distillate.
|
|
142
|
-
|
|
143
|
-
3. **Perform semantic diff.** Read both the original source documents and the reconstructions. For each section of the original, assess:
|
|
144
|
-
- Is the core information present in the reconstruction?
|
|
145
|
-
- Are specific details preserved (numbers, names, decisions)?
|
|
146
|
-
- Are relationships and rationale intact?
|
|
147
|
-
- Did the reconstruction add anything not in the original? (indicates hallucination filling gaps)
|
|
148
|
-
|
|
149
|
-
4. **Produce validation report** saved adjacent to the distillate as `-validation-report.md`:
|
|
150
|
-
|
|
151
|
-
```markdown
|
|
152
|
-
---
|
|
153
|
-
type: distillate-validation
|
|
154
|
-
distillate: "{distillate path}"
|
|
155
|
-
sources: ["{source paths}"]
|
|
156
|
-
created: "{date}"
|
|
157
|
-
---
|
|
158
|
-
|
|
159
|
-
## Validation Summary
|
|
160
|
-
- Status: PASS | PASS_WITH_WARNINGS | FAIL
|
|
161
|
-
- Information preserved: {percentage estimate}
|
|
162
|
-
- Gaps found: {count}
|
|
163
|
-
- Hallucinations detected: {count}
|
|
164
|
-
|
|
165
|
-
## Gaps (information in originals but missing from reconstruction)
|
|
166
|
-
- {gap description} — Source: {which original}, Section: {where}
|
|
167
|
-
|
|
168
|
-
## Hallucinations (information in reconstruction not traceable to originals)
|
|
169
|
-
- {hallucination description} — appears to fill gap in: {section}
|
|
170
|
-
|
|
171
|
-
## Possible Gap Markers (flagged by reconstructor)
|
|
172
|
-
- {marker description}
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
5. **If gaps are found**, offer to run a targeted fix pass on the distillate — adding the missing information without full recompression. Limit to 2 fix passes maximum.
|
|
176
|
-
|
|
177
|
-
6. **Clean up** — delete the temporary reconstruction files after the report is generated.
|