siesa-agents 2.1.1 → 2.1.3-dev.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.
Files changed (147) hide show
  1. package/README.md +83 -83
  2. package/bin/install.js +400 -399
  3. package/bin/prepare-publish.js +26 -26
  4. package/bin/restore-folders.js +26 -26
  5. package/bmad-core/agent-teams/team-all.yaml +15 -15
  6. package/bmad-core/agent-teams/team-fullstack.yaml +19 -19
  7. package/bmad-core/agent-teams/team-ide-minimal.yaml +11 -11
  8. package/bmad-core/agent-teams/team-no-ui.yaml +14 -14
  9. package/bmad-core/agents/analyst.md +84 -84
  10. package/bmad-core/agents/architect.md +94 -94
  11. package/bmad-core/agents/backend-agent.md +189 -189
  12. package/bmad-core/agents/bmad-master.md +110 -110
  13. package/bmad-core/agents/bmad-orchestrator.md +147 -147
  14. package/bmad-core/agents/dev.md +81 -81
  15. package/bmad-core/agents/frontend-agent.md +168 -168
  16. package/bmad-core/agents/pm.md +84 -84
  17. package/bmad-core/agents/po.md +79 -79
  18. package/bmad-core/agents/qa.md +91 -91
  19. package/bmad-core/agents/sm.md +65 -65
  20. package/bmad-core/agents/ux-expert.md +69 -69
  21. package/bmad-core/checklists/architect-checklist.md +440 -440
  22. package/bmad-core/checklists/backend-checklist.md +142 -142
  23. package/bmad-core/checklists/change-checklist.md +184 -184
  24. package/bmad-core/checklists/frontend-checklist.md +105 -105
  25. package/bmad-core/checklists/pm-checklist.md +372 -372
  26. package/bmad-core/checklists/po-master-checklist.md +434 -434
  27. package/bmad-core/checklists/story-dod-checklist.md +96 -96
  28. package/bmad-core/checklists/story-draft-checklist.md +155 -155
  29. package/bmad-core/core-config.yaml +22 -22
  30. package/bmad-core/data/backend-standards.md +439 -439
  31. package/bmad-core/data/bmad-kb.md +809 -809
  32. package/bmad-core/data/brainstorming-techniques.md +38 -38
  33. package/bmad-core/data/elicitation-methods.md +156 -156
  34. package/bmad-core/data/frontend-standards.md +323 -323
  35. package/bmad-core/data/technical-preferences.md +5 -5
  36. package/bmad-core/data/test-levels-framework.md +148 -148
  37. package/bmad-core/data/test-priorities-matrix.md +174 -174
  38. package/bmad-core/enhanced-ide-development-workflow.md +248 -248
  39. package/bmad-core/install-manifest.yaml +230 -230
  40. package/bmad-core/tasks/advanced-elicitation.md +119 -119
  41. package/bmad-core/tasks/apply-qa-fixes.md +150 -150
  42. package/bmad-core/tasks/brownfield-create-epic.md +162 -162
  43. package/bmad-core/tasks/brownfield-create-story.md +149 -149
  44. package/bmad-core/tasks/correct-course.md +72 -72
  45. package/bmad-core/tasks/create-brownfield-story.md +314 -314
  46. package/bmad-core/tasks/create-component.md +102 -102
  47. package/bmad-core/tasks/create-deep-research-prompt.md +280 -280
  48. package/bmad-core/tasks/create-doc.md +103 -103
  49. package/bmad-core/tasks/create-entity.md +132 -132
  50. package/bmad-core/tasks/create-feature.md +90 -90
  51. package/bmad-core/tasks/create-next-story.md +114 -114
  52. package/bmad-core/tasks/create-service.md +117 -117
  53. package/bmad-core/tasks/create-use-case.md +140 -140
  54. package/bmad-core/tasks/document-project.md +345 -345
  55. package/bmad-core/tasks/execute-checklist.md +88 -88
  56. package/bmad-core/tasks/facilitate-brainstorming-session.md +138 -138
  57. package/bmad-core/tasks/generate-ai-frontend-prompt.md +53 -53
  58. package/bmad-core/tasks/index-docs.md +175 -175
  59. package/bmad-core/tasks/kb-mode-interaction.md +77 -77
  60. package/bmad-core/tasks/nfr-assess.md +345 -345
  61. package/bmad-core/tasks/qa-gate.md +163 -163
  62. package/bmad-core/tasks/review-story.md +316 -316
  63. package/bmad-core/tasks/risk-profile.md +355 -355
  64. package/bmad-core/tasks/scaffold-backend.md +110 -110
  65. package/bmad-core/tasks/scaffold-frontend.md +78 -78
  66. package/bmad-core/tasks/shard-doc.md +187 -187
  67. package/bmad-core/tasks/test-design.md +176 -176
  68. package/bmad-core/tasks/trace-requirements.md +266 -266
  69. package/bmad-core/tasks/validate-next-story.md +136 -136
  70. package/bmad-core/templates/architecture-tmpl.yaml +662 -662
  71. package/bmad-core/templates/brainstorming-output-tmpl.yaml +156 -156
  72. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +477 -477
  73. package/bmad-core/templates/brownfield-prd-tmpl.yaml +281 -281
  74. package/bmad-core/templates/competitor-analysis-tmpl.yaml +307 -307
  75. package/bmad-core/templates/front-end-architecture-tmpl.yaml +258 -258
  76. package/bmad-core/templates/front-end-spec-tmpl.yaml +350 -350
  77. package/bmad-core/templates/fullstack-architecture-tmpl.yaml +824 -824
  78. package/bmad-core/templates/market-research-tmpl.yaml +253 -253
  79. package/bmad-core/templates/prd-tmpl.yaml +203 -203
  80. package/bmad-core/templates/project-brief-tmpl.yaml +222 -222
  81. package/bmad-core/templates/qa-gate-tmpl.yaml +103 -103
  82. package/bmad-core/templates/story-tmpl.yaml +138 -138
  83. package/bmad-core/user-guide.md +530 -530
  84. package/bmad-core/utils/bmad-doc-template.md +327 -327
  85. package/bmad-core/utils/workflow-management.md +71 -71
  86. package/bmad-core/workflows/brownfield-fullstack.yaml +298 -298
  87. package/bmad-core/workflows/brownfield-service.yaml +188 -188
  88. package/bmad-core/workflows/brownfield-ui.yaml +198 -198
  89. package/bmad-core/workflows/greenfield-fullstack.yaml +241 -241
  90. package/bmad-core/workflows/greenfield-service.yaml +207 -207
  91. package/bmad-core/workflows/greenfield-ui.yaml +236 -236
  92. package/bmad-core/working-in-the-brownfield.md +606 -606
  93. package/claude/commands/BMad/agents/analyst.md +88 -0
  94. package/claude/commands/BMad/agents/architect.md +89 -0
  95. package/claude/commands/BMad/agents/backend.md +188 -0
  96. package/claude/commands/BMad/agents/bmad-master.md +114 -0
  97. package/claude/commands/BMad/agents/bmad-orchestrator.md +151 -0
  98. package/claude/commands/BMad/agents/dev.md +85 -0
  99. package/claude/commands/BMad/agents/frontend.md +151 -0
  100. package/claude/commands/BMad/agents/pm.md +88 -0
  101. package/claude/commands/BMad/agents/po.md +83 -0
  102. package/claude/commands/BMad/agents/qa.md +95 -0
  103. package/claude/commands/BMad/agents/sm.md +69 -0
  104. package/claude/commands/BMad/agents/ux-expert.md +73 -0
  105. package/claude/commands/BMad/tasks/advanced-elicitation.md +123 -0
  106. package/claude/commands/BMad/tasks/apply-qa-fixes.md +154 -0
  107. package/claude/commands/BMad/tasks/brownfield-create-epic.md +166 -0
  108. package/claude/commands/BMad/tasks/brownfield-create-story.md +153 -0
  109. package/claude/commands/BMad/tasks/correct-course.md +76 -0
  110. package/claude/commands/BMad/tasks/create-brownfield-story.md +318 -0
  111. package/claude/commands/BMad/tasks/create-deep-research-prompt.md +284 -0
  112. package/claude/commands/BMad/tasks/create-doc.md +107 -0
  113. package/claude/commands/BMad/tasks/create-next-story.md +118 -0
  114. package/claude/commands/BMad/tasks/document-project.md +349 -0
  115. package/claude/commands/BMad/tasks/execute-checklist.md +92 -0
  116. package/claude/commands/BMad/tasks/facilitate-brainstorming-session.md +142 -0
  117. package/claude/commands/BMad/tasks/generate-ai-frontend-prompt.md +57 -0
  118. package/claude/commands/BMad/tasks/index-docs.md +179 -0
  119. package/claude/commands/BMad/tasks/kb-mode-interaction.md +81 -0
  120. package/claude/commands/BMad/tasks/nfr-assess.md +349 -0
  121. package/claude/commands/BMad/tasks/qa-gate.md +167 -0
  122. package/claude/commands/BMad/tasks/review-story.md +320 -0
  123. package/claude/commands/BMad/tasks/risk-profile.md +359 -0
  124. package/claude/commands/BMad/tasks/shard-doc.md +191 -0
  125. package/claude/commands/BMad/tasks/test-design.md +180 -0
  126. package/claude/commands/BMad/tasks/trace-requirements.md +270 -0
  127. package/claude/commands/BMad/tasks/validate-next-story.md +140 -0
  128. package/claude/hooks/file-restriction-hook.py +51 -0
  129. package/claude/hooks/track-agent.py +67 -0
  130. package/claude/settings.local.json +56 -0
  131. package/github/b-mad-expert.md +742 -742
  132. package/github/chatmodes/analyst.chatmode.md +89 -89
  133. package/github/chatmodes/architect.chatmode.md +97 -97
  134. package/github/chatmodes/backend.chatmode.md +194 -194
  135. package/github/chatmodes/bmad-master.chatmode.md +115 -115
  136. package/github/chatmodes/bmad-orchestrator.chatmode.md +152 -152
  137. package/github/chatmodes/dev.chatmode.md +86 -86
  138. package/github/chatmodes/frontend.chatmode.md +157 -157
  139. package/github/chatmodes/pm.chatmode.md +89 -89
  140. package/github/chatmodes/po.chatmode.md +84 -84
  141. package/github/chatmodes/qa.chatmode.md +96 -96
  142. package/github/chatmodes/sm.chatmode.md +70 -70
  143. package/github/chatmodes/ux-expert.chatmode.md +74 -74
  144. package/index.js +9 -9
  145. package/package.json +37 -36
  146. package/vscode/mcp.json +11 -11
  147. package/vscode/settings.json +12 -12
