bmad-method 6.0.0-alpha.2 → 6.0.0-alpha.20

package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md

@@ -0,0 +1,226 @@
+# Step 14: Workflow Completion
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+- ✅ THIS IS A FINAL STEP - Workflow completion required
+
+- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
+- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
+- 🛑 NO content generation - this is a wrap-up step
+- 📋 FINALIZE document and update workflow status
+- 💬 FOCUS on completion, validation, and next steps
+- 🎯 UPDATE workflow status files with completion information
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis before taking any action
+- 💾 Update the main workflow status file with completion information
+- 📖 Suggest potential next workflow steps for the user
+- 🚫 DO NOT load additional steps after this one
+
+## TERMINATION STEP PROTOCOLS:
+
+- This is a FINAL step - workflow completion required
+- Output completion summary and next step guidance
+- Update the main workflow status file with finalized document
+- Suggest potential next workflow steps for the user
+- Mark workflow as complete in status tracking
+
+## CONTEXT BOUNDARIES:
+
+- Complete UX design specification is available from all previous steps
+- Workflow frontmatter shows all completed steps
+- All collaborative content has been generated and saved
+- Focus on completion, validation, and next steps
+
+## YOUR TASK:
+
+Complete the UX design workflow, update status files, and suggest next steps for the project.
+
+## WORKFLOW COMPLETION SEQUENCE:
+
+### 1. Announce Workflow Completion
+
+Inform user that the UX design is complete:
+"🎉 **UX Design Complete, {{user_name}}!**
+
+I've successfully collaborated with you to create a comprehensive UX design specification for {{project_name}}.
+
+**What we've accomplished:**
+
+- ✅ Project understanding and user insights
+- ✅ Core experience and emotional response definition
+- ✅ UX pattern analysis and inspiration
+- ✅ Design system choice and implementation strategy
+- ✅ Core interaction definition and experience mechanics
+- ✅ Visual design foundation (colors, typography, spacing)
+- ✅ Design direction mockups and visual explorations
+- ✅ User journey flows and interaction design
+- ✅ Component strategy and custom component specifications
+- ✅ UX consistency patterns for common interactions
+- ✅ Responsive design and accessibility strategy
+
+**The complete UX design specification is now available at:** `{planning_artifacts}/ux-design-specification.md`
+
+**Supporting Visual Assets:**
+
+- Color themes visualizer: `{output_folder}/ux-color-themes.html`
+- Design directions mockups: `{output_folder}/ux-design-directions.html`
+
+This specification is now ready to guide visual design, implementation, and development."
+
+### 2. Workflow Status Update
+
+Update the main workflow status file:
+
+- Load `{status_file}` from workflow configuration (if exists)
+- Update workflow_status["create-ux-design"] = "{default_output_file}"
+- Save file, preserving all comments and structure
+- Mark current timestamp as completion time
+
+### 3. Suggest Next Steps
+
+Provide guidance on logical next workflows:
+
+**Typical Next Workflows:**
+
+**Immediate Next Steps:**
+
+1. **Wireframe Generation** - Create detailed wireframes based on UX specification
+2. **Interactive Prototype** - Build clickable prototypes for user testing
+3. **Solution Architecture** - Technical architecture design with UX context
+4. **Figma Design** - High-fidelity visual design implementation
+
+**Visual Design Workflows:**
+
+- Wireframe Generation → Interactive Prototype → Figma Design
+- Component Showcase → AI Frontend Prompt → Design System Implementation
+
+**Development Workflows:**
+
+- Solution Architecture → Epic Creation → Development Sprints
+
+**What would be most valuable to tackle next?**
+
+### 4. Document Quality Check
+
+Perform final validation of the UX design:
+
+**Completeness Check:**
+
+- Does the specification clearly communicate the design vision?
+- Are user journeys thoroughly documented?
+- Are all critical components specified?
+- Are responsive and accessibility requirements comprehensive?
+- Is there clear guidance for implementation?
+
+**Consistency Check:**
+
+- Do all sections align with the emotional goals?
+- Is design system integration clearly defined?
+- Are patterns consistent across all user flows?
+- Does visual direction match established foundation?
+
+### 5. Final Completion Confirmation
+
+Confirm completion with user:
+"**Your UX Design Specification for {{project_name}} is now complete and ready for implementation!**
+
+**The specification contains everything needed to:**
+
+- Guide visual designers in creating the final interfaces
+- Inform developers of all UX requirements and patterns
+- Ensure consistency across all user interactions
+- Maintain accessibility and responsive design standards
+- Provide a foundation for user testing and iteration
+
+**Ready to continue with:**
+
+- Wireframe generation for detailed layouts?
+- Interactive prototype for user testing?
+- Solution architecture for technical planning?
+- Visual design implementation?
+
+**Or would you like to review the complete specification first?**
+
+[UX Design Workflow Complete]"
+
+## SUCCESS METRICS:
+
+✅ UX design specification contains all required sections
+✅ All collaborative content properly saved to document
+✅ Workflow status file updated with completion information
+✅ Clear next step guidance provided to user
+✅ Document quality validation completed
+✅ User acknowledges completion and understands next options
+
+## FAILURE MODES:
+
+❌ Not updating workflow status file with completion information
+❌ Missing clear next step guidance for user
+❌ Not confirming document completeness with user
+❌ Workflow not properly marked as complete in status tracking
+❌ User unclear about what happens next
+
+❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
+❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
+❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
+
+## WORKFLOW COMPLETION CHECKLIST:
+
+### Design Specification Complete:
+
+- [ ] Executive summary and project understanding
+- [ ] Core experience and emotional response definition
+- [ ] UX pattern analysis and inspiration
+- [ ] Design system choice and strategy
+- [ ] Core interaction mechanics definition
+- [ ] Visual design foundation (colors, typography, spacing)
+- [ ] Design direction decisions and mockups
+- [ ] User journey flows and interaction design
+- [ ] Component strategy and specifications
+- [ ] UX consistency patterns documentation
+- [ ] Responsive design and accessibility strategy
+
+### Process Complete:
+
+- [ ] All steps completed with user confirmation
+- [ ] All content saved to specification document
+- [ ] Frontmatter properly updated with all steps
+- [ ] Workflow status file updated with completion
+- [ ] Next steps clearly communicated
+
+## NEXT STEPS GUIDANCE:
+
+**Immediate Options:**
+
+1. **Wireframe Generation** - Create low-fidelity layouts based on UX spec
+2. **Interactive Prototype** - Build clickable prototypes for testing
+3. **Solution Architecture** - Technical design with UX context
+4. **Figma Visual Design** - High-fidelity UI implementation
+5. **Epic Creation** - Break down UX requirements for development
+
+**Recommended Sequence:**
+For design-focused teams: Wireframes → Prototypes → Figma Design → Development
+For technical teams: Architecture → Epic Creation → Development
+
+Consider team capacity, timeline, and whether user validation is needed before implementation.
+
+## WORKFLOW FINALIZATION:
+
+- Set `lastStep = 14` in document frontmatter
+- Update workflow status file with completion timestamp
+- Provide completion summary to user
+- Do NOT load any additional steps
+
+## FINAL REMINDER:
+
+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.
+
+**Congratulations on completing the UX Design Specification for {{project_name}}!** 🎉
+
+**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`

package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md

@@ -1,145 +1,13 @@
-# {{project_name}} UX Design Specification
-
-_Created on {{date}} by {{user_name}}_
-_Generated using BMad Method - Create UX Design Workflow v1.0_
-
----
-
-## Executive Summary
-
-{{project_vision}}
-
----
-
-## 1. Design System Foundation
-
-### 1.1 Design System Choice
-
-{{design_system_decision}}
-
 ---
-
-## 2. Core User Experience
-
-### 2.1 Defining Experience
-
-{{core_experience}}
-
-### 2.2 Novel UX Patterns
-
-{{novel_ux_patterns}}
-
+stepsCompleted: []
+inputDocuments: []
 ---
 
-## 3. Visual Foundation
-
-### 3.1 Color System
-
-{{visual_foundation}}
-
-**Interactive Visualizations:**
-
-- Color Theme Explorer: [ux-color-themes.html](./ux-color-themes.html)
-
----
-
-## 4. Design Direction
-
-### 4.1 Chosen Design Approach
-
-{{design_direction_decision}}
-
-**Interactive Mockups:**
-
-- Design Direction Showcase: [ux-design-directions.html](./ux-design-directions.html)
-
----
-
-## 5. User Journey Flows
-
-### 5.1 Critical User Paths
-
-{{user_journey_flows}}
-
----
-
-## 6. Component Library
-
-### 6.1 Component Strategy
-
-{{component_library_strategy}}
-
----
-
-## 7. UX Pattern Decisions
-
-### 7.1 Consistency Rules
-
-{{ux_pattern_decisions}}
-
----
-
-## 8. Responsive Design & Accessibility
-
-### 8.1 Responsive Strategy
-
-{{responsive_accessibility_strategy}}
-
----
-
-## 9. Implementation Guidance
-
-### 9.1 Completion Summary
-
-{{completion_summary}}
-
----
-
-## Appendix
-
-### Related Documents
-
-- Product Requirements: `{{prd_file}}`
-- Product Brief: `{{brief_file}}`
-- Brainstorming: `{{brainstorm_file}}`
-
-### Core Interactive Deliverables
-
-This UX Design Specification was created through visual collaboration:
-
-- **Color Theme Visualizer**: {{color_themes_html}}
-  - Interactive HTML showing all color theme options explored
-  - Live UI component examples in each theme
-  - Side-by-side comparison and semantic color usage
-
-- **Design Direction Mockups**: {{design_directions_html}}
-  - Interactive HTML with 6-8 complete design approaches
-  - Full-screen mockups of key screens
-  - Design philosophy and rationale for each direction
-
-### Optional Enhancement Deliverables
-
-_This section will be populated if additional UX artifacts are generated through follow-up workflows._
-
-<!-- Additional deliverables added here by other workflows -->
-
-### Next Steps & Follow-Up Workflows
-
-This UX Design Specification can serve as input to:
-
-- **Wireframe Generation Workflow** - Create detailed wireframes from user flows
-- **Figma Design Workflow** - Generate Figma files via MCP integration
-- **Interactive Prototype Workflow** - Build clickable HTML prototypes
-- **Component Showcase Workflow** - Create interactive component library
-- **AI Frontend Prompt Workflow** - Generate prompts for v0, Lovable, Bolt, etc.
-- **Solution Architecture Workflow** - Define technical architecture with UX context
-
-### Version History
+# UX Design Specification {{project_name}}
 
-| Date     | Version | Changes                         | Author        |
-| -------- | ------- | ------------------------------- | ------------- |
-| {{date}} | 1.0     | Initial UX Design Specification | {{user_name}} |
+**Author:** {{user_name}}
+**Date:** {{date}}
 
 ---
 
-_This UX Design Specification was created through collaborative design facilitation, not template generation. All decisions were made with user input and are documented with rationale._
+<!-- UX design content will be appended sequentially through collaborative workflow steps -->

package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md

@@ -0,0 +1,57 @@
+---
+name: create-ux-design
+description: Work with a peer UX Design expert to plan your applications UX patterns, look and feel.
+web_bundle: true
+---
+
+# Create UX Design Workflow
+
+**Goal:** Create comprehensive UX design specifications through collaborative visual exploration and informed decision-making where you act as a UX facilitator working with a product stakeholder.
+
+---
+
+## WORKFLOW ARCHITECTURE
+
+This uses **micro-file architecture** for disciplined execution:
+
+- Each step is a self-contained file with embedded rules
+- Sequential progression with user control at each step
+- Document state tracked in frontmatter
+- Append-only document building through conversation
+
+---
+
+## INITIALIZATION
+
+### Configuration Loading
+
+Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
+
+- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
+- `communication_language`, `document_output_language`, `user_skill_level`
+- `date` as system-generated current datetime
+
+### Paths
+
+- `installed_path` = `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design`
+- `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.

