bmad-method 6.0.0-alpha.22 → 6.0.0-alpha.23

package/src/modules/bmm/workflows/2-plan-workflows/prd/{steps → steps-c}/step-09-functional.md

@@ -2,13 +2,8 @@
 name: 'step-09-functional'
 description: 'Synthesize all discovery into comprehensive functional requirements'
 
-# Path Definitions
-workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
-
 # File References
-thisStepFile: '{workflow_path}/steps/step-09-functional.md'
-nextStepFile: '{workflow_path}/steps/step-10-nonfunctional.md'
-workflowFile: '{workflow_path}/workflow.md'
+nextStepFile: './step-10-nonfunctional.md'
 outputFile: '{planning_artifacts}/prd.md'
 
 # Task References
@@ -37,23 +32,9 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
 - 🎯 Show your analysis before taking any action
 - ⚠️ Present A/P/C menu after generating functional requirements
 - 💾 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 name to the end of the list of stepsCompleted
 - 🚫 FORBIDDEN to load next step until C is selected
 
-## COLLABORATION MENUS (A/P/C):
-
-This step will generate content and present choices:
-
-- **A (Advanced Elicitation)**: Use discovery protocols to ensure comprehensive requirement coverage
-- **P (Party Mode)**: Bring multiple perspectives to validate complete requirement set
-- **C (Continue)**: Save the content to the document and proceed to next step
-
-## PROTOCOL INTEGRATION:
-
-- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
-- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
-- PROTOCOLS always return to this step's A/P/C menu
-- User accepts/rejects protocol changes before proceeding
 
 ## CONTEXT BOUNDARIES:
 
@@ -186,49 +167,29 @@ When saving to document, append these Level 2 and Level 3 sections:
 [Continue for all capability areas discovered in conversation]
 ```
 
-### 7. Present Content and Menu
-
-Show the generated functional requirements and present choices:
-"I've synthesized all our discussions into comprehensive functional requirements. This becomes the capability contract that UX designers, architects, and developers will all work from.
-
-**Here's what I'll add to the document:**
-
-[Show the complete FR list from step 6]
-
-**This is critical because:**
-
-- Every feature we build must trace back to one of these requirements
-- UX designers will ONLY design interactions for these capabilities
-- Architects will ONLY build systems to support these capabilities
-
-**What would you like to do?**
-[A] Advanced Elicitation - Let's ensure we haven't missed any capabilities
-[P] Party Mode - Bring different perspectives to validate complete coverage
-[C] Continue - Save this and move to Non-Functional Requirements (Step 10 of 11)"
-
-### 8. Handle Menu Selection
-
-#### If 'A' (Advanced Elicitation):
+### 7. Present MENU OPTIONS
 
-- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current FR list
-- Process the enhanced capability coverage that comes back
-- Ask user: "Accept these additions to the functional requirements? (y/n)"
-- If yes: Update content with improvements, then return to A/P/C menu
-- If no: Keep original content, then return to A/P/C menu
+Present the functional requirements for review, then display menu:
+- Show synthesized functional requirements (using structure from step 6)
+- Emphasize this is the capability contract for all downstream work
+- Highlight that every feature must trace back to these requirements
+- Ask if they'd like to refine further, get other perspectives, or proceed
+- Present menu options naturally as part of conversation
 
-#### If 'P' (Party Mode):
+**What would you like to do?**"
 
-- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current FR list
-- Process the collaborative capability validation and additions
-- Ask user: "Accept these changes to the functional requirements? (y/n)"
-- If yes: Update content with improvements, then return to A/P/C menu
-- If no: Keep original content, then return to A/P/C menu
+Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Non-Functional Requirements (Step 10 of 11)"
 
-#### If 'C' (Continue):
+#### Menu Handling Logic:
+- IF A: Execute {advancedElicitationTask} with the current FR list, process the enhanced capability coverage that comes back, ask user if they accept the additions, if yes update content then redisplay menu, if no keep original content then redisplay menu
+- IF P: Execute {partyModeWorkflow} with the current FR list, process the collaborative capability validation and additions, ask user if they accept the changes, if yes update content then redisplay menu, if no keep original content then redisplay menu
+- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile}
+- IF Any other: help user respond, then redisplay menu
 
-- Append the final content to `{outputFile}`
-- Update frontmatter: add this step name to the end of the steps completed array
-- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md`
+#### EXECUTION RULES:
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu
 
 ## APPEND TO DOCUMENT:
 
@@ -265,6 +226,6 @@ Emphasize to user: "This FR list is now binding. Any feature not listed here wil
 
 ## NEXT STEP:
 