@@ -1,350 +1,350 @@
1
- # <!-- Powered by BMAD™ Core -->
2
- template:
3
- id: frontend-spec-template-v2
4
- name: UI/UX Specification
5
- version: 2.0
6
- output:
7
- format: markdown
8
- filename: docs/front-end-spec.md
9
- title: "{{project_name}} UI/UX Specification"
10
-
11
- workflow:
12
- mode: interactive
13
- elicitation: advanced-elicitation
14
-
15
- sections:
16
- - id: introduction
17
- title: Introduction
18
- instruction: |
19
- Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.
20
-
21
- Establish the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
22
- content: |
23
- This document defines the user experience goals, information architecture, user flows, and visual design specifications for {{project_name}}'s user interface. It serves as the foundation for visual design and frontend development, ensuring a cohesive and user-centered experience.
24
- sections:
25
- - id: ux-goals-principles
26
- title: Overall UX Goals & Principles
27
- instruction: |
28
- Work with the user to establish and document the following. If not already defined, facilitate a discussion to determine:
29
-
30
- 1. Target User Personas - elicit details or confirm existing ones from PRD
31
- 2. Key Usability Goals - understand what success looks like for users
32
- 3. Core Design Principles - establish 3-5 guiding principles
33
- elicit: true
34
- sections:
35
- - id: user-personas
36
- title: Target User Personas
37
- template: "{{persona_descriptions}}"
38
- examples:
39
- - "**Power User:** Technical professionals who need advanced features and efficiency"
40
- - "**Casual User:** Occasional users who prioritize ease of use and clear guidance"
41
- - "**Administrator:** System managers who need control and oversight capabilities"
42
- - id: usability-goals
43
- title: Usability Goals
44
- template: "{{usability_goals}}"
45
- examples:
46
- - "Ease of learning: New users can complete core tasks within 5 minutes"
47
- - "Efficiency of use: Power users can complete frequent tasks with minimal clicks"
48
- - "Error prevention: Clear validation and confirmation for destructive actions"
49
- - "Memorability: Infrequent users can return without relearning"
50
- - id: design-principles
51
- title: Design Principles
52
- template: "{{design_principles}}"
53
- type: numbered-list
54
- examples:
55
- - "**Clarity over cleverness** - Prioritize clear communication over aesthetic innovation"
56
- - "**Progressive disclosure** - Show only what's needed, when it's needed"
57
- - "**Consistent patterns** - Use familiar UI patterns throughout the application"
58
- - "**Immediate feedback** - Every action should have a clear, immediate response"
59
- - "**Accessible by default** - Design for all users from the start"
60
- - id: changelog
61
- title: Change Log
62
- type: table
63
- columns: [Date, Version, Description, Author]
64
- instruction: Track document versions and changes
65
-
66
- - id: information-architecture
67
- title: Information Architecture (IA)
68
- instruction: |
69
- Collaborate with the user to create a comprehensive information architecture:
70
-
71
- 1. Build a Site Map or Screen Inventory showing all major areas
72
- 2. Define the Navigation Structure (primary, secondary, breadcrumbs)
73
- 3. Use Mermaid diagrams for visual representation
74
- 4. Consider user mental models and expected groupings
75
- elicit: true
76
- sections:
77
- - id: sitemap
78
- title: Site Map / Screen Inventory
79
- type: mermaid
80
- mermaid_type: graph
81
- template: "{{sitemap_diagram}}"
82
- examples:
83
- - |
84
- graph TD
85
- A[Homepage] --> B[Dashboard]
86
- A --> C[Products]
87
- A --> D[Account]
88
- B --> B1[Analytics]
89
- B --> B2[Recent Activity]
90
- C --> C1[Browse]
91
- C --> C2[Search]
92
- C --> C3[Product Details]
93
- D --> D1[Profile]
94
- D --> D2[Settings]
95
- D --> D3[Billing]
96
- - id: navigation-structure
97
- title: Navigation Structure
98
- template: |
99
- **Primary Navigation:** {{primary_nav_description}}
100
-
101
- **Secondary Navigation:** {{secondary_nav_description}}
102
-
103
- **Breadcrumb Strategy:** {{breadcrumb_strategy}}
104
-
105
- - id: user-flows
106
- title: User Flows
107
- instruction: |
108
- For each critical user task identified in the PRD:
109
-
110
- 1. Define the user's goal clearly
111
- 2. Map out all steps including decision points
112
- 3. Consider edge cases and error states
113
- 4. Use Mermaid flow diagrams for clarity
114
- 5. Link to external tools (Figma/Miro) if detailed flows exist there
115
-
116
- Create subsections for each major flow.
117
- elicit: true
118
- repeatable: true
119
- sections:
120
- - id: flow
121
- title: "{{flow_name}}"
122
- template: |
123
- **User Goal:** {{flow_goal}}
124
-
125
- **Entry Points:** {{entry_points}}
126
-
127
- **Success Criteria:** {{success_criteria}}
128
- sections:
129
- - id: flow-diagram
130
- title: Flow Diagram
131
- type: mermaid
132
- mermaid_type: graph
133
- template: "{{flow_diagram}}"
134
- - id: edge-cases
135
- title: "Edge Cases & Error Handling:"
136
- type: bullet-list
137
- template: "- {{edge_case}}"
138
- - id: notes
139
- template: "**Notes:** {{flow_notes}}"
140
-
141
- - id: wireframes-mockups
142
- title: Wireframes & Mockups
143
- instruction: |
144
- Clarify where detailed visual designs will be created (Figma, Sketch, etc.) and how to reference them. If low-fidelity wireframes are needed, offer to help conceptualize layouts for key screens.
145
- elicit: true
146
- sections:
147
- - id: design-files
148
- template: "**Primary Design Files:** {{design_tool_link}}"
149
- - id: key-screen-layouts
150
- title: Key Screen Layouts
151
- repeatable: true
152
- sections:
153
- - id: screen
154
- title: "{{screen_name}}"
155
- template: |
156
- **Purpose:** {{screen_purpose}}
157
-
158
- **Key Elements:**
159
- - {{element_1}}
160
- - {{element_2}}
161
- - {{element_3}}
162
-
163
- **Interaction Notes:** {{interaction_notes}}
164
-
165
- **Design File Reference:** {{specific_frame_link}}
166
-
167
- - id: component-library
168
- title: Component Library / Design System
169
- instruction: |
170
- Discuss whether to use an existing design system or create a new one. If creating new, identify foundational components and their key states. Note that detailed technical specs belong in front-end-architecture.
171
- elicit: true
172
- sections:
173
- - id: design-system-approach
174
- template: "**Design System Approach:** {{design_system_approach}}"
175
- - id: core-components
176
- title: Core Components
177
- repeatable: true
178
- sections:
179
- - id: component
180
- title: "{{component_name}}"
181
- template: |
182
- **Purpose:** {{component_purpose}}
183
-
184
- **Variants:** {{component_variants}}
185
-
186
- **States:** {{component_states}}
187
-
188
- **Usage Guidelines:** {{usage_guidelines}}
189
-
190
- - id: branding-style
191
- title: Branding & Style Guide
192
- instruction: Link to existing style guide or define key brand elements. Ensure consistency with company brand guidelines if they exist.
193
- elicit: true
194
- sections:
195
- - id: visual-identity
196
- title: Visual Identity
197
- template: "**Brand Guidelines:** {{brand_guidelines_link}}"
198
- - id: color-palette
199
- title: Color Palette
200
- type: table
201
- columns: ["Color Type", "Hex Code", "Usage"]
202
- rows:
203
- - ["Primary", "{{primary_color}}", "{{primary_usage}}"]
204
- - ["Secondary", "{{secondary_color}}", "{{secondary_usage}}"]
205
- - ["Accent", "{{accent_color}}", "{{accent_usage}}"]
206
- - ["Success", "{{success_color}}", "Positive feedback, confirmations"]
207
- - ["Warning", "{{warning_color}}", "Cautions, important notices"]
208
- - ["Error", "{{error_color}}", "Errors, destructive actions"]
209
- - ["Neutral", "{{neutral_colors}}", "Text, borders, backgrounds"]
210
- - id: typography
211
- title: Typography
212
- sections:
213
- - id: font-families
214
- title: Font Families
215
- template: |
216
- - **Primary:** {{primary_font}}
217
- - **Secondary:** {{secondary_font}}
218
- - **Monospace:** {{mono_font}}
219
- - id: type-scale
220
- title: Type Scale
221
- type: table
222
- columns: ["Element", "Size", "Weight", "Line Height"]
223
- rows:
224
- - ["H1", "{{h1_size}}", "{{h1_weight}}", "{{h1_line}}"]
225
- - ["H2", "{{h2_size}}", "{{h2_weight}}", "{{h2_line}}"]
226
- - ["H3", "{{h3_size}}", "{{h3_weight}}", "{{h3_line}}"]
227
- - ["Body", "{{body_size}}", "{{body_weight}}", "{{body_line}}"]
228
- - ["Small", "{{small_size}}", "{{small_weight}}", "{{small_line}}"]
229
- - id: iconography
230
- title: Iconography
231
- template: |
232
- **Icon Library:** {{icon_library}}
233
-
234
- **Usage Guidelines:** {{icon_guidelines}}
235
- - id: spacing-layout
236
- title: Spacing & Layout
237
- template: |
238
- **Grid System:** {{grid_system}}
239
-
240
- **Spacing Scale:** {{spacing_scale}}
241
-
242
- - id: accessibility
243
- title: Accessibility Requirements
244
- instruction: Define specific accessibility requirements based on target compliance level and user needs. Be comprehensive but practical.
245
- elicit: true
246
- sections:
247
- - id: compliance-target
248
- title: Compliance Target
249
- template: "**Standard:** {{compliance_standard}}"
250
- - id: key-requirements
251
- title: Key Requirements
252
- template: |
253
- **Visual:**
254
- - Color contrast ratios: {{contrast_requirements}}
255
- - Focus indicators: {{focus_requirements}}
256
- - Text sizing: {{text_requirements}}
257
-
258
- **Interaction:**
259
- - Keyboard navigation: {{keyboard_requirements}}
260
- - Screen reader support: {{screen_reader_requirements}}
261
- - Touch targets: {{touch_requirements}}
262
-
263
- **Content:**
264
- - Alternative text: {{alt_text_requirements}}
265
- - Heading structure: {{heading_requirements}}
266
- - Form labels: {{form_requirements}}
267
- - id: testing-strategy
268
- title: Testing Strategy
269
- template: "{{accessibility_testing}}"
270
-
271
- - id: responsiveness
272
- title: Responsiveness Strategy
273
- instruction: Define breakpoints and adaptation strategies for different device sizes. Consider both technical constraints and user contexts.
274
- elicit: true
275
- sections:
276
- - id: breakpoints
277
- title: Breakpoints
278
- type: table
279
- columns: ["Breakpoint", "Min Width", "Max Width", "Target Devices"]
280
- rows:
281
- - ["Mobile", "{{mobile_min}}", "{{mobile_max}}", "{{mobile_devices}}"]
282
- - ["Tablet", "{{tablet_min}}", "{{tablet_max}}", "{{tablet_devices}}"]
283
- - ["Desktop", "{{desktop_min}}", "{{desktop_max}}", "{{desktop_devices}}"]
284
- - ["Wide", "{{wide_min}}", "-", "{{wide_devices}}"]
285
- - id: adaptation-patterns
286
- title: Adaptation Patterns
287
- template: |
288
- **Layout Changes:** {{layout_adaptations}}
289
-
290
- **Navigation Changes:** {{nav_adaptations}}
291
-
292
- **Content Priority:** {{content_adaptations}}
293
-
294
- **Interaction Changes:** {{interaction_adaptations}}
295
-
296
- - id: animation
297
- title: Animation & Micro-interactions
298
- instruction: Define motion design principles and key interactions. Keep performance and accessibility in mind.
299
- elicit: true
300
- sections:
301
- - id: motion-principles
302
- title: Motion Principles
303
- template: "{{motion_principles}}"
304
- - id: key-animations
305
- title: Key Animations
306
- repeatable: true
307
- template: "- **{{animation_name}}:** {{animation_description}} (Duration: {{duration}}, Easing: {{easing}})"
308
-
309
- - id: performance
310
- title: Performance Considerations
311
- instruction: Define performance goals and strategies that impact UX design decisions.
312
- sections:
313
- - id: performance-goals
314
- title: Performance Goals
315
- template: |
316
- - **Page Load:** {{load_time_goal}}
317
- - **Interaction Response:** {{interaction_goal}}
318
- - **Animation FPS:** {{animation_goal}}
319
- - id: design-strategies
320
- title: Design Strategies
321
- template: "{{performance_strategies}}"
322
-
323
- - id: next-steps
324
- title: Next Steps
325
- instruction: |
326
- After completing the UI/UX specification:
327
-
328
- 1. Recommend review with stakeholders
329
- 2. Suggest creating/updating visual designs in design tool
330
- 3. Prepare for handoff to Design Architect for frontend architecture
331
- 4. Note any open questions or decisions needed
332
- sections:
333
- - id: immediate-actions
334
- title: Immediate Actions
335
- type: numbered-list
336
- template: "{{action}}"
337
- - id: design-handoff-checklist
338
- title: Design Handoff Checklist
339
- type: checklist
340
- items:
341
- - "All user flows documented"
342
- - "Component inventory complete"
343
- - "Accessibility requirements defined"
344
- - "Responsive strategy clear"
345
- - "Brand guidelines incorporated"
346
- - "Performance goals established"
347
-
348
- - id: checklist-results
349
- title: Checklist Results
350
- instruction: If a UI/UX checklist exists, run it against this document and report results here.
1
+ # <!-- Powered by BMAD™ Core -->
2
+ template:
3
+ id: frontend-spec-template-v2
4
+ name: UI/UX Specification
5
+ version: 2.0
6
+ output:
7
+ format: markdown
8
+ filename: docs/front-end-spec.md
9
+ title: "{{project_name}} UI/UX Specification"
10
+
11
+ workflow:
12
+ mode: interactive
13
+ elicitation: advanced-elicitation
14
+
15
+ sections:
16
+ - id: introduction
17
+ title: Introduction
18
+ instruction: |
19
+ Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.
20
+
21
+ Establish the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
22
+ content: |
23
+ This document defines the user experience goals, information architecture, user flows, and visual design specifications for {{project_name}}'s user interface. It serves as the foundation for visual design and frontend development, ensuring a cohesive and user-centered experience.
24
+ sections:
25
+ - id: ux-goals-principles
26
+ title: Overall UX Goals & Principles
27
+ instruction: |
28
+ Work with the user to establish and document the following. If not already defined, facilitate a discussion to determine:
29
+
30
+ 1. Target User Personas - elicit details or confirm existing ones from PRD
31
+ 2. Key Usability Goals - understand what success looks like for users
32
+ 3. Core Design Principles - establish 3-5 guiding principles
33
+ elicit: true
34
+ sections:
35
+ - id: user-personas
36
+ title: Target User Personas
37
+ template: "{{persona_descriptions}}"
38
+ examples:
39
+ - "**Power User:** Technical professionals who need advanced features and efficiency"
40
+ - "**Casual User:** Occasional users who prioritize ease of use and clear guidance"
41
+ - "**Administrator:** System managers who need control and oversight capabilities"
42
+ - id: usability-goals
43
+ title: Usability Goals
44
+ template: "{{usability_goals}}"
45
+ examples:
46
+ - "Ease of learning: New users can complete core tasks within 5 minutes"
47
+ - "Efficiency of use: Power users can complete frequent tasks with minimal clicks"
48
+ - "Error prevention: Clear validation and confirmation for destructive actions"
49
+ - "Memorability: Infrequent users can return without relearning"
50
+ - id: design-principles
51
+ title: Design Principles
52
+ template: "{{design_principles}}"
53
+ type: numbered-list
54
+ examples:
55
+ - "**Clarity over cleverness** - Prioritize clear communication over aesthetic innovation"
56
+ - "**Progressive disclosure** - Show only what's needed, when it's needed"
57
+ - "**Consistent patterns** - Use familiar UI patterns throughout the application"
58
+ - "**Immediate feedback** - Every action should have a clear, immediate response"
59
+ - "**Accessible by default** - Design for all users from the start"
60
+ - id: changelog
61
+ title: Change Log
62
+ type: table
63
+ columns: [Date, Version, Description, Author]
64
+ instruction: Track document versions and changes
65
+
66
+ - id: information-architecture
67
+ title: Information Architecture (IA)
68
+ instruction: |
69
+ Collaborate with the user to create a comprehensive information architecture:
70
+
71
+ 1. Build a Site Map or Screen Inventory showing all major areas
72
+ 2. Define the Navigation Structure (primary, secondary, breadcrumbs)
73
+ 3. Use Mermaid diagrams for visual representation
74
+ 4. Consider user mental models and expected groupings
75
+ elicit: true
76
+ sections:
77
+ - id: sitemap
78
+ title: Site Map / Screen Inventory
79
+ type: mermaid
80
+ mermaid_type: graph
81
+ template: "{{sitemap_diagram}}"
82
+ examples:
83
+ - |
84
+ graph TD
85
+ A[Homepage] --> B[Dashboard]
86
+ A --> C[Products]
87
+ A --> D[Account]
88
+ B --> B1[Analytics]
89
+ B --> B2[Recent Activity]
90
+ C --> C1[Browse]
91
+ C --> C2[Search]
92
+ C --> C3[Product Details]
93
+ D --> D1[Profile]
94
+ D --> D2[Settings]
95
+ D --> D3[Billing]
96
+ - id: navigation-structure
97
+ title: Navigation Structure
98
+ template: |
99
+ **Primary Navigation:** {{primary_nav_description}}
100
+
101
+ **Secondary Navigation:** {{secondary_nav_description}}
102
+
103
+ **Breadcrumb Strategy:** {{breadcrumb_strategy}}
104
+
105
+ - id: user-flows
106
+ title: User Flows
107
+ instruction: |
108
+ For each critical user task identified in the PRD:
109
+
110
+ 1. Define the user's goal clearly
111
+ 2. Map out all steps including decision points
112
+ 3. Consider edge cases and error states
113
+ 4. Use Mermaid flow diagrams for clarity
114
+ 5. Link to external tools (Figma/Miro) if detailed flows exist there
115
+
116
+ Create subsections for each major flow.
117
+ elicit: true
118
+ repeatable: true
119
+ sections:
120
+ - id: flow
121
+ title: "{{flow_name}}"
122
+ template: |
123
+ **User Goal:** {{flow_goal}}
124
+
125
+ **Entry Points:** {{entry_points}}
126
+
127
+ **Success Criteria:** {{success_criteria}}
128
+ sections:
129
+ - id: flow-diagram
130
+ title: Flow Diagram
131
+ type: mermaid
132
+ mermaid_type: graph
133
+ template: "{{flow_diagram}}"
134
+ - id: edge-cases
135
+ title: "Edge Cases & Error Handling:"
136
+ type: bullet-list
137
+ template: "- {{edge_case}}"
138
+ - id: notes
139
+ template: "**Notes:** {{flow_notes}}"
140
+
141
+ - id: wireframes-mockups
142
+ title: Wireframes & Mockups
143
+ instruction: |
144
+ Clarify where detailed visual designs will be created (Figma, Sketch, etc.) and how to reference them. If low-fidelity wireframes are needed, offer to help conceptualize layouts for key screens.
145
+ elicit: true
146
+ sections:
147
+ - id: design-files
148
+ template: "**Primary Design Files:** {{design_tool_link}}"
149
+ - id: key-screen-layouts
150
+ title: Key Screen Layouts
151
+ repeatable: true
152
+ sections:
153
+ - id: screen
154
+ title: "{{screen_name}}"
155
+ template: |
156
+ **Purpose:** {{screen_purpose}}
157
+
158
+ **Key Elements:**
159
+ - {{element_1}}
160
+ - {{element_2}}
161
+ - {{element_3}}
162
+
163
+ **Interaction Notes:** {{interaction_notes}}
164
+
165
+ **Design File Reference:** {{specific_frame_link}}
166
+
167
+ - id: component-library
168
+ title: Component Library / Design System
169
+ instruction: |
170
+ Discuss whether to use an existing design system or create a new one. If creating new, identify foundational components and their key states. Note that detailed technical specs belong in front-end-architecture.
171
+ elicit: true
172
+ sections:
173
+ - id: design-system-approach
174
+ template: "**Design System Approach:** {{design_system_approach}}"
175
+ - id: core-components
176
+ title: Core Components
177
+ repeatable: true
178
+ sections:
179
+ - id: component
180
+ title: "{{component_name}}"
181
+ template: |
182
+ **Purpose:** {{component_purpose}}
183
+
184
+ **Variants:** {{component_variants}}
185
+
186
+ **States:** {{component_states}}
187
+
188
+ **Usage Guidelines:** {{usage_guidelines}}
189
+
190
+ - id: branding-style
191
+ title: Branding & Style Guide
192
+ instruction: Link to existing style guide or define key brand elements. Ensure consistency with company brand guidelines if they exist.
193
+ elicit: true
194
+ sections:
195
+ - id: visual-identity
196
+ title: Visual Identity
197
+ template: "**Brand Guidelines:** {{brand_guidelines_link}}"
198
+ - id: color-palette
199
+ title: Color Palette
200
+ type: table
201
+ columns: ["Color Type", "Hex Code", "Usage"]
202
+ rows:
203
+ - ["Primary", "{{primary_color}}", "{{primary_usage}}"]
204
+ - ["Secondary", "{{secondary_color}}", "{{secondary_usage}}"]
205
+ - ["Accent", "{{accent_color}}", "{{accent_usage}}"]
206
+ - ["Success", "{{success_color}}", "Positive feedback, confirmations"]
207
+ - ["Warning", "{{warning_color}}", "Cautions, important notices"]
208
+ - ["Error", "{{error_color}}", "Errors, destructive actions"]
209
+ - ["Neutral", "{{neutral_colors}}", "Text, borders, backgrounds"]
210
+ - id: typography
211
+ title: Typography
212
+ sections:
213
+ - id: font-families
214
+ title: Font Families
215
+ template: |
216
+ - **Primary:** {{primary_font}}
217
+ - **Secondary:** {{secondary_font}}
218
+ - **Monospace:** {{mono_font}}
219
+ - id: type-scale
220
+ title: Type Scale
221
+ type: table
222
+ columns: ["Element", "Size", "Weight", "Line Height"]
223
+ rows:
224
+ - ["H1", "{{h1_size}}", "{{h1_weight}}", "{{h1_line}}"]
225
+ - ["H2", "{{h2_size}}", "{{h2_weight}}", "{{h2_line}}"]
226
+ - ["H3", "{{h3_size}}", "{{h3_weight}}", "{{h3_line}}"]
227
+ - ["Body", "{{body_size}}", "{{body_weight}}", "{{body_line}}"]
228
+ - ["Small", "{{small_size}}", "{{small_weight}}", "{{small_line}}"]
229
+ - id: iconography
230
+ title: Iconography
231
+ template: |
232
+ **Icon Library:** {{icon_library}}
233
+
234
+ **Usage Guidelines:** {{icon_guidelines}}
235
+ - id: spacing-layout
236
+ title: Spacing & Layout
237
+ template: |
238
+ **Grid System:** {{grid_system}}
239
+
240
+ **Spacing Scale:** {{spacing_scale}}
241
+
242
+ - id: accessibility
243
+ title: Accessibility Requirements
244
+ instruction: Define specific accessibility requirements based on target compliance level and user needs. Be comprehensive but practical.
245
+ elicit: true
246
+ sections:
247
+ - id: compliance-target
248
+ title: Compliance Target
249
+ template: "**Standard:** {{compliance_standard}}"
250
+ - id: key-requirements
251
+ title: Key Requirements
252
+ template: |
253
+ **Visual:**
254
+ - Color contrast ratios: {{contrast_requirements}}
255
+ - Focus indicators: {{focus_requirements}}
256
+ - Text sizing: {{text_requirements}}
257
+
258
+ **Interaction:**
259
+ - Keyboard navigation: {{keyboard_requirements}}
260
+ - Screen reader support: {{screen_reader_requirements}}
261
+ - Touch targets: {{touch_requirements}}
262
+
263
+ **Content:**
264
+ - Alternative text: {{alt_text_requirements}}
265
+ - Heading structure: {{heading_requirements}}
266
+ - Form labels: {{form_requirements}}
267
+ - id: testing-strategy
268
+ title: Testing Strategy
269
+ template: "{{accessibility_testing}}"
270
+
271
+ - id: responsiveness
272
+ title: Responsiveness Strategy
273
+ instruction: Define breakpoints and adaptation strategies for different device sizes. Consider both technical constraints and user contexts.
274
+ elicit: true
275
+ sections:
276
+ - id: breakpoints
277
+ title: Breakpoints
278
+ type: table
279
+ columns: ["Breakpoint", "Min Width", "Max Width", "Target Devices"]
280
+ rows:
281
+ - ["Mobile", "{{mobile_min}}", "{{mobile_max}}", "{{mobile_devices}}"]
282
+ - ["Tablet", "{{tablet_min}}", "{{tablet_max}}", "{{tablet_devices}}"]
283
+ - ["Desktop", "{{desktop_min}}", "{{desktop_max}}", "{{desktop_devices}}"]
284
+ - ["Wide", "{{wide_min}}", "-", "{{wide_devices}}"]
285
+ - id: adaptation-patterns
286
+ title: Adaptation Patterns
287
+ template: |
288
+ **Layout Changes:** {{layout_adaptations}}
289
+
290
+ **Navigation Changes:** {{nav_adaptations}}
291
+
292
+ **Content Priority:** {{content_adaptations}}
293
+
294
+ **Interaction Changes:** {{interaction_adaptations}}
295
+
296
+ - id: animation
297
+ title: Animation & Micro-interactions
298
+ instruction: Define motion design principles and key interactions. Keep performance and accessibility in mind.
299
+ elicit: true
300
+ sections:
301
+ - id: motion-principles
302
+ title: Motion Principles
303
+ template: "{{motion_principles}}"
304
+ - id: key-animations
305
+ title: Key Animations
306
+ repeatable: true
307
+ template: "- **{{animation_name}}:** {{animation_description}} (Duration: {{duration}}, Easing: {{easing}})"
308
+
309
+ - id: performance
310
+ title: Performance Considerations
311
+ instruction: Define performance goals and strategies that impact UX design decisions.
312
+ sections:
313
+ - id: performance-goals
314
+ title: Performance Goals
315
+ template: |
316
+ - **Page Load:** {{load_time_goal}}
317
+ - **Interaction Response:** {{interaction_goal}}
318
+ - **Animation FPS:** {{animation_goal}}
319
+ - id: design-strategies
320
+ title: Design Strategies
321
+ template: "{{performance_strategies}}"
322
+
323
+ - id: next-steps
324
+ title: Next Steps
325
+ instruction: |
326
+ After completing the UI/UX specification:
327
+
328
+ 1. Recommend review with stakeholders
329
+ 2. Suggest creating/updating visual designs in design tool
330
+ 3. Prepare for handoff to Design Architect for frontend architecture
331
+ 4. Note any open questions or decisions needed
332
+ sections:
333
+ - id: immediate-actions
334
+ title: Immediate Actions
335
+ type: numbered-list
336
+ template: "{{action}}"
337
+ - id: design-handoff-checklist
338
+ title: Design Handoff Checklist
339
+ type: checklist
340
+ items:
341
+ - "All user flows documented"
342
+ - "Component inventory complete"
343
+ - "Accessibility requirements defined"
344
+ - "Responsive strategy clear"
345
+ - "Brand guidelines incorporated"
346
+ - "Performance goals established"
347
+
348
+ - id: checklist-results
349
+ title: Checklist Results
350
+ instruction: If a UI/UX checklist exists, run it against this document and report results here.