package/src/modules/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv

@@ -0,0 +1,13 @@
+domain,signals,complexity,key_concerns,required_knowledge,suggested_workflow,web_searches,special_sections
+healthcare,"medical,diagnostic,clinical,FDA,patient,treatment,HIPAA,therapy,pharma,drug",high,"FDA approval;Clinical validation;HIPAA compliance;Patient safety;Medical device classification;Liability","Regulatory pathways;Clinical trial design;Medical standards;Data privacy;Integration requirements","domain-research","FDA software medical device guidance {date};HIPAA compliance software requirements;Medical software standards {date};Clinical validation software","clinical_requirements;regulatory_pathway;validation_methodology;safety_measures"
+fintech,"payment,banking,trading,investment,crypto,wallet,transaction,KYC,AML,funds,fintech",high,"Regional compliance;Security standards;Audit requirements;Fraud prevention;Data protection","KYC/AML requirements;PCI DSS;Open banking;Regional laws (US/EU/APAC);Crypto regulations","domain-research","fintech regulations {date};payment processing compliance {date};open banking API standards;cryptocurrency regulations {date}","compliance_matrix;security_architecture;audit_requirements;fraud_prevention"
+govtech,"government,federal,civic,public sector,citizen,municipal,voting",high,"Procurement rules;Security clearance;Accessibility (508);FedRAMP;Privacy;Transparency","Government procurement;Security frameworks;Accessibility standards;Privacy laws;Open data requirements","domain-research","government software procurement {date};FedRAMP compliance requirements;section 508 accessibility;government security standards","procurement_compliance;security_clearance;accessibility_standards;transparency_requirements"
+edtech,"education,learning,student,teacher,curriculum,assessment,K-12,university,LMS",medium,"Student privacy (COPPA/FERPA);Accessibility;Content moderation;Age verification;Curriculum standards","Educational privacy laws;Learning standards;Accessibility requirements;Content guidelines;Assessment validity","domain-research","educational software privacy {date};COPPA FERPA compliance;WCAG education requirements;learning management standards","privacy_compliance;content_guidelines;accessibility_features;curriculum_alignment"
+aerospace,"aircraft,spacecraft,aviation,drone,satellite,propulsion,flight,radar,navigation",high,"Safety certification;DO-178C compliance;Performance validation;Simulation accuracy;Export controls","Aviation standards;Safety analysis;Simulation validation;ITAR/export controls;Performance requirements","domain-research + technical-model","DO-178C software certification;aerospace simulation standards {date};ITAR export controls software;aviation safety requirements","safety_certification;simulation_validation;performance_requirements;export_compliance"
+automotive,"vehicle,car,autonomous,ADAS,automotive,driving,EV,charging",high,"Safety standards;ISO 26262;V2X communication;Real-time requirements;Certification","Automotive standards;Functional safety;V2X protocols;Real-time systems;Testing requirements","domain-research","ISO 26262 automotive software;automotive safety standards {date};V2X communication protocols;EV charging standards","safety_standards;functional_safety;communication_protocols;certification_requirements"
+scientific,"research,algorithm,simulation,modeling,computational,analysis,data science,ML,AI",medium,"Reproducibility;Validation methodology;Peer review;Performance;Accuracy;Computational resources","Scientific method;Statistical validity;Computational requirements;Domain expertise;Publication standards","technical-model","scientific computing best practices {date};research reproducibility standards;computational modeling validation;peer review software","validation_methodology;accuracy_metrics;reproducibility_plan;computational_requirements"
+legaltech,"legal,law,contract,compliance,litigation,patent,attorney,court",high,"Legal ethics;Bar regulations;Data retention;Attorney-client privilege;Court system integration","Legal practice rules;Ethics requirements;Court filing systems;Document standards;Confidentiality","domain-research","legal technology ethics {date};law practice management software requirements;court filing system standards;attorney client privilege technology","ethics_compliance;data_retention;confidentiality_measures;court_integration"
+insuretech,"insurance,claims,underwriting,actuarial,policy,risk,premium",high,"Insurance regulations;Actuarial standards;Data privacy;Fraud detection;State compliance","Insurance regulations by state;Actuarial methods;Risk modeling;Claims processing;Regulatory reporting","domain-research","insurance software regulations {date};actuarial standards software;insurance fraud detection;state insurance compliance","regulatory_requirements;risk_modeling;fraud_detection;reporting_compliance"
+energy,"energy,utility,grid,solar,wind,power,electricity,oil,gas",high,"Grid compliance;NERC standards;Environmental regulations;Safety requirements;Real-time operations","Energy regulations;Grid standards;Environmental compliance;Safety protocols;SCADA systems","domain-research","energy sector software compliance {date};NERC CIP standards;smart grid requirements;renewable energy software standards","grid_compliance;safety_protocols;environmental_compliance;operational_requirements"
+gaming,"game,player,gameplay,level,character,multiplayer,quest",redirect,"REDIRECT TO GAME WORKFLOWS","Game design","game-brief","NA","NA"
+general,"",low,"Standard requirements;Basic security;User experience;Performance","General software practices","continue","software development best practices {date}","standard_requirements"