-After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md` to define non-functional requirements.
+After user selects 'C' and content is saved to document, load {nextStepFile} to define non-functional requirements.
 
 Remember: Do NOT proceed to step-10 until user explicitly selects 'C' from the A/P/C menu and content is saved!

package/src/modules/bmm/workflows/2-plan-workflows/prd/{steps → steps-c}/step-10-nonfunctional.md

@@ -2,13 +2,8 @@
 name: 'step-10-nonfunctional'
 description: 'Define quality attributes that matter for this specific product'
 
-# Path Definitions
-workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd'
-
 # File References
-thisStepFile: '{workflow_path}/steps/step-10-nonfunctional.md'
-nextStepFile: '{workflow_path}/steps/step-11-complete.md'
-workflowFile: '{workflow_path}/workflow.md'
+nextStepFile: './step-11-polish.md'
 outputFile: '{planning_artifacts}/prd.md'
 
 # Task References
@@ -18,7 +13,7 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
 
 # Step 10: Non-Functional Requirements
 
-**Progress: Step 10 of 11** - Next: Complete PRD
+**Progress: Step 10 of 12** - Next: Polish Document
 
 ## MANDATORY EXECUTION RULES (READ FIRST):
 
@@ -37,23 +32,9 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
 - 🎯 Show your analysis before taking any action
 - ⚠️ Present A/P/C menu after generating NFR content
 - 💾 ONLY save when user chooses C (Continue)
-- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]` before loading next step
+- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted
 - 🚫 FORBIDDEN to load next step until C is selected
 
-## COLLABORATION MENUS (A/P/C):
-
-This step will generate content and present choices:
-
-- **A (Advanced Elicitation)**: Use discovery protocols to ensure comprehensive quality attributes
-- **P (Party Mode)**: Bring technical perspectives to validate NFR completeness
-- **C (Continue)**: Save the content to the document and proceed to final step
-
-## PROTOCOL INTEGRATION:
-
-- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
-- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md
-- PROTOCOLS always return to this step's A/P/C menu
-- User accepts/rejects protocol changes before proceeding
 
 ## CONTEXT BOUNDARIES:
 
@@ -97,56 +78,41 @@ For each relevant category, conduct targeted discovery:
 
 #### Performance NFRs (If relevant):
 
-"Let's talk about performance requirements for {{project_name}}.
-
-**Performance Questions:**
-
+Explore performance requirements:
 - What parts of the system need to be fast for users to be successful?
 - Are there specific response time expectations?
 - What happens if performance is slower than expected?
-- Are there concurrent user scenarios we need to support?"
+- Are there concurrent user scenarios we need to support?
 
 #### Security NFRs (If relevant):
 
-"Security is critical for products that handle sensitive information.
-
-**Security Questions:**
-
+Explore security requirements:
 - What data needs to be protected?
 - Who should have access to what?
 - What are the security risks we need to mitigate?
-- Are there compliance requirements (GDPR, HIPAA, PCI-DSS)?"
+- Are there compliance requirements (GDPR, HIPAA, PCI-DSS)?
 
 #### Scalability NFRs (If relevant):
 
-"Scalability matters if we expect growth or have variable demand.
-
-**Scalability Questions:**
-
+Explore scalability requirements:
 - How many users do we expect initially? Long-term?
 - Are there seasonal or event-based traffic spikes?
-- What happens if we exceed our capacity?"
-- What growth scenarios should we plan for?"
+- What happens if we exceed our capacity?
+- What growth scenarios should we plan for?
 
 #### Accessibility NFRs (If relevant):
 
-"Accessibility ensures the product works for users with disabilities.
-
-**Accessibility Questions:**
-
+Explore accessibility requirements:
 - Are we serving users with visual, hearing, or motor impairments?
 - Are there legal accessibility requirements (WCAG, Section 508)?
-- What accessibility features are most important for our users?"
+- What accessibility features are most important for our users?
 
 #### Integration NFRs (If relevant):
 
-"Integration requirements matter for products that connect to other systems.
-
-**Integration Questions:**
-
+Explore integration requirements:
 - What external systems do we need to connect with?
 - Are there APIs or data formats we must support?
-- How reliable do these integrations need to be?"
+- How reliable do these integrations need to be?
 
 ### 4. Make NFRs Specific and Measurable
 
