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

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

@@ -1,204 +1,16 @@
-# {{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: []
+documentCounts:
+  briefs: 0
+  research: 0
+  brainstorming: 0
+  projectDocs: 0
+workflowType: 'prd'
+lastStep: 0
 ---
 
-## 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,243 @@
+---
+name: 'step-01-init'
+description: 'Initialize the PRD workflow by detecting continuation state and setting up the document'
+
+# Path Definitions
+workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd'
+
+# File References
+thisStepFile: '{workflow_path}/steps/step-01-init.md'
+nextStepFile: '{workflow_path}/steps/step-02-discovery.md'
+continueStepFile: '{workflow_path}/steps/step-01b-continue.md'
+workflowFile: '{workflow_path}/workflow.md'
+outputFile: '{output_folder}/prd.md'
+
+# Template References
+prdTemplate: '{workflow_path}/prd-template.md'
+---
+
+# Step 1: Workflow Initialization
+
+**Progress: Step 1 of 11** - Next: Project Discovery
+
+## STEP GOAL:
+
+Initialize the PRD workflow by detecting continuation state, discovering input documents, and setting up the document structure for collaborative product requirement discovery.
+
+## 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
+
+### Role Reinforcement:
+
+- ✅ You are a product-focused PM facilitator collaborating with an expert peer
+- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on initialization and setup - no content generation yet
+- 🚫 FORBIDDEN to look ahead to future steps or assume knowledge from them
+- 💬 Approach: Systematic setup with clear reporting to user
+- 🚪 Detect existing workflow state and handle continuation properly
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis of current state before taking any action
+- 💾 Initialize document structure and update frontmatter appropriately
+- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step
+- 🚫 FORBIDDEN to load next step until user selects 'C' (Continue)
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Variables from workflow.md are available in memory
+- Focus: Workflow initialization and document setup only
+- Limits: Don't assume knowledge from other steps or create content yet
+- Dependencies: Configuration loaded from workflow.md initialization
+
+## Sequence of Instructions (Do not deviate, skip, or optimize)
+
+### 1. Check for Existing Workflow State
+
+First, check if the output document already exists:
+
+**Workflow State Detection:**
+
+- Look for file at `{outputFile}`
+- 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`:
+
+**Continuation Protocol:**
+
+- **STOP immediately** and load `{continueStepFile}`
+- Do not proceed with any initialization tasks
+- Let step-01b handle all continuation logic
+- This is an auto-proceed situation - no user choice needed
+
+### 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.
+
+**IMPORTANT: Track document counts as you discover files.**
+
+Initialize counters:
+
+```
+briefCount = 0
+researchCount = 0
+brainstormingCount = 0
+projectDocsCount = 0
+```
+
+**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
+6. **Update briefCount with number of files found**
+
+**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
+6. **Update researchCount with number of files found**
+
+**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
+4. **Update brainstormingCount with number of files found**
+
+**Project Documentation (Existing Projects - Brownfield):**
+
+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
+6. **Update projectDocsCount with number of files found (including index.md)**
+
+**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
+
+**Document Setup:**
+
+- Copy the template from `{prdTemplate}` to `{outputFile}`
+- Initialize frontmatter with proper structure including document counts:
+
+```yaml
+---
+stepsCompleted: []
+inputDocuments: []
+documentCounts:
+  briefs: { { briefCount } }
+  research: { { researchCount } }
+  brainstorming: { { brainstormingCount } }
+  projectDocs: { { projectDocsCount } }
+workflowType: 'prd'
+lastStep: 0
+project_name: '{{project_name}}'
+user_name: '{{user_name}}'
+date: '{{date}}'
+---
+```
+
+#### C. Present Initialization Results
+
+**Setup Report to User:**
+
+"Welcome {{user_name}}! I've set up your PRD workspace for {{project_name}}.
+
+**Document Setup:**
+
+- Created: `{outputFile}` from template
+- Initialized frontmatter with workflow state
+
+**Input Documents Discovered:**
+
+- Product briefs: {{briefCount}} files {if briefCount > 0}✓ loaded{else}(none found){/if}
+- Research: {{researchCount}} files {if researchCount > 0}✓ loaded{else}(none found){/if}
+- Brainstorming: {{brainstormingCount}} files {if brainstormingCount > 0}✓ loaded{else}(none found){/if}
+- Project docs: {{projectDocsCount}} files {if projectDocsCount > 0}✓ loaded (brownfield project){else}(none found - greenfield project){/if}
+
+**Files loaded:** {list of specific file names or "No additional documents found"}
+
+{if projectDocsCount > 0}
+📋 **Note:** This is a **brownfield project**. Your existing project documentation has been loaded. In the next step, I'll ask specifically about what new features or changes you want to add to your existing system.
+{/if}
+
+Do you have any other documents you'd like me to include, or shall we continue to the next step?"
+
+### 4. Present MENU OPTIONS
+
+Display menu after setup report:
+
+"[C] Continue - Save this and move to Project Discovery (Step 2 of 11)"
+
+#### Menu Handling Logic:
+
+- IF C: Update frontmatter with `stepsCompleted: [1]`, then load, read entire file, then execute {nextStepFile}
+- IF user provides additional files: Load them, update inputDocuments and documentCounts, redisplay report
+- IF user asks questions: Answer and redisplay menu
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN [C continue option] is selected and [frontmatter properly updated with stepsCompleted: [1] and documentCounts], will you then load and read fully `{nextStepFile}` to execute and begin project discovery.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Existing workflow detected and properly handed off to step-01b
+- Fresh workflow initialized with template and proper frontmatter
+- Input documents discovered and loaded using sharded-first logic
+- All discovered files tracked in frontmatter `inputDocuments`
+- **Document counts stored in frontmatter `documentCounts`**
+- User clearly informed of brownfield vs greenfield status
+- Menu presented and user input handled correctly
+- Frontmatter updated with `stepsCompleted: [1]` before proceeding
+
+### ❌ SYSTEM FAILURE:
+
+- Proceeding with fresh initialization when existing workflow exists
+- Not updating frontmatter with discovered input documents
+- **Not storing document counts in frontmatter**
+- Creating document without proper template structure
+- Not checking sharded folders first before whole files
+- Not reporting discovered documents to user clearly
+- Proceeding without user selecting 'C' (Continue)
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

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

@@ -0,0 +1,165 @@
+---
+name: 'step-01b-continue'
+description: 'Resume an interrupted PRD workflow from the last completed step'
+
+# Path Definitions
+workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd'
+
+# File References
+thisStepFile: '{workflow_path}/steps/step-01b-continue.md'
+workflowFile: '{workflow_path}/workflow.md'
+outputFile: '{output_folder}/prd.md'
+---
+
+# Step 1B: Workflow Continuation
+
+## STEP GOAL:
+
+Resume the PRD workflow from where it was left off, ensuring smooth continuation with full context restoration.
+
+## 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
+
+### Role Reinforcement:
+
+- ✅ You are a product-focused PM facilitator collaborating with an expert peer
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ Resume workflow from exact point where it was interrupted
+
+### Step-Specific Rules:
+
+- 💬 FOCUS on understanding where we left off and continuing appropriately
+- 🚫 FORBIDDEN to modify content completed in previous steps
+- 📖 Only reload documents that were already tracked in `inputDocuments`
+
+## 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 discover new input documents during continuation
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Current document and frontmatter are already loaded
+- Focus: Workflow state analysis and continuation logic only
+- Limits: Don't assume knowledge beyond what's in the document
+- Dependencies: Existing workflow state from previous session
+
+## Sequence of Instructions (Do not deviate, skip, or optimize)
+
+### 1. Analyze Current State
+
+**State Assessment:**
+Review the frontmatter to understand:
+
+- `stepsCompleted`: Which steps are already done
+- `lastStep`: The most recently completed step number
+- `inputDocuments`: What context was already loaded
+- `documentCounts`: briefs, research, brainstorming, projectDocs counts
+- All other frontmatter variables
+
+### 2. Restore Context Documents
+
+**Context Reloading:**
+
+- 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. Present Current Progress
+
+**Progress Report to User:**
+"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 Continuation Path
+
+**Next Step Logic:**
+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`
+- If `lastStep = 4` → Load `./step-05-domain.md`
+- If `lastStep = 5` → Load `./step-06-innovation.md`
+- If `lastStep = 6` → Load `./step-07-project-type.md`
+- If `lastStep = 7` → Load `./step-08-scoping.md`
+- If `lastStep = 8` → Load `./step-09-functional.md`
+- If `lastStep = 9` → Load `./step-10-nonfunctional.md`
+- If `lastStep = 10` → Load `./step-11-complete.md`
+- If `lastStep = 11` → Workflow already complete
+
+### 5. Handle Workflow Completion
+
+**If workflow already complete (`lastStep = 11`):**
+"Great news! It looks like we've already completed the PRD workflow for {{project_name}}.
+
+The final document is ready at `{outputFile}` with all sections completed through step 11.
+
+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?"
+
+### 6. Present MENU OPTIONS
+
+**If workflow not complete:**
+Display: "Ready to continue with Step {nextStepNumber}?
+
+**Select an Option:** [C] Continue to next step"
+
+#### Menu Handling Logic:
+
+- IF C: Load, read entire file, then execute the appropriate next step file based on `lastStep`
+- IF Any other comments or queries: respond and redisplay menu
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN [C continue option] is selected and [current state confirmed], will you then load and read fully the appropriate next step file to resume the workflow.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All previous input documents successfully reloaded
+- Current workflow state accurately analyzed and presented
+- User confirms understanding of progress before continuation
+- Correct next step identified and prepared for loading
+
+### ❌ SYSTEM FAILURE:
+
+- 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
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.