package/src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md

@@ -1,62 +1,16 @@
-# {{project_name}} Product Requirements Document (PRD)
-
-**Author:** {{user_name}}
-**Date:** {{date}}
-**Project Level:** {{project_level}}
-**Target Scale:** {{target_scale}}
-
----
-
-## Goals and Background Context
-
-### Goals
-
-{{goals}}
-
-### Background Context
-
-{{background_context}}
-
----
-
-## Requirements
-
-### Functional Requirements
-
-{{functional_requirements}}
-
-### Non-Functional Requirements
-
-{{non_functional_requirements}}
-
 ---
-
-## User Journeys
-
-{{user_journeys}}
-
----
-
-## UX Design Principles
-
-{{ux_principles}}
-
----
-
-## User Interface Design Goals
-
-{{ui_design_goals}}
-
+stepsCompleted: []
+inputDocuments: []
+documentCounts:
+  briefs: 0
+  research: 0
+  brainstorming: 0
+  projectDocs: 0
+workflowType: 'prd'
+lastStep: 0
 ---
 
-## Epic List
-
-{{epic_list}}
+# Product Requirements Document - {{project_name}}
 
-> **Note:** Detailed epic breakdown with full story specifications is available in [epics.md](./epics.md)
-
----
-
-## Out of Scope
-
-{{out_of_scope}}
+**Author:** {{user_name}}
+**Date:** {{date}}