@@ -190,45 +156,27 @@ When saving to document, append these Level 2 and Level 3 sections (only include
 [Integration requirements based on conversation - only include if relevant]
 ```
 
-### 6. Present Content and Menu
-
-Show the generated NFR content and present choices:
-"I've defined the non-functional requirements that specify how well {{project_name}} needs to perform. I've only included categories that actually matter for this product.
-
-**Here's what I'll add to the document:**
-
-[Show the complete NFR content from step 5]
-
-**Note:** We've skipped categories that don't apply to avoid unnecessary requirements.
-
-**What would you like to do?**
-[A] Advanced Elicitation - Let's ensure we haven't missed critical quality attributes
-[P] Party Mode - Bring technical perspectives to validate NFR specifications
-[C] Continue - Save this and move to Complete PRD (Step 11 of 11)"
-
-### 7. Handle Menu Selection
-
-#### If 'A' (Advanced Elicitation):
-
-- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current NFR content
-- Process the enhanced quality attribute insights that come back
-- Ask user: "Accept these improvements to the non-functional requirements? (y/n)"
-- If yes: Update content with improvements, then return to A/P/C menu
-- If no: Keep original content, then return to A/P/C menu
+### 6. Present MENU OPTIONS
 
-#### If 'P' (Party Mode):
+Present the non-functional requirements for review, then display menu:
+- Show defined NFRs (using structure from step 5)
+- Note that only relevant categories were included
+- Emphasize NFRs specify how well the system needs to perform
+- Ask if they'd like to refine further, get other perspectives, or proceed
+- Present menu options naturally as part of conversation
 
-- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current NFR list
-- Process the collaborative technical validation and additions
-- Ask user: "Accept these changes to the non-functional requirements? (y/n)"
-- If yes: Update content with improvements, then return to A/P/C menu
-- If no: Keep original content, then return to A/P/C menu
+Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Polish Document (Step 11 of 12)"
 
-#### If 'C' (Continue):
+#### Menu Handling Logic:
+- IF A: Execute {advancedElicitationTask} with the current NFR content, process the enhanced quality attribute insights that come back, ask user if they accept the improvements, if yes update content then redisplay menu, if no keep original content then redisplay menu
+- IF P: Execute {partyModeWorkflow} with the current NFR list, process the collaborative technical validation and additions, ask user if they accept the changes, if yes update content then redisplay menu, if no keep original content then redisplay menu
+- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile}
+- IF Any other: help user respond, then redisplay menu
 
-- Append the final content to `{outputFile}`
-- Update frontmatter: add this step name to the end of the steps completed array
-- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md`
+#### EXECUTION RULES:
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu
 
 ## APPEND TO DOCUMENT:
 
@@ -289,6 +237,6 @@ When user selects 'C', append the content directly to the document using the str
 
 ## NEXT STEP:
 
-After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md` to finalize the PRD and complete the workflow.
+After user selects 'C' and content is saved to document, load {nextStepFile} to finalize the PRD and complete the workflow.
 
 Remember: Do NOT proceed to step-11 until user explicitly selects 'C' from the A/P/C menu and content is saved!

package/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md

@@ -0,0 +1,217 @@
+---
+name: 'step-11-polish'
+description: 'Optimize and polish the complete PRD document for flow, coherence, and readability'
+
+# File References
+nextStepFile: './step-12-complete.md'
+outputFile: '{planning_artifacts}/prd.md'
+purposeFile: './data/prd-purpose.md'
+
+# Task References
+advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
+---
+
+# Step 11: Document Polish
+
+**Progress: Step 11 of 12** - Next: Complete PRD
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+- 🛑 CRITICAL: Load the ENTIRE document before making changes
+- 📖 CRITICAL: Read complete step file before taking action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- ✅ This is a POLISH step - optimize existing content
+- 📋 IMPROVE flow, coherence, and readability
+- 💬 PRESERVE user's voice and intent
+- 🎯 MAINTAIN all essential information while improving presentation
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load complete document first
+- 📝 Review for flow and coherence issues
+- ✂️ Reduce duplication while preserving essential info
+- 📖 Ensure proper ## Level 2 headers throughout
+- 💾 Save optimized document
+- ⚠️ Present A/P/C menu after polish
+- 🚫 DO NOT skip review steps
+
+## CONTEXT BOUNDARIES:
+
+- Complete PRD document exists from all previous steps
+- Document may have duplication from progressive append
+- Sections may not flow smoothly together
+- Level 2 headers ensure document can be split if needed
+- Focus on readability and coherence
+
+## YOUR TASK:
+
+Optimize the complete PRD document for flow, coherence, and professional presentation while preserving all essential information.
+
+## DOCUMENT POLISH SEQUENCE:
+
+### 1. Load Context and Document
+
+**CRITICAL:** Load the PRD purpose document first:
+
+- Read `{purposeFile}` to understand what makes a great BMAD PRD
+- Internalize the philosophy: information density, traceability, measurable requirements
+- Keep the dual-audience nature (humans + LLMs) in mind
+
+**Then Load the PRD Document:**
+
+- Read `{outputFile}` completely from start to finish
+- Understand the full document structure and content
+- Identify all sections and their relationships
+- Note areas that need attention
+
+### 2. Document Quality Review
+
+Review the entire document with PRD purpose principles in mind:
+
+**Information Density:**
+- Are there wordy phrases that can be condensed?
+- Is conversational padding present?
+- Can sentences be more direct and concise?
+
+**Flow and Coherence:**
+- Do sections transition smoothly?
+- Are there jarring topic shifts?
+- Does the document tell a cohesive story?
+- Is the progression logical for readers?
+
+**Duplication Detection:**
+- Are ideas repeated across sections?
+- Is the same information stated multiple times?
+- Can redundant content be consolidated?
+- Are there contradictory statements?
+
+**Header Structure:**
+- Are all main sections using ## Level 2 headers?
+- Is the hierarchy consistent (##, ###, ####)?
+- Can sections be easily extracted or referenced?
+- Are headers descriptive and clear?
+
+**Readability:**
+- Are sentences clear and concise?
+- Is the language consistent throughout?
+- Are technical terms used appropriately?
+- Would stakeholders find this easy to understand?
+
+### 3. Optimization Actions
+
+Make targeted improvements:
+
+**Improve Flow:**
+- Add transition sentences between sections
+- Smooth out jarring topic shifts
+- Ensure logical progression
+- Connect related concepts across sections
+
+**Reduce Duplication:**
+- Consolidate repeated information
+- Keep content in the most appropriate section
+- Use cross-references instead of repetition
+- Remove redundant explanations
+
+**Enhance Coherence:**
+- Ensure consistent terminology throughout
+- Align all sections with product differentiator
+- Maintain consistent voice and tone
+- Verify scope consistency across sections
+
+**Optimize Headers:**
+- Ensure all main sections use ## Level 2
+- Make headers descriptive and action-oriented
+- Check that headers follow consistent patterns
+- Verify headers support document navigation
+
+### 4. Preserve Critical Information
+
+**While optimizing, ensure NOTHING essential is lost:**
+
+**Must Preserve:**
+- All user success criteria
+- All functional requirements (capability contract)
+- All user journey narratives
+- All scope decisions (MVP, Growth, Vision)
+- All non-functional requirements
+- Product differentiator and vision
+- Domain-specific requirements
+- Innovation analysis (if present)
+
+**Can Consolidate:**
+- Repeated explanations of the same concept
+- Redundant background information
+- Multiple versions of similar content
+- Overlapping examples
+
+### 5. Generate Optimized Document
+
+Create the polished version:
+
+**Polishing Process:**
+1. Start with original document
+2. Apply all optimization actions
+3. Review to ensure nothing essential was lost
+4. Verify improvements enhance readability
+5. Prepare optimized version for review
+
+### 6. Present MENU OPTIONS
+
+Present the polished document for review, then display menu:
+- Show what changed in the polish
+- Highlight improvements made (flow, duplication, headers)
+- Ask if they'd like to refine further, get other perspectives, or proceed
+- Present menu options naturally as part of conversation
+
+Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Complete PRD (Step 12 of 12)"
+
+#### Menu Handling Logic:
+- IF A: Execute {advancedElicitationTask} with the polished document, process the enhanced refinements that come back, ask user "Accept these polish improvements? (y/n)", if yes update content with improvements then redisplay menu, if no keep original polish then redisplay menu
+- IF P: Execute {partyModeWorkflow} with the polished document, process the collaborative refinements to flow and coherence, ask user "Accept these polish changes? (y/n)", if yes update content with improvements then redisplay menu, if no keep original polish then redisplay menu
+- IF C: Save the polished document to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile}
+- IF Any other: help user respond, then redisplay menu
+
+#### EXECUTION RULES:
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu
+
+## APPEND TO DOCUMENT:
+
+When user selects 'C', replace the entire document content with the polished version.
+
+## SUCCESS METRICS:
+
+✅ Complete document loaded and reviewed
+✅ Flow and coherence improved
+✅ Duplication reduced while preserving essential information
+✅ All main sections use ## Level 2 headers
+✅ Transitions between sections are smooth
+✅ User's voice and intent preserved
+✅ Document is more readable and professional
+✅ A/P/C menu presented and handled correctly
+✅ Polished document saved when C selected
+
+## FAILURE MODES:
+
+❌ Loading only partial document (leads to incomplete polish)
+❌ Removing essential information while reducing duplication
+❌ Not preserving user's voice and intent
+❌ Changing content instead of improving presentation
+❌ Not ensuring ## Level 2 headers for main sections
+❌ Making arbitrary style changes instead of coherence improvements
+❌ Not presenting A/P/C menu for user approval
+❌ Saving polished document without user selecting 'C'
+
+❌ **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 changes without complete understanding of document requirements
+
+## NEXT STEP:
+
+After user selects 'C' and polished document is saved, load `./step-12-complete.md` to complete the workflow.
+
+Remember: Do NOT proceed to step-12 until user explicitly selects 'C' from the A/P/C menu and polished document is saved!