mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
disco and output fix for ux design
This commit is contained in:
Brian Madison
@@ -35,7 +35,7 @@ Initialize the UX design workflow by detecting continuation state and setting up
|
||||
|
||||
First, check if the output document already exists:
|
||||
|
||||
- Look for file at `{planning_artifacts}/ux-design-specification.md`
|
||||
- Look for file at `{planning_artifacts}/*ux-design-specification*.md`
|
||||
- If exists, read the complete file including frontmatter
|
||||
- If not exists, this is a fresh workflow
|
||||
|
||||
@@ -53,59 +53,32 @@ If no document exists or no `stepsCompleted` in frontmatter:
|
||||
|
||||
#### A. Input Document Discovery
|
||||
|
||||
Discover and load context documents using smart discovery:
|
||||
Discover and load context documents using smart discovery. Documents can be in the following locations:
|
||||
- {planning_artifacts}/**
|
||||
- {output_folder}/**
|
||||
- {product_knowledge}/**
|
||||
- docs/**
|
||||
|
||||
**PRD (Priority: Analysis → Main → Sharded → Whole):**
|
||||
Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files.
|
||||
|
||||
1. Check analysis folder: `{planning_artifacts}/*prd*.md`
|
||||
2. If no files: Try main folder: `{output_folder}/*prd*.md`
|
||||
3. If no main files: Check for sharded PRD folder: `**/*prd*/**/*.md`
|
||||
4. If sharded folder exists: Load EVERY file in that folder completely for UX context
|
||||
5. Add discovered files to `inputDocuments` frontmatter
|
||||
Try to discover the following:
|
||||
- Product Brief (`*brief*.md`)
|
||||
- Research Documents (`*prd*.md`)
|
||||
- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.)
|
||||
|
||||
**Product Brief (Priority: Analysis → Main → Sharded → Whole):**
|
||||
|
||||
1. Check analysis folder: `{planning_artifacts}/*brief*.md`
|
||||
2. If no analysis files: Try main folder: `{output_folder}/*brief*.md`
|
||||
3. If no main files: Check for sharded brief folder: `**/*brief*/**/*.md`
|
||||
4. If sharded folder exists: Load EVERY file in that folder completely
|
||||
5. Add discovered files to `inputDocuments` frontmatter
|
||||
|
||||
**Research Documents (Priority: Analysis → Main → Sharded → Whole):**
|
||||
|
||||
1. Check analysis folder: `{planning_artifacts}/research/*research*.md`
|
||||
2. If no analysis files: Try main folder: `{output_folder}/*research*.md`
|
||||
3. If no main files: Check for sharded research folder: `{output_folder}/*research*/**/*.md`
|
||||
4. Load useful research files completely
|
||||
5. Add discovered files to `inputDocuments` frontmatter
|
||||
|
||||
**Other Context (Priority: Analysis → Main → Sharded):**
|
||||
|
||||
- Epics: `{output_folder}/analysis/*epic*.md` or `{output_folder}/*epic*.md` or `{output_folder}/*epic*/**/*.md`
|
||||
- Brainstorming: `{output_folder}/analysis/brainstorming/*brainstorming*.md` or `{output_folder}/*brainstorming*.md`
|
||||
<critical>Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules</critical>
|
||||
|
||||
**Loading Rules:**
|
||||
|
||||
- Load ALL discovered files completely (no offset/limit)
|
||||
- For sharded folders, load ALL files to get complete picture
|
||||
- Load ALL discovered files completely that the user confirmed or provided (no offset/limit)
|
||||
- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document
|
||||
- index.md is a guide to what's relevant whenever available
|
||||
- Track all successfully loaded files in frontmatter `inputDocuments` array
|
||||
|
||||
#### B. Create Initial Document
|
||||
|
||||
Copy the template from `{installed_path}/ux-design-template.md` to `{planning_artifacts}/ux-design-specification.md`
|
||||
Initialize frontmatter with:
|
||||
|
||||
```yaml
|
||||
---
|
||||
stepsCompleted: []
|
||||
inputDocuments: []
|
||||
workflowType: 'ux-design'
|
||||
lastStep: 0
|
||||
project_name: '{{project_name}}'
|
||||
user_name: '{{user_name}}'
|
||||
date: '{{date}}'
|
||||
---
|
||||
```
|
||||
Initialize frontmatter in the template.
|
||||
|
||||
#### C. Complete Initialization and Report
|
||||
|
||||
@@ -134,7 +107,7 @@ Do you have any other documents you'd like me to include, or shall we continue t
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects [C] to continue, load `./step-02-discovery.md` to begin the UX discovery phase.
|
||||
After user selects [C] to continue, ensure the file `{planning_artifacts}/ux-design-specification.md` has been created and saved, and then load `./step-02-discovery.md` to begin the UX discovery phase.
|
||||
|
||||
Remember: Do NOT proceed to step-02 until output file has been updated and user explicitly selects [C] to continue!
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating project understanding content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating core experience content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
@@ -177,7 +177,7 @@ Show the generated core experience content and present choices:
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3]`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-04-emotional-response.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating emotional response content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
@@ -180,7 +180,7 @@ Show the generated emotional response content and present choices:
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-05-inspiration.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating inspiration analysis content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
@@ -195,7 +195,7 @@ Show the generated inspiration analysis content and present choices:
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load and execute`./step-06-design-system.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating design system decision content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
@@ -213,7 +213,7 @@ Show the generated design system content and present choices:
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6]`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-07-defining-experience.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating defining experience content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
@@ -215,7 +215,7 @@ Show the generated defining experience content and present choices:
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-08-visual-foundation.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating visual foundation content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
@@ -185,7 +185,7 @@ Show the generated visual foundation content and present choices:
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-09-design-directions.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating design direction content
|
||||
- 💾 Generate HTML visualizer for design directions
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
@@ -65,7 +65,7 @@ Each mockup will show a complete vision for {{project_name}} with all our design
|
||||
Generate interactive visual exploration:
|
||||
"🎨 Design Direction Mockups Generated!
|
||||
|
||||
I'm creating a comprehensive HTML design direction showcase at `{output_folder}/ux-design-directions.html`
|
||||
I'm creating a comprehensive HTML design direction showcase at `{planning_artifacts}/ux-design-directions.html`
|
||||
|
||||
**What you'll see:**
|
||||
|
||||
@@ -185,7 +185,7 @@ Show the generated design direction content and present choices:
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-10-user-journeys.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating user journey content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
@@ -203,7 +203,7 @@ Show the generated user journey content and present choices:
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-11-component-strategy.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating component strategy content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
@@ -209,7 +209,7 @@ Show the generated component strategy content and present choices:
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-12-ux-patterns.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating UX patterns content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
@@ -198,7 +198,7 @@ Show the generated UX patterns content and present choices:
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-13-responsive-accessibility.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- ⚠️ Present A/P/C menu after generating responsive/accessibility content
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]` before loading next step
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
|
||||
- 🚫 FORBIDDEN to load next step until C is selected
|
||||
|
||||
## COLLABORATION MENUS (A/P/C):
|
||||
@@ -225,7 +225,7 @@ Show the generated responsive and accessibility content and present choices:
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-14-complete.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -21,6 +21,7 @@
|
||||
## TERMINATION STEP PROTOCOLS:
|
||||
|
||||
- This is a FINAL step - workflow completion required
|
||||
- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted to indicate all is finished..
|
||||
- Output completion summary and next step guidance
|
||||
- Update the main workflow status file with finalized document
|
||||
- Suggest potential next workflow steps for the user
|
||||
@@ -64,8 +65,8 @@ I've successfully collaborated with you to create a comprehensive UX design spec
|
||||
|
||||
**Supporting Visual Assets:**
|
||||
|
||||
- Color themes visualizer: `{output_folder}/ux-color-themes.html`
|
||||
- Design directions mockups: `{output_folder}/ux-design-directions.html`
|
||||
- Color themes visualizer: `{planning_artifacts}/ux-color-themes.html`
|
||||
- Design directions mockups: `{planning_artifacts}/ux-design-directions.html`
|
||||
|
||||
This specification is now ready to guide visual design, implementation, and development."
|
||||
|
||||
@@ -222,5 +223,5 @@ This UX design workflow is now complete. The specification serves as the foundat
|
||||
**Core Deliverables:**
|
||||
|
||||
- ✅ UX Design Specification: `{planning_artifacts}/ux-design-specification.md`
|
||||
- ✅ Color Themes Visualizer: `{output_folder}/ux-color-themes.html`
|
||||
- ✅ Design Directions: `{output_folder}/ux-design-directions.html`
|
||||
- ✅ Color Themes Visualizer: `{planning_artifacts}/ux-color-themes.html`
|
||||
- ✅ Design Directions: `{planning_artifacts}/ux-design-directions.html`
|
||||
|
||||
@@ -37,21 +37,6 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||
- `template_path` = `{installed_path}/ux-design-template.md`
|
||||
- `default_output_file` = `{planning_artifacts}/ux-design-specification.md`
|
||||
|
||||
### Output Files
|
||||
|
||||
- Color themes: `{output_folder}/ux-color-themes.html`
|
||||
- Design directions: `{output_folder}/ux-design-directions.html`
|
||||
|
||||
### Input Document Discovery
|
||||
|
||||
Discover context documents for UX context (Priority: Analysis folder first, then main folder, then sharded):
|
||||
|
||||
- PRD: `{planning_artifacts}/*prd*.md` or `{output_folder}/*prd*.md` or `{output_folder}/*prd*/**/*.md`
|
||||
- Product brief: `{output_folder}/analysis/*brief*.md` or `{output_folder}/*brief*.md` or `{output_folder}/*brief*/**/*.md`
|
||||
- Epics: `{output_folder}/analysis/*epic*.md` or `{output_folder}/*epic*.md` or `{output_folder}/*epic*/**/*.md`
|
||||
- Research: `{output_folder}/analysis/research/*research*.md` or `{output_folder}/*research*.md` or `{output_folder}/*research*/**/*.md`
|
||||
- Brainstorming: `{output_folder}/analysis/brainstorming/*brainstorming*.md` or `{output_folder}/*brainstorming*.md`
|
||||
|
||||
## EXECUTION
|
||||
|
||||
Load and execute `steps/step-01-init.md` to begin the UX design workflow.
|
||||
|
||||
Reference in New Issue
Block a user