package/src/modules/bmm/workflows/2-plan-workflows/prd/project-types.csv

@@ -0,0 +1,11 @@
+project_type,detection_signals,key_questions,required_sections,skip_sections,web_search_triggers,innovation_signals
+api_backend,"API,REST,GraphQL,backend,service,endpoints","Endpoints needed?;Authentication method?;Data formats?;Rate limits?;Versioning?;SDK needed?","endpoint_specs;auth_model;data_schemas;error_codes;rate_limits;api_docs","ux_ui;visual_design;user_journeys","framework best practices;OpenAPI standards","API composition;New protocol"
+mobile_app,"iOS,Android,app,mobile,iPhone,iPad","Native or cross-platform?;Offline needed?;Push notifications?;Device features?;Store compliance?","platform_reqs;device_permissions;offline_mode;push_strategy;store_compliance","desktop_features;cli_commands","app store guidelines;platform requirements","Gesture innovation;AR/VR features"
+saas_b2b,"SaaS,B2B,platform,dashboard,teams,enterprise","Multi-tenant?;Permission model?;Subscription tiers?;Integrations?;Compliance?","tenant_model;rbac_matrix;subscription_tiers;integration_list;compliance_reqs","cli_interface;mobile_first","compliance requirements;integration guides","Workflow automation;AI agents"
+developer_tool,"SDK,library,package,npm,pip,framework","Language support?;Package managers?;IDE integration?;Documentation?;Examples?","language_matrix;installation_methods;api_surface;code_examples;migration_guide","visual_design;store_compliance","package manager best practices;API design patterns","New paradigm;DSL creation"
+cli_tool,"CLI,command,terminal,bash,script","Interactive or scriptable?;Output formats?;Config method?;Shell completion?","command_structure;output_formats;config_schema;scripting_support","visual_design;ux_principles;touch_interactions","CLI design patterns;shell integration","Natural language CLI;AI commands"
+web_app,"website,webapp,browser,SPA,PWA","SPA or MPA?;Browser support?;SEO needed?;Real-time?;Accessibility?","browser_matrix;responsive_design;performance_targets;seo_strategy;accessibility_level","native_features;cli_commands","web standards;WCAG guidelines","New interaction;WebAssembly use"
+game,"game,player,gameplay,level,character","REDIRECT TO USE THE BMad Method Game Module Agent and Workflows - HALT","game-brief;GDD","most_sections","game design patterns","Novel mechanics;Genre mixing"
+desktop_app,"desktop,Windows,Mac,Linux,native","Cross-platform?;Auto-update?;System integration?;Offline?","platform_support;system_integration;update_strategy;offline_capabilities","web_seo;mobile_features","desktop guidelines;platform requirements","Desktop AI;System automation"
+iot_embedded,"IoT,embedded,device,sensor,hardware","Hardware specs?;Connectivity?;Power constraints?;Security?;OTA updates?","hardware_reqs;connectivity_protocol;power_profile;security_model;update_mechanism","visual_ui;browser_support","IoT standards;protocol specs","Edge AI;New sensors"
+blockchain_web3,"blockchain,crypto,DeFi,NFT,smart contract","Chain selection?;Wallet integration?;Gas optimization?;Security audit?","chain_specs;wallet_support;smart_contracts;security_audit;gas_optimization","traditional_auth;centralized_db","blockchain standards;security patterns","Novel tokenomics;DAO structure"