bmad-method 5.1.3 → 6.0.0-Beta.1

package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-04-complete.md

@@ -0,0 +1,168 @@
+---
+name: 'step-e-04-complete'
+description: 'Complete & Validate - Present options for next steps including full validation'
+
+# File references (ONLY variables used in this step)
+prdFile: '{prd_file_path}'
+validationWorkflow: './steps-v/step-v-01-discovery.md'
+---
+
+# Step E-4: Complete & Validate
+
+## STEP GOAL:
+
+Present summary of completed edits and offer next steps including seamless integration with validation workflow.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 ALWAYS generate content WITH user input/approval
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a Validation Architect and PRD Improvement Specialist
+- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring synthesis and summary expertise
+- ✅ User chooses next actions
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on presenting summary and options
+- 🚫 FORBIDDEN to make additional changes
+- 💬 Approach: Clear, concise summary with actionable options
+- 🚪 This is the final edit step - no more edits
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Compile summary of all changes made
+- 🎯 Present options clearly with expected outcomes
+- 📖 Route to validation if user chooses
+- 🚫 FORBIDDEN to proceed without user selection
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Updated PRD file, edit history from step e-03
+- Focus: Summary and options only (no more editing)
+- Limits: Don't make changes, just present options
+- Dependencies: Step e-03 completed - all edits applied
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Compile Edit Summary
+
+From step e-03 change execution, compile:
+
+**Changes Made:**
+- Sections added: {list with names}
+- Sections updated: {list with names}
+- Content removed: {list}
+- Structure changes: {description}
+
+**Edit Details:**
+- Total sections affected: {count}
+- Mode: {restructure/targeted/both}
+- Priority addressed: {Critical/High/Medium/Low}
+
+**PRD Status:**
+- Format: {BMAD Standard / BMAD Variant / Legacy (converted)}
+- Completeness: {assessment}
+- Ready for: {downstream use cases}
+
+### 2. Present Completion Summary
+
+Display:
+
+"**✓ PRD Edit Complete**
+
+**Updated PRD:** {prd_file_path}
+
+**Changes Summary:**
+{Present bulleted list of major changes}
+
+**Edit Mode:** {mode}
+**Sections Modified:** {count}
+
+**PRD Format:** {format}
+
+**PRD is now ready for:**
+- Downstream workflows (UX Design, Architecture)
+- Validation to ensure quality
+- Production use
+
+**What would you like to do next?**"
+
+### 3. Present MENU OPTIONS
+
+Display:
+
+**[V] Run Full Validation** - Execute complete validation workflow (steps-v) to verify PRD quality
+**[E] Edit More** - Make additional edits to the PRD
+**[S] Summary** - End with detailed summary of changes
+**[X] Exit** - Exit edit workflow
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- Only proceed based on user selection
+
+#### Menu Handling Logic:
+
+- **IF V (Run Full Validation):**
+  - Display: "**Starting Validation Workflow**"
+  - Display: "This will run all 13 validation checks on the updated PRD."
+  - Display: "Preparing to validate: {prd_file_path}"
+  - Display: "**Proceeding to validation...**"
+  - Read fully and follow: {validationWorkflow} (steps-v/step-v-01-discovery.md)
+  - Note: This hands off to the validation workflow which will run its complete 13-step process
+
+- **IF E (Edit More):**
+  - Display: "**Additional Edits**"
+  - Ask: "What additional edits would you like to make?"
+  - Accept input, then display: "**Returning to edit step...**"
+  - Read fully and follow: step-e-03-edit.md again
+
+- **IF S (Summary):**
+  - Display detailed summary including:
+    - Complete list of all changes made
+    - Before/after comparison (key improvements)
+    - Recommendations for next steps
+  - Display: "**Edit Workflow Complete**"
+  - Exit
+
+- **IF X (Exit):**
+  - Display summary
+  - Display: "**Edit Workflow Complete**"
+  - Exit
+
+- **IF Any other:** Help user, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Complete edit summary compiled accurately
+- All changes clearly documented
+- Options presented with clear expectations
+- Validation option seamlessly integrates with steps-v workflow
+- User can validate, edit more, or exit
+- Clean handoff to validation workflow (if chosen)
+- Edit workflow completes properly
+
+### ❌ SYSTEM FAILURE:
+
+- Missing changes in summary
+- Not offering validation option
+- Not documenting completion properly
+- No clear handoff to validation workflow
+
+**Master Rule:** Edit workflow seamlessly integrates with validation. User can edit → validate → edit again → validate again in iterative improvement cycle.

package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md

@@ -0,0 +1,218 @@
+---
+name: 'step-v-01-discovery'
+description: 'Document Discovery & Confirmation - Handle fresh context validation, confirm PRD path, discover input documents'
+
+# File references (ONLY variables used in this step)
+nextStepFile: './step-v-02-format-detection.md'
+advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
+prdPurpose: '../data/prd-purpose.md'
+---
+
+# Step 1: Document Discovery & Confirmation
+
+## STEP GOAL:
+
+Handle fresh context validation by confirming PRD path, discovering and loading input documents from frontmatter, and initializing the validation report.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a Validation Architect and Quality Assurance Specialist
+- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring systematic validation expertise and analytical rigor
+- ✅ User brings domain knowledge and specific PRD context
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on discovering PRD and input documents, not validating yet
+- 🚫 FORBIDDEN to perform any validation checks in this step
+- 💬 Approach: Systematic discovery with clear reporting to user
+- 🚪 This is the setup step - get everything ready for validation
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Discover and confirm PRD to validate
+- 💾 Load PRD and all input documents from frontmatter
+- 📖 Initialize validation report next to PRD
+- 🚫 FORBIDDEN to load next step until user confirms setup
+
+## CONTEXT BOUNDARIES:
+
+- Available context: PRD path (user-specified or discovered), workflow configuration
+- Focus: Document discovery and setup only
+- Limits: Don't perform validation, don't skip discovery
+- Dependencies: Configuration loaded from PRD workflow.md initialization
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Load PRD Purpose and Standards
+
+Load and read the complete file at:
+`{prdPurpose}`
+
+This file contains the BMAD PRD philosophy, standards, and validation criteria that will guide all validation checks. Internalize this understanding - it defines what makes a great BMAD PRD.
+
+### 2. Discover PRD to Validate
+
+**If PRD path provided as invocation parameter:**
+- Use provided path
+
+**If no PRD path provided:**
+"**PRD Validation Workflow**
+
+Which PRD would you like to validate?
+
+Please provide the path to the PRD file you want to validate."
+
+**Wait for user to provide PRD path.**
+
+### 3. Validate PRD Exists and Load
+
+Once PRD path is provided:
+
+- Check if PRD file exists at specified path
+- If not found: "I cannot find a PRD at that path. Please check the path and try again."
+- If found: Load the complete PRD file including frontmatter
+
+### 4. Extract Frontmatter and Input Documents
+
+From the loaded PRD frontmatter, extract:
+
+- `inputDocuments: []` array (if present)
+- Any other relevant metadata (classification, date, etc.)
+
+**If no inputDocuments array exists:**
+Note this and proceed with PRD-only validation
+
+### 5. Load Input Documents
+
+For each document listed in `inputDocuments`:
+
+- Attempt to load the document
+- Track successfully loaded documents
+- Note any documents that fail to load
+
+**Build list of loaded input documents:**
+- Product Brief (if present)
+- Research documents (if present)
+- Other reference materials (if present)
+
+### 6. Ask About Additional Reference Documents
+
+"**I've loaded the following documents from your PRD frontmatter:**
+
+{list loaded documents with file names}
+
+**Are there any additional reference documents you'd like me to include in this validation?**
+
+These could include:
+- Additional research or context documents
+- Project documentation not tracked in frontmatter
+- Standards or compliance documents
+- Competitive analysis or benchmarks
+
+Please provide paths to any additional documents, or type 'none' to proceed."
+
+**Load any additional documents provided by user.**
+
+### 7. Initialize Validation Report
+
+Create validation report at: `{validationReportPath}`
+
+**Initialize with frontmatter:**
+```yaml
+---
+validationTarget: '{prd_path}'
+validationDate: '{current_date}'
+inputDocuments: [list of all loaded documents]
+validationStepsCompleted: []
+validationStatus: IN_PROGRESS
+---
+```
+
+**Initial content:**
+```markdown
+# PRD Validation Report
+
+**PRD Being Validated:** {prd_path}
+**Validation Date:** {current_date}
+
+## Input Documents
+
+{list all documents loaded for validation}
+
+## Validation Findings
+
+[Findings will be appended as validation progresses]
+```
+
+### 8. Present Discovery Summary
+
+"**Setup Complete!**
+
+**PRD to Validate:** {prd_path}
+
+**Input Documents Loaded:**
+- PRD: {prd_name} ✓
+- Product Brief: {count} {if count > 0}✓{else}(none found){/if}
+- Research: {count} {if count > 0}✓{else}(none found){/if}
+- Additional References: {count} {if count > 0}✓{else}(none){/if}
+
+**Validation Report:** {validationReportPath}
+
+**Ready to begin validation.**"
+
+### 9. Present MENU OPTIONS
+
+Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Format Detection
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- User can ask questions or add more documents - always respond and redisplay menu
+
+#### Menu Handling Logic:
+
+- IF A: Read fully and follow: {advancedElicitationTask}, and when finished redisplay the menu
+- IF P: Read fully and follow: {partyModeWorkflow}, and when finished redisplay the menu
+- IF C: Read fully and follow: {nextStepFile} to begin format detection
+- IF user provides additional document: Load it, update report, redisplay summary
+- IF Any other: help user, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- PRD path discovered and confirmed
+- PRD file exists and loads successfully
+- All input documents from frontmatter loaded
+- Additional reference documents (if any) loaded
+- Validation report initialized next to PRD
+- User clearly informed of setup status
+- Menu presented and user input handled correctly
+
+### ❌ SYSTEM FAILURE:
+
+- Proceeding with non-existent PRD file
+- Not loading input documents from frontmatter
+- Creating validation report in wrong location
+- Proceeding without user confirming setup
+- Not handling missing input documents gracefully
+
+**Master Rule:** Complete discovery and setup BEFORE validation. This step ensures everything is in place for systematic validation checks.

package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02-format-detection.md

@@ -0,0 +1,191 @@
+---
+name: 'step-v-02-format-detection'
+description: 'Format Detection & Structure Analysis - Classify PRD format and route appropriately'
+
+# File references (ONLY variables used in this step)
+nextStepFile: './step-v-03-density-validation.md'
+altStepFile: './step-v-02b-parity-check.md'
+prdFile: '{prd_file_path}'
+validationReportPath: '{validation_report_path}'
+---
+
+# Step 2: Format Detection & Structure Analysis
+
+## STEP GOAL:
+
+Detect if PRD follows BMAD format and route appropriately - classify as BMAD Standard / BMAD Variant / Non-Standard, with optional parity check for non-standard formats.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a Validation Architect and Quality Assurance Specialist
+- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring systematic validation expertise and pattern recognition
+- ✅ User brings domain knowledge and PRD context
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on detecting format and classifying structure
+- 🚫 FORBIDDEN to perform other validation checks in this step
+- 💬 Approach: Analytical and systematic, clear reporting of findings
+- 🚪 This is a branch step - may route to parity check for non-standard PRDs
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Analyze PRD structure systematically
+- 💾 Append format findings to validation report
+- 📖 Route appropriately based on format classification
+- 🚫 FORBIDDEN to skip format detection or proceed without classification
+
+## CONTEXT BOUNDARIES:
+
+- Available context: PRD file loaded in step 1, validation report initialized
+- Focus: Format detection and classification only
+- Limits: Don't perform other validation, don't skip classification
+- Dependencies: Step 1 completed - PRD loaded and report initialized
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Extract PRD Structure
+
+Load the complete PRD file and extract:
+
+**All Level 2 (##) headers:**
+- Scan through entire PRD document
+- Extract all ## section headers
+- List them in order
+
+**PRD frontmatter:**
+- Extract classification.domain if present
+- Extract classification.projectType if present
+- Note any other relevant metadata
+
+### 2. Check for BMAD PRD Core Sections
+
+Check if the PRD contains the following BMAD PRD core sections:
+
+1. **Executive Summary** (or variations: ## Executive Summary, ## Overview, ## Introduction)
+2. **Success Criteria** (or: ## Success Criteria, ## Goals, ## Objectives)
+3. **Product Scope** (or: ## Product Scope, ## Scope, ## In Scope, ## Out of Scope)
+4. **User Journeys** (or: ## User Journeys, ## User Stories, ## User Flows)
+5. **Functional Requirements** (or: ## Functional Requirements, ## Features, ## Capabilities)
+6. **Non-Functional Requirements** (or: ## Non-Functional Requirements, ## NFRs, ## Quality Attributes)
+
+**Count matches:**
+- How many of these 6 core sections are present?
+- Which specific sections are present?
+- Which are missing?
+
+### 3. Classify PRD Format
+
+Based on core section count, classify:
+
+**BMAD Standard:**
+- 5-6 core sections present
+- Follows BMAD PRD structure closely
+
+**BMAD Variant:**
+- 3-4 core sections present
+- Generally follows BMAD patterns but may have structural differences
+- Missing some sections but recognizable as BMAD-style
+
+**Non-Standard:**
+- Fewer than 3 core sections present
+- Does not follow BMAD PRD structure
+- May be completely custom format, legacy format, or from another framework
+
+### 4. Report Format Findings to Validation Report
+
+Append to validation report:
+
+```markdown
+## Format Detection
+
+**PRD Structure:**
+[List all ## Level 2 headers found]
+
+**BMAD Core Sections Present:**
+- Executive Summary: [Present/Missing]
+- Success Criteria: [Present/Missing]
+- Product Scope: [Present/Missing]
+- User Journeys: [Present/Missing]
+- Functional Requirements: [Present/Missing]
+- Non-Functional Requirements: [Present/Missing]
+
+**Format Classification:** [BMAD Standard / BMAD Variant / Non-Standard]
+**Core Sections Present:** [count]/6
+```
+
+### 5. Route Based on Format Classification
+
+**IF format is BMAD Standard or BMAD Variant:**
+
+Display: "**Format Detected:** {classification}
+
+Proceeding to systematic validation checks..."
+
+Without delay, read fully and follow: {nextStepFile} (step-v-03-density-validation.md)
+
+**IF format is Non-Standard (< 3 core sections):**
+
+Display: "**Format Detected:** Non-Standard PRD
+
+This PRD does not follow BMAD standard structure (only {count}/6 core sections present).
+
+You have options:"
+
+Present MENU OPTIONS below for user selection
+
+### 6. Present MENU OPTIONS (Non-Standard PRDs Only)
+
+**[A] Parity Check** - Analyze gaps and estimate effort to reach BMAD PRD parity
+**[B] Validate As-Is** - Proceed with validation using current structure
+**[C] Exit** - Exit validation and review format findings
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- Only proceed based on user selection
+
+#### Menu Handling Logic:
+
+- IF A (Parity Check): Read fully and follow: {altStepFile} (step-v-02b-parity-check.md)
+- IF B (Validate As-Is): Display "Proceeding with validation..." then read fully and follow: {nextStepFile}
+- IF C (Exit): Display format findings summary and exit validation
+- IF Any other: help user respond, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All ## Level 2 headers extracted successfully
+- BMAD core sections checked systematically
+- Format classified correctly based on section count
+- Findings reported to validation report
+- BMAD Standard/Variant PRDs proceed directly to next validation step
+- Non-Standard PRDs pause and present options to user
+- User can choose parity check, validate as-is, or exit
+
+### ❌ SYSTEM FAILURE:
+
+- Not extracting all headers before classification
+- Incorrect format classification
+- Not reporting findings to validation report
+- Not pausing for non-standard PRDs
+- Proceeding without user decision for non-standard formats
+
+**Master Rule:** Format detection determines validation path. Non-standard PRDs require user choice before proceeding.