bmad-method 6.0.0-alpha.12 → 6.0.0-alpha.13

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

@@ -1,204 +1,9 @@
-# {{project_name}} - Product Requirements Document
-
-**Author:** {{user_name}}
-**Date:** {{date}}
-**Version:** 1.0
-
----
-
-## Executive Summary
-
-{{vision_alignment}}
-
-### What Makes This Special
-
-{{product_differentiator}}
-
----
-
-## Project Classification
-
-**Technical Type:** {{project_type}}
-**Domain:** {{domain_type}}
-**Complexity:** {{complexity_level}}
-
-{{project_classification}}
-
-{{#if domain_context_summary}}
-
-### Domain Context
-
-{{domain_context_summary}}
-{{/if}}
-
 ---
-
-## Success Criteria
-
-{{success_criteria}}
-
-{{#if business_metrics}}
-
-### Business Metrics
-
-{{business_metrics}}
-{{/if}}
-
+stepsCompleted: []
+inputDocuments: []
 ---
 
-## Product Scope
-
-### MVP - Minimum Viable Product
-
-{{mvp_scope}}
-
-### Growth Features (Post-MVP)
-
-{{growth_features}}
-
-### Vision (Future)
-
-{{vision_features}}
-
----
-
-{{#if domain_considerations}}
-
-## Domain-Specific Requirements
-
-{{domain_considerations}}
-
-This section shapes all functional and non-functional requirements below.
-{{/if}}
-
----
-
-{{#if innovation_patterns}}
-
-## Innovation & Novel Patterns
-
-{{innovation_patterns}}
-
-### Validation Approach
-
-{{validation_approach}}
-{{/if}}
-
----
-
-{{#if project_type_requirements}}
-
-## {{project_type}} Specific Requirements
-
-{{project_type_requirements}}
-
-{{#if endpoint_specification}}
-
-### API Specification
-
-{{endpoint_specification}}
-{{/if}}
+# Product Requirements Document - {{project_name}}
 
-{{#if authentication_model}}
-
-### Authentication & Authorization
-
-{{authentication_model}}
-{{/if}}
-
-{{#if platform_requirements}}
-
-### Platform Support
-
-{{platform_requirements}}
-{{/if}}
-
-{{#if device_features}}
-
-### Device Capabilities
-
-{{device_features}}
-{{/if}}
-
-{{#if tenant_model}}
-
-### Multi-Tenancy Architecture
-
-{{tenant_model}}
-{{/if}}
-
-{{#if permission_matrix}}
-
-### Permissions & Roles
-
-{{permission_matrix}}
-{{/if}}
-{{/if}}
-
----
-
-{{#if ux_principles}}
-
-## User Experience Principles
-
-{{ux_principles}}
-
-### Key Interactions
-
-{{key_interactions}}
-{{/if}}
-
----
-
-## Functional Requirements
-
-{{functional_requirements_complete}}
-
----
-
-## Non-Functional Requirements
-
-{{#if performance_requirements}}
-
-### Performance
-
-{{performance_requirements}}
-{{/if}}
-
-{{#if security_requirements}}
-
-### Security
-
-{{security_requirements}}
-{{/if}}
-
-{{#if scalability_requirements}}
-
-### Scalability
-
-{{scalability_requirements}}
-{{/if}}
-
-{{#if accessibility_requirements}}
-
-### Accessibility
-
-{{accessibility_requirements}}
-{{/if}}
-
-{{#if integration_requirements}}
-
-### Integration
-
-{{integration_requirements}}
-{{/if}}
-
-{{#if no_nfrs}}
-_No specific non-functional requirements identified for this project type._
-{{/if}}
-
----
-
-_This PRD captures the essence of {{project_name}} - {{product_value_summary}}_
-
-_Created through collaborative discovery between {{user_name}} and AI facilitator._
+**Author:** {{user_name}}
+**Date:** {{date}}

package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md

@@ -0,0 +1,161 @@
+# Step 1: Workflow Initialization
+
+**Progress: Step 1 of 10** - Next: Project Discovery
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+- 🛑 NEVER generate content without user input
+
+- 📖 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
+- ✅ ALWAYS treat this as collaborative discovery between PM peers
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- 💬 FOCUS on initialization and setup only - don't look ahead to future steps
+- 🚪 DETECT existing workflow state and handle continuation properly
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis before taking any action
+- 💾 Initialize document and update frontmatter
+- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step
+- 🚫 FORBIDDEN to load next step until setup is complete
+
+## CONTEXT BOUNDARIES:
+
+- Variables from workflow.md are available in memory
+- Previous context = what's in output document + frontmatter
+- Don't assume knowledge from other steps
+- Input document discovery happens in this step
+
+## YOUR TASK:
+
+Initialize the PRD workflow by detecting continuation state and setting up the document.
+
+## INITIALIZATION SEQUENCE:
+
+### 1. Check for Existing Workflow
+
+First, check if the output document already exists:
+
+- Look for file at `{output_folder}/prd.md`
+- If exists, read the complete file including frontmatter
+- If not exists, this is a fresh workflow
+
+### 2. Handle Continuation (If Document Exists)
+
+If the document exists and has frontmatter with `stepsCompleted`:
+
+- **STOP here** and load `./step-01b-continue.md` immediately
+- Do not proceed with any initialization tasks
+- Let step-01b handle the continuation logic
+
+### 3. Fresh Workflow Setup (If No Document)
+
+If no document exists or no `stepsCompleted` in frontmatter:
+
+#### A. Input Document Discovery
+
+Discover and load context documents using smart discovery:
+
+**Product Brief (Priority: Analysis → Main → Sharded → Whole):**
+
+1. Check analysis folder: `{output_folder}/analysis/*brief*.md`
+2. If no analysis files: Try main folder: `{output_folder}/*brief*.md`
+3. If no main files: Check for sharded brief folder: `{output_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: `{output_folder}/analysis/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
+
+**Brainstorming Documents (Priority: Analysis → Main):**
+
+1. Check analysis folder: `{output_folder}/analysis/brainstorming/*brainstorming*.md`
+2. If no analysis files: Try main folder: `{output_folder}/*brainstorming*.md`
+3. Add discovered files to `inputDocuments` frontmatter
+
+**Project Documentation (Existing Projects):**
+
+1. Look for index file: `{output_folder}/index.md`
+2. CRITICAL: Load index.md to understand what project files are available
+3. Read available files from index to understand existing project context
+4. This provides essential context for extending existing project with new PRD
+5. Add discovered files to `inputDocuments` frontmatter
+
+**Loading Rules:**
+
+- Load ALL discovered files completely (no offset/limit)
+- For sharded folders, load ALL files to get complete picture
+- For existing projects, use index.md as guide to what's relevant
+- Track all successfully loaded files in frontmatter `inputDocuments` array
+
+#### B. Create Initial Document
+
+Copy the template from `{installed_path}/prd-template.md` to `{output_folder}/prd.md`
+Initialize frontmatter with:
+
+```yaml
+---
+stepsCompleted: []
+inputDocuments: []
+workflowType: 'prd'
+lastStep: 0
+project_name: '{{project_name}}'
+user_name: '{{user_name}}'
+date: '{{date}}'
+---
+```
+
+#### C. Complete Initialization and Report
+
+Complete setup and report to user:
+
+**Document Setup:**
+
+- Created: `{output_folder}/prd.md` from template
+- Initialized frontmatter with workflow state
+
+**Input Documents Discovered:**
+Report what was found:
+"Welcome {{user_name}}! I've set up your PRD workspace for {{project_name}}.
+
+**Documents Found:**
+
+- Product brief: {number of brief files loaded or "None found"}
+- Research: {number of research files loaded or "None found"}
+- Project docs: {number of project files loaded or "None found"}
+
+**Files loaded:** {list of specific file names or "No additional documents found"}
+
+Do you have any other documents you'd like me to include, or shall we continue to the next step?
+
+[C] Continue - Save this and move to Project Discovery (Step 2 of 10)
+
+## SUCCESS METRICS:
+
+✅ Existing workflow detected and handed off to step-01b correctly
+✅ Fresh workflow initialized with template and frontmatter
+✅ Input documents discovered and loaded using sharded-first logic
+✅ All discovered files tracked in frontmatter `inputDocuments`
+✅ User confirmed document setup and can proceed
+
+## FAILURE MODES:
+
+❌ Proceeding with fresh initialization when existing workflow exists
+❌ Not updating frontmatter with discovered input documents
+❌ Creating document without proper template
+❌ Not checking sharded folders first before whole files
+❌ Not reporting what documents were found to user
+
+❌ **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
+
+## NEXT STEP:
+
+After user selects [C] to continue, load `{installed_path}/step/step-02-discovery.md` to begin the project discovery phase.

package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md

@@ -0,0 +1,123 @@
+# Step 1B: Workflow Continuation
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+- 🛑 NEVER generate content without user input
+
+- 📖 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
+- ✅ ALWAYS treat this as collaborative discovery between PM peers
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- 💬 FOCUS on understanding where we left off and continuing appropriately
+- 🚪 RESUME workflow from exact point where it was interrupted
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis of current state before taking action
+- 💾 Keep existing frontmatter `stepsCompleted` values
+- 📖 Only load documents that were already tracked in `inputDocuments`
+- 🚫 FORBIDDEN to modify content completed in previous steps
+
+## CONTEXT BOUNDARIES:
+
+- Current document and frontmatter are already loaded
+- Previous context = complete document + existing frontmatter
+- Input documents listed in frontmatter were already processed
+- Last completed step = `lastStep` value from frontmatter
+
+## YOUR TASK:
+
+Resume the PRD workflow from where it was left off, ensuring smooth continuation.
+
+## CONTINUATION SEQUENCE:
+
+### 1. Analyze Current State
+
+Review the frontmatter to understand:
+
+- `stepsCompleted`: Which steps are already done
+- `lastStep`: The most recently completed step number
+- `inputDocuments`: What context was already loaded
+- All other frontmatter variables
+
+### 2. Load All Input Documents
+
+Reload the context documents listed in `inputDocuments`:
+
+- For each document in `inputDocuments`, load the complete file
+- This ensures you have full context for continuation
+- Don't discover new documents - only reload what was previously processed
+
+### 3. Summarize Current Progress
+
+Welcome the user back and provide context:
+"Welcome back {{user_name}}! I'm resuming our PRD collaboration for {{project_name}}.
+
+**Current Progress:**
+
+- Steps completed: {stepsCompleted}
+- Last worked on: Step {lastStep}
+- Context documents available: {len(inputDocuments)} files
+
+**Document Status:**
+
+- Current PRD document is ready with all completed sections
+- Ready to continue from where we left off
+
+Does this look right, or do you want to make any adjustments before we proceed?"
+
+### 4. Determine Next Step
+
+Based on `lastStep` value, determine which step to load next:
+
+- If `lastStep = 1` → Load `./step-02-discovery.md`
+- If `lastStep = 2` → Load `./step-03-success.md`
+- If `lastStep = 3` → Load `./step-04-journeys.md`
+- Continue this pattern for all steps
+- If `lastStep = 10` → Workflow already complete
+
+### 5. Present Continuation Options
+
+After presenting current progress, ask:
+"Ready to continue with Step {nextStepNumber}: {nextStepTitle}?
+
+[C] Continue to Step {nextStepNumber}"
+
+## SUCCESS METRICS:
+
+✅ All previous input documents successfully reloaded
+✅ Current workflow state accurately analyzed and presented
+✅ User confirms understanding of progress
+✅ Correct next step identified and prepared for loading
+
+## FAILURE MODES:
+
+❌ Discovering new input documents instead of reloading existing ones
+❌ Modifying content from already completed steps
+❌ Loading wrong next step based on `lastStep` value
+❌ Proceeding without user confirmation of current state
+
+❌ **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 ALREADY COMPLETE?
+
+If `lastStep = 10` (final step completed):
+"Great news! It looks like we've already completed the PRD workflow for {{project_name}}.
+
+The final document is ready at {output_folder}/prd.md with all sections completed through step 10.
+
+Would you like me to:
+
+- Review the completed PRD with you
+- Suggest next workflow steps (like architecture or epic creation)
+- Start a new PRD revision
+
+What would be most helpful?"
+
+## NEXT STEP:
+
+After user confirms they're ready to continue, load the appropriate next step file based on the `lastStep` value from frontmatter.
+
+Remember: Do NOT load the next step until user explicitly selects [C] to continue!