ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

Merge branch 'main' into feature/kiro_cli_installer

This commit is contained in:
Brian 2025-12-03 12:15:47 -06:00 committed by GitHub
parent 0d62bbd459 686af5b0ee
commit e129b8b073
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
111 changed files with 5056 additions and 3205 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.prettierignore
View File

@ -1,6 +1,9 @@
# Test fixtures with intentionally broken/malformed files
test/fixtures/**
# Contributor Covenant (external standard)
CODE_OF_CONDUCT.md
# BMAD runtime folders (user-specific, not in repo)
.bmad/
.bmad*/

128
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
the official BMAD Discord server (https://discord.com/invite/gk8jAdXWmj) - DM a moderator or flag a post.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

4
docs/agent-customization-guide.md
View File

@ -138,10 +138,10 @@ critical_actions:
# {bmad_folder}/_cfg/agents/bmm-dev.customize.yaml
menu:
- trigger: deploy-staging
workflow: '{project-root}/.bmad-custom/deploy-staging.yaml'
workflow: '{project-root}/{bmad_folder}/deploy-staging.yaml'
description: Deploy to staging environment
- trigger: deploy-prod
workflow: '{project-root}/.bmad-custom/deploy-prod.yaml'
workflow: '{project-root}/{bmad_folder}/deploy-prod.yaml'
description: Deploy to production (with approval)
```

513
docs/workflow-compliance-report-create-workflow.md Normal file
View File

@ -0,0 +1,513 @@
---
name: 'Workflow Compliance Report - create-workflow'
description: 'Systematic validation results for create-workflow workflow'
workflow_name: 'create-workflow'
validation_date: '2025-12-02'
stepsCompleted: ['workflow-validation', 'step-validation', 'file-validation', 'spectrum-validation', 'web-subprocess-validation']
---
# Workflow Compliance Report: create-workflow
**Validation Date:** 2025-12-02
**Target Workflow:** /Users/brianmadison/dev/BMAD-METHOD/src/modules/bmb/workflows/create-workflow/workflow.md
**Reference Standard:** /Users/brianmadison/dev/BMAD-METHOD/.bmad/bmb/docs/workflows/templates/workflow-template.md
## Phase 1: Workflow.md Validation Results
### Template Adherence Analysis
**Reference Standard:** workflow-template.md
### Frontmatter Structure Violations
✅ **PASS** - All required fields present and properly formatted:
- name: "Create Workflow" ✓
- description: "Create structured standalone workflows using markdown-based step architecture" ✓
- web_bundle: true (proper boolean format) ✓
### Role Description Violations
✅ **PASS** - Role description follows template format:
- Partnership language present: "This is a partnership, not a client-vendor relationship" ✓
- Expertise clearly defined: "workflow architect and systems designer" ✓
- User expertise identified: "domain knowledge and specific workflow requirements" ✓
- Collaboration directive: "Work together as equals" ✓
### Workflow Architecture Violations
🚫 **CRITICAL VIOLATION** - Core Principles deviate from template:
**Template requires:** "Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time"
**Target has:** "Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly"
- **Severity:** Critical
- **Template Reference:** "Core Principles" section in workflow-template.md
- **Specific Fix:** Replace with exact template wording: "Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time"
🚫 **CRITICAL VIOLATION** - State Tracking Rule deviates from template:
**Template requires:** "Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document"
**Target has:** "Document progress in context for compliance checking (no output file frontmatter needed)"
- **Severity:** Critical
- **Template Reference:** "Core Principles" section in workflow-template.md
- **Specific Fix:** Replace with exact template wording about stepsCompleted array
### Initialization Sequence Violations
🚫 **MAJOR VIOLATION** - Configuration path format incorrect:
**Template requires:** "{project-root}/.bmad/[MODULE FOLDER]/config.yaml"
**Target has:** "{project-root}/.bmad/bmb/config.yaml"
- **Severity:** Major
- **Template Reference:** "Module Configuration Loading" section in workflow-template.md
- **Specific Fix:** Use proper module variable substitution: "{project-root}/.bmad/bmb/config.yaml" should reference module folder properly
🚫 **MAJOR VIOLATION** - First step path format inconsistent:
**Template requires:** Explicit step file path following pattern
**Target has:** "Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow."
- **Severity:** Major
- **Template Reference:** "First Step EXECUTION" section in workflow-template.md
- **Specific Fix:** Ensure consistency with template variable substitution patterns
### Phase 1 Summary
**Critical Issues:** 2
- Core Principles text deviation from template
- State Tracking rule modification from template standard
**Major Issues:** 2
- Configuration path format not following template variable pattern
- First step execution path needs consistency check
**Minor Issues:** 0
### Phase 1 Recommendations
**Priority 1 - Critical Fixes:**
1. Replace Core Principles text with exact template wording
2. Restore State Tracking rule to template standard about stepsCompleted array
**Priority 2 - Major Fixes:**
1. Review and standardize all path variable usage to follow template patterns
2. Ensure consistency in variable substitution throughout workflow
## Phase 2: Step Validation Results
### Template Adherence Analysis
**Reference Standard:** step-template.md
**Total Steps Analyzed:** 9
### Critical Violations Summary
**Step 01-init.md:**
- Missing `outputFile` in frontmatter - Template Reference: line 22
- Uses auto-proceed menu instead of standard A/P/C pattern - Template Reference: lines 106-123
- Missing "CRITICAL STEP COMPLETION NOTE" section - Template Reference: line 126
**Step 02-gather.md:**
- Missing `outputFile` in frontmatter - Template Reference: line 22
- Incorrect `nextStepFile` path format - Template Reference: line 19
**Steps 03-09 (All Steps):**
- Missing `outputFile` in frontmatter - Template Reference: line 22
- Non-standard step naming (missing short descriptive names) - Template Reference: line 9
- Steps 08-09 missing `workflowFile` in frontmatter - Template Reference: line 21
### Major Violations Summary
**Frontmatter Structure (All Steps):**
- Missing `altStep{Y}` comment pattern - Template Reference: line 20
- Missing Task References section structure - Template Reference: lines 24-27
- Missing Template References section structure - Template Reference: lines 29-33
- Missing Data References section structure - Template Reference: lines 35-37
**Menu Pattern Violations:**
- Step 01: Custom auto-proceed menu instead of standard A/P/C - Template Reference: lines 106-123
- Step 05: Menu text "Continue" instead of "Continue to [next action]" - Template Reference: line 115
- Step 07: Custom "Build Complete" menu instead of A/P/C pattern - Template Reference: lines 106-123
- Step 08: Missing A and P options in menu - Template Reference: lines 106-123
- Step 09: Uses T/M/D pattern instead of standard A/P/C - Template Reference: lines 106-123
### Path Variable Inconsistencies
- Inconsistent use of `{bmad_folder}` vs `.bmad` in paths across all steps
- Missing `outputFile` variable definitions - Template Reference: line 22
- Step 04 uses non-standard `nextStepFormDesign` and `nextStepDesign` variables
### Minor Violations Summary
**Content Structure:**
- Missing "CONTEXT BOUNDARIES" section titles - Template Reference: line 82
- Missing "EXECUTION PROTOCOLS" section titles - Template Reference: line 75
- Non-standard section naming in multiple steps - Template Reference: line 89
### Phase 2 Summary
**Critical Issues:** 15
- 9 missing outputFile variables
- 6 non-standard menu patterns
- Multiple missing required sections
**Major Issues:** 36
- 36 frontmatter structure violations across all steps
- 5 menu pattern deviations
- Numerous path variable inconsistencies
**Minor Issues:** 27
- Section naming inconsistencies
- Missing template-required section titles
**Most Common Violations:**
1. Missing `outputFile` in frontmatter (9 occurrences)
2. Non-standard menu patterns (6 occurrences)
3. Missing Task/Template/Data References sections (27 occurrences)
### Overall Step Compliance Score
**Overall Workflow Step Compliance: 68%**
- Step 01: 65% compliant
- Step 02: 70% compliant
- Steps 03-09: 63-72% compliant each
## Phase 3: File Size, Formatting, and Data Validation Results
### File Size Analysis
**Workflow File:**
- workflow.md: 2.9K - ✅ **Optimal** - Excellent performance and maintainability
**Step Files Distribution:**
- **Optimal (≤5K):** 3 files
- step-09-complete.md: 5.1K
- step-01-init.md: 5.3K
- **Good (5K-7K):** 1 file
- step-04-plan-review.md: 6.6K
- **Acceptable (7K-10K):** 5 files
- step-02-gather.md: 7.8K
- step-08-review.md: 7.9K
- step-03-tools-configuration.md: 7.9K
- step-05-output-format-design.md: 8.2K
- step-06-design.md: 9.0K
- **Acceptable (approaching concern):** 1 file
- step-07-build.md: 10.0K (monitor if additional features added)
**CSV Data Files:**
- Total CSV files: 0
- No data files present requiring validation
### Markdown Formatting Validation
**✅ Strengths:**
- Consistent frontmatter structure across all files
- Proper heading hierarchy (H1→H2→H3) maintained
- Standardized section patterns across all steps
- Proper code block formatting in 7 of 10 files
- Consistent bullet point usage throughout
**⚠️ Minor Issues:**
- File size range significant (2.9K to 10K) but all within acceptable limits
- step-07-build.md approaching concern threshold at 10K
### Performance Impact Assessment
**Overall workflow performance:** ✅ **Excellent**
- All files optimized for performance
- No files requiring immediate size optimization
- Well-structured maintainable codebase
- Professional markdown implementation
**Most critical file size issue:** None - all files within acceptable ranges
**Primary formatting concerns:** None significant - excellent consistency maintained
## Phase 4: Intent vs Prescriptive Spectrum Analysis
### Current Position Assessment
**Analyzed Position:** Balanced Middle (leaning prescriptive)
**Evidence:**
- Highly structured step files with mandatory execution rules
- Specific sequence enforcement and template compliance requirements
- Conversational partnership model within rigid structural constraints
- Limited creative adaptation but maintains collaborative dialogue
**Confidence Level:** High - Clear patterns in implementation demonstrate intentional structure
### Expert Recommendation
**Recommended Position:** Balanced Middle (slightly toward prescriptive)
**Reasoning:**
- Workflow creation needs systematic structure for BMAD compliance
- Template requirements demand prescriptive elements
- Creative aspects need room for user ownership
- Best workflows emerge from structured collaboration
**Workflow Type Considerations:**
- Primary purpose: Creating structured, repeatable workflows
- User expectations: Reliable, consistent BMAD-compliant outputs
- Success factors: Template compliance and systematic approach
- Risk level: Medium - compliance critical for ecosystem coherence
### User Decision
**Selected Position:** Option 1 - Keep Current Position (Balanced Middle leaning prescriptive)
**Rationale:** User prefers to maintain current structured approach
**Implementation Guidance:**
- Continue with current balance of structure and collaborative dialogue
- Maintain template compliance requirements
- Preserve systematic execution patterns
- Keep conversational elements within prescribed framework
### Spectrum Validation Results
✅ Spectrum position is intentional and understood
✅ User educated on implications of their choice
✅ Implementation guidance provided for maintaining position
✅ Decision documented for future reference
## Phase 5: Web Search & Subprocess Optimization Analysis
### Web Search Optimization
**Unnecessary Searches Identified:** 1
- Step 6 loads 5+ template files individually - these are static templates that rarely change
**Essential Searches to Keep:** 2
- CSV tool database in Step 3 (dynamic data)
- Reference workflow example in Step 2 (concrete patterns)
**Optimization Recommendations:**
- Implement template caching to eliminate repeated file loads
- Use selective CSV loading based on workflow type
**Estimated Time Savings:** 5-7 seconds per workflow execution
### Subprocess Optimization Opportunities
**Parallel Processing:** 2 major opportunities identified
1. **Step 3 + Step 5 Parallelization:** Tools configuration and output format design can run simultaneously
- Savings: 5-10 minutes per workflow
2. **Background Template Loading:** Pre-load templates during Step 1 idle time
- Savings: Eliminate design-phase delays
**Batch Processing:** 1 grouping opportunity
- Parallel file generation in Step 7 (workflow.md, step files, templates)
- Savings: 60-80% reduction in build time for multi-step workflows
**Background Processing:** 2 task opportunities
- Template pre-loading during initialization
- File generation coordination during build phase
**Performance Improvement:** 40-60% estimated overall improvement
### Resource Efficiency Analysis
**Context Optimization:**
- JIT context loading: 40-60% reduction in token usage
- Reference content deduplication: 8,000-12,000 token savings
- Step file size reduction: 30-50% smaller files
**LLM Resource Usage:**
- Smart context pruning by workflow phase
- Compact step instructions with external references
- Selective context loading based on current phase
**User Experience Impact:**
- Significantly faster workflow creation (15-25 minutes saved)
- More responsive interaction patterns
- Reduced waiting times during critical phases
### Implementation Recommendations
**Immediate Actions (High Impact, Low Risk):**
1. Implement template caching in workflow.md frontmatter
2. Optimize CSV loading with category filtering
3. Reduce step file sizes by moving examples to reference files
**Strategic Improvements (High Impact, Medium Risk):**
1. Parallelize Step 3 and Step 5 execution
2. Implement JIT context loading by phase
3. Background template pre-loading
**Future Enhancements (Highest Impact, Higher Risk):**
1. Parallel file generation with sub-process coordination
2. Smart context pruning across workflow phases
3. Complete reference deduplication system
## Phase 6: Holistic Workflow Analysis Results
### Flow Validation
**Completion Path Analysis:**
- ✅ All steps have clear continuation paths
- ✅ No orphaned steps or dead ends
- ⚠️ Minor issue: Steps 07 and 09 use non-standard menu patterns
**Sequential Logic:**
- ✅ Logical workflow creation progression maintained
- ✅ Dependencies properly structured
- ⚠️ Steps 05-06 could potentially be consolidated
### Goal Alignment
**Alignment Score:** 85%
**Stated Goal:** "Create structured, repeatable standalone workflows through collaborative conversation and step-by-step guidance"
**Actual Implementation:** Creates structured workflows with heavy emphasis on template compliance and systematic validation
**Gap Analysis:**
- Workflow emphasizes structure over creativity (aligned with spectrum choice)
- Template compliance heavier than user guidance (may need balance adjustment)
### Meta-Workflow Failure Analysis
**Issues That Should Have Been Prevented by create-workflow:**
1. Missing outputFile variables in all 9 steps (Critical)
2. Non-standard menu patterns in Steps 07 and 09 (Major)
3. Missing Task/Template/Data references across all steps (Major)
4. Path variable inconsistencies throughout workflow (Major)
5. Step naming violations for Steps 05-09 (Major)
6. Core Principles text deviation from template (Critical)
**Recommended Meta-Workflow Improvements:**
- Add frontmatter completeness validation during creation
- Implement path variable format checking
- Include menu pattern enforcement validation
- Add Intent vs Prescriptive spectrum selection in Step 01
- Validate template compliance before finalization
---
## Executive Summary
**Overall Compliance Status:** PARTIAL
**Critical Issues:** 17 - Must be fixed immediately
**Major Issues:** 36 - Significantly impacts quality/maintainability
**Minor Issues:** 27 - Standards compliance improvements
**Overall Compliance Score:** 68% based on template adherence
## Severity-Ranked Fix Recommendations
### IMMEDIATE - Critical (Must Fix for Functionality)
1. **Missing outputFile Variables** - Files: All 9 step files
- **Problem:** Critical frontmatter field missing from all steps
- **Template Reference:** step-template.md line 22
- **Fix:** Add `outputFile: '{output_folder}/workflow-plan-{project_name}.md'` to each step
- **Impact:** Workflow cannot produce output without this field
2. **Core Principles Deviation** - File: workflow.md
- **Problem:** Text modified from template standard
- **Template Reference:** workflow-template.md Core Principles section
- **Fix:** Replace with exact template wording
- **Impact:** Violates fundamental BMAD workflow architecture
3. **Non-Standard Menu Patterns** - Files: step-07-build.md, step-09-complete.md
- **Problem:** Custom menu formats instead of A/P/C pattern
- **Template Reference:** step-template.md lines 106-123
- **Fix:** Standardize to A/P/C menu pattern
- **Impact:** Breaks user experience consistency
### HIGH PRIORITY - Major (Significantly Impacts Quality)
1. **Missing Task/Template/Data References** - Files: All 9 step files
- **Problem:** Required frontmatter sections missing
- **Template Reference:** step-template.md lines 24-37
- **Fix:** Add all required reference sections with proper comments
- **Impact:** Violates template structure standards
2. **Step Naming Violations** - Files: steps 05-09
- **Problem:** Missing short descriptive names in step filenames
- **Template Reference:** step-template.md line 9
- **Fix:** Rename to include descriptive names (e.g., step-05-output-format.md)
- **Impact:** Inconsistent with BMAD naming conventions
3. **Path Variable Inconsistencies** - Files: All steps
- **Problem:** Mixed use of `{bmad_folder}` vs `.bmad`
- **Template Reference:** workflow-template.md path patterns
- **Fix:** Standardize to template variable patterns
- **Impact:** Installation flexibility and maintainability
### MEDIUM PRIORITY - Minor (Standards Compliance)
1. **Missing Section Titles** - Files: All steps
- **Problem:** Missing "CONTEXT BOUNDARIES" and "EXECUTION PROTOCOLS" titles
- **Template Reference:** step-template.md lines 75, 82
- **Fix:** Add missing section titles
- **Impact:** Template compliance
## Automated Fix Options
### Fixes That Can Be Applied Automatically
- Add outputFile variables to all step frontmatter
- Add missing section titles
- Standardize path variable usage
- Add Task/Template/Data reference section skeletons
### Fixes Requiring Manual Review
- Core Principles text restoration (needs exact template matching)
- Menu pattern standardization (custom logic may be intentional)
- Step renaming (requires file system changes and reference updates)
## Next Steps Recommendation
**Recommended Approach:**
1. Fix all Critical issues immediately (workflow may not function)
2. Address Major issues for reliability and maintainability
3. Implement Minor issues for full standards compliance
4. Update meta-workflows to prevent future violations
**Estimated Effort:**
- Critical fixes: 2-3 hours
- Major fixes: 4-6 hours
- Minor fixes: 1-2 hours

2
src/modules/bmb/README.md
View File

@ -58,7 +58,7 @@ Specialized tools and workflows for creating, customizing, and extending BMad co
- **[Workflow Index](./docs/workflows/index.md)** - Core workflow system overview
- **[Architecture Guide](./docs/workflows/architecture.md)** - Step-file design and JIT loading
- **[Template System](./docs/workflows/step-template.md)** - Standard step file template
- **[Template System](./docs/workflows/templates/step-template.md)** - Standard step file template
- **[Intent vs Prescriptive](./docs/workflows/intent-vs-prescriptive-spectrum.md)** - Design philosophy
## Reference Materials

2
src/modules/bmb/docs/workflows/architecture.md
View File

@ -69,7 +69,7 @@ workflow-folder/
Standard variables in step files:
```yaml
workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/[workflow-name]'
workflow_path: '{project-root}/{*bmad_folder*}/bmb/reference/workflows/[workflow-name]'
thisStepFile: '{workflow_path}/steps/step-[N]-[name].md'
nextStepFile: '{workflow_path}/steps/step-[N+1]-[name].md'
workflowFile: '{workflow_path}/workflow.md'

241
src/modules/bmb/docs/workflows/templates/step-01-init-continuable-template.md Normal file
View File

@ -0,0 +1,241 @@
# BMAD Continuable Step 01 Init Template
This template provides the standard structure for step-01-init files that support workflow continuation. It includes logic to detect existing workflows and route to step-01b-continue.md for resumption.
Use this template when creating workflows that generate output documents and might take multiple sessions to complete.
<!-- TEMPLATE START -->
---
name: 'step-01-init'
description: 'Initialize the [workflow-type] workflow by detecting continuation state and creating output document'
<!-- Path Definitions -->
workflow*path: '{project-root}/{\_bmad_folder*}/[module-path]/workflows/[workflow-name]'
# File References (all use {variable} format in file)
thisStepFile: '{workflow_path}/steps/step-01-init.md'
nextStepFile: '{workflow_path}/steps/step-02-[step-name].md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/[output-file-name]-{project_name}.md'
continueFile: '{workflow_path}/steps/step-01b-continue.md'
templateFile: '{workflow_path}/templates/[main-template].md'
# Template References
# This step doesn't use content templates, only the main template
---
# Step 1: Workflow Initialization
## 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 [specific role, e.g., "business analyst" or "technical architect"]
- ✅ We engage in collaborative dialogue, not command-response
- ✅ You bring [your expertise], user brings [their expertise], and together we produce something better than we could on our own
- ✅ Maintain collaborative [adjective] tone throughout
### Step-Specific Rules:
- 🎯 Focus ONLY on initialization and setup
- 🚫 FORBIDDEN to look ahead to future steps
- 💬 Handle initialization professionally
- 🚪 DETECT existing workflow state and handle continuation properly
## EXECUTION PROTOCOLS:
- 🎯 Show 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
## STEP GOAL:
To initialize the [workflow-type] workflow by detecting continuation state, creating the output document, and preparing for the first collaborative session.
## INITIALIZATION SEQUENCE:
### 1. Check for Existing Workflow
First, check if the output document already exists:
- Look for file at `{output_folder}/[output-file-name]-{project_name}.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. Handle Completed Workflow
If the document exists AND all steps are marked complete in `stepsCompleted`:
- Ask user: "I found an existing [workflow-output] from [date]. Would you like to:
1. Create a new [workflow-output]
2. Update/modify the existing [workflow-output]"
- If option 1: Create new document with timestamp suffix
- If option 2: Load step-01b-continue.md
### 4. Fresh Workflow Setup (If No Document)
If no document exists or no `stepsCompleted` in frontmatter:
#### A. Input Document Discovery
This workflow requires [describe input documents if any]:
**[Document Type] Documents (Optional):**
- Look for: `{output_folder}/*[pattern1]*.md`
- Look for: `{output_folder}/*[pattern2]*.md`
- If found, load completely and add to `inputDocuments` frontmatter
#### B. Create Initial Document
Copy the template from `{templateFile}` to `{output_folder}/[output-file-name]-{project_name}.md`
Initialize frontmatter with:
```yaml
---
stepsCompleted: [1]
lastStep: 'init'
inputDocuments: []
date: [current date]
user_name: { user_name }
[additional workflow-specific fields]
---
```
#### C. Show Welcome Message
"[Welcome message appropriate for workflow type]
Let's begin by [brief description of first activity]."
## ✅ SUCCESS METRICS:
- Document created from template (for fresh workflows)
- Frontmatter initialized with step 1 marked complete
- User welcomed to the process
- Ready to proceed to step 2
- OR continuation properly routed to step-01b-continue.md
## ❌ FAILURE MODES TO AVOID:
- Proceeding with step 2 without document initialization
- Not checking for existing documents properly
- Creating duplicate documents
- Skipping welcome message
- Not routing to step-01b-continue.md when needed
### 5. Present MENU OPTIONS
Display: **Proceeding to [next step description]...**
#### EXECUTION RULES:
- This is an initialization step with no user choices
- Proceed directly to next step after setup
- Use menu handling logic section below
#### Menu Handling Logic:
- After setup completion, immediately load, read entire file, then execute `{nextStepFile}` to begin [next step description]
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Document created from template (for fresh workflows)
- update frontmatter `stepsCompleted` to add 1 at the end of the array before loading next step
- Frontmatter initialized with `stepsCompleted: [1]`
- User welcomed to the process
- Ready to proceed to step 2
- OR existing workflow properly routed to step-01b-continue.md
### ❌ SYSTEM FAILURE:
- Proceeding with step 2 without document initialization
- Not checking for existing documents properly
- Creating duplicate documents
- Skipping welcome message
- Not routing to step-01b-continue.md when appropriate
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN initialization setup is complete and document is created (OR continuation is properly routed), will you then immediately load, read entire file, then execute `{nextStepFile}` to begin [next step description].
<!-- TEMPLATE END -->
## Customization Guidelines
When adapting this template for your specific workflow:
### 1. Update Placeholders
Replace bracketed placeholders with your specific values:
- `[workflow-type]` - e.g., "nutrition planning", "project requirements"
- `[module-path]` - e.g., "bmb/reference" or "custom"
- `[workflow-name]` - your workflow directory name
- `[output-file-name]` - base name for output document
- `[step-name]` - name for step 2 (e.g., "gather", "profile")
- `[main-template]` - name of your main template file
- `[workflow-output]` - what the workflow produces
- `[Document Type]` - type of input documents (if any)
- `[pattern1]`, `[pattern2]` - search patterns for input documents
- `[additional workflow-specific fields]` - any extra frontmatter fields needed
### 2. Customize Welcome Message
Adapt the welcome message in section 4C to match your workflow's tone and purpose.
### 3. Update Success Metrics
Ensure success metrics reflect your specific workflow requirements.
### 4. Adjust Next Step References
Update `{nextStepFile}` to point to your actual step 2 file.
## Implementation Notes
1. **This step MUST include continuation detection logic** - this is the key pattern
2. **Always include `continueFile` reference** in frontmatter
3. **Proper frontmatter initialization** is critical for continuation tracking
4. **Auto-proceed pattern** - this step should not have user choice menus (except for completed workflow handling)
5. **Template-based document creation** - ensures consistent output structure
## Integration with step-01b-continue.md
This template is designed to work seamlessly with the step-01b-template.md continuation step. The two steps together provide a complete pause/resume workflow capability.

223
src/modules/bmb/docs/workflows/templates/step-1b-template.md Normal file
View File

@ -0,0 +1,223 @@
# BMAD Workflow Step 1B Continuation Template
This template provides the standard structure for workflow continuation steps. It handles resuming workflows that were started but not completed, ensuring seamless continuation across multiple sessions.
Use this template alongside **step-01-init-continuable-template.md** to create workflows that can be paused and resumed. The init template handles the detection and routing logic, while this template handles the resumption logic.
<!-- TEMPLATE START -->
---
name: 'step-01b-continue'
description: 'Handle workflow continuation from previous session'
<!-- Path Definitions -->
workflow*path: '{project-root}/{\_bmad_folder*}/[module-path]/workflows/[workflow-name]'
# File References (all use {variable} format in file)
thisStepFile: '{workflow_path}/steps/step-01b-continue.md'
outputFile: '{output_folder}/[output-file-name]-{project_name}.md'
workflowFile: '{workflow_path}/workflow.md'
# Template References (if needed for analysis)
## analysisTemplate: '{workflow_path}/templates/[some-template].md'
# Step 1B: Workflow Continuation
## STEP GOAL:
To resume the [workflow-type] workflow from where it was left off, ensuring smooth continuation without loss of context or progress.
## 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 [specific role, e.g., "business analyst" or "technical architect"]
- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role
- ✅ We engage in collaborative dialogue, not command-response
- ✅ You bring [your expertise], user brings [their expertise], and together we produce something better than we could on our own
- ✅ Maintain collaborative [adjective] tone throughout
### Step-Specific Rules:
- 🎯 Focus ONLY on analyzing and resuming workflow state
- 🚫 FORBIDDEN to modify content completed in previous steps
- 💬 Maintain continuity with previous sessions
- 🚪 DETECT exact continuation point from frontmatter of incomplete file {outputFile}
## EXECUTION PROTOCOLS:
- 🎯 Show your analysis of current state before taking action
- 💾 Keep existing frontmatter `stepsCompleted` values intact
- 📖 Review the template content already generated in {outputFile}
- 🚫 FORBIDDEN to modify content that was completed in previous steps
- 📝 Update frontmatter with continuation timestamp when resuming
## CONTEXT BOUNDARIES:
- Current [output-file-name] document is already loaded
- Previous context = complete template + existing frontmatter
- [Key data collected] already gathered in previous sessions
- Last completed step = last value in `stepsCompleted` array from frontmatter
## CONTINUATION SEQUENCE:
### 1. Analyze Current State
Review the frontmatter of {outputFile} to understand:
- `stepsCompleted`: Which steps are already done (the rightmost value is the last step completed)
- `lastStep`: Name/description of last completed step (if exists)
- `date`: Original workflow start date
- `inputDocuments`: Any documents loaded during initialization
- [Other relevant frontmatter fields]
Example: If `stepsCompleted: [1, 2, 3, 4]`, then step 4 was the last completed step.
### 2. Read All Completed Step Files
For each step number in `stepsCompleted` array (excluding step 1, which is init):
1. **Construct step filename**: `step-[N]-[name].md`
2. **Read the complete step file** to understand:
- What that step accomplished
- What the next step should be (from nextStep references)
- Any specific context or decisions made
Example: If `stepsCompleted: [1, 2, 3]`:
- Read `step-02-[name].md`
- Read `step-03-[name].md`
- The last file will tell you what step-04 should be
### 3. Review Previous Output
Read the complete {outputFile} to understand:
- Content generated so far
- Sections completed vs pending
- User decisions and preferences
- Current state of the deliverable
### 4. Determine Next Step
Based on the last completed step file:
1. **Find the nextStep reference** in the last completed step file
2. **Validate the file exists** at the referenced path
3. **Confirm the workflow is incomplete** (not all steps finished)
### 5. Welcome Back Dialog
Present a warm, context-aware welcome:
"Welcome back! I see we've completed [X] steps of your [workflow-type].
We last worked on [brief description of last step].
Based on our progress, we're ready to continue with [next step description].
Are you ready to continue where we left off?"
### 6. Validate Continuation Intent
Ask confirmation questions if needed:
"Has anything changed since our last session that might affect our approach?"
"Are you still aligned with the goals and decisions we made earlier?"
"Would you like to review what we've accomplished so far?"
### 7. Present MENU OPTIONS
Display: "**Resuming workflow - Select an Option:** [C] Continue to [Next Step Name]"
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed to next step when user selects 'C'
- User can chat or ask questions - always respond and then end with display again of the menu options
- Update frontmatter with continuation timestamp when 'C' is selected
#### Menu Handling Logic:
- IF C:
1. Update frontmatter: add `lastContinued: [current date]`
2. Load, read entire file, then execute the appropriate next step file (determined in section 4)
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and continuation analysis is complete, will you then:
1. Update frontmatter in {outputFile} with continuation timestamp
2. Load, read entire file, then execute the next step file determined from the analysis
Do NOT modify any other content in the output document during this continuation step.
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Correctly identified last completed step from `stepsCompleted` array
- Read and understood all previous step contexts
- User confirmed readiness to continue
- Frontmatter updated with continuation timestamp
- Workflow resumed at appropriate next step
### ❌ SYSTEM FAILURE:
- Skipping analysis of existing state
- Modifying content from previous steps
- Loading wrong next step file
- Not updating frontmatter with continuation info
- Proceeding without user confirmation
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
<!-- TEMPLATE END -->
## Customization Guidelines
When adapting this template for your specific workflow:
### 1. Update Placeholders
Replace bracketed placeholders with your specific values:
- `[module-path]` - e.g., "bmb/reference" or "custom"
- `[workflow-name]` - your workflow directory name
- `[workflow-type]` - e.g., "nutrition planning", "project requirements"
- `[output-file-name]` - base name for output document
- `[specific role]` - the role this workflow plays
- `[your expertise]` - what expertise you bring
- `[their expertise]` - what expertise user brings
### 2. Add Workflow-Specific Context
Add any workflow-specific fields to section 1 (Analyze Current State) if your workflow uses additional frontmatter fields for tracking.
### 3. Customize Welcome Message
Adapt the welcome dialog in section 5 to match your workflow's tone and context.
### 4. Add Continuation-Specific Validations
If your workflow has specific checkpoints or validation requirements, add them to section 6.
## Implementation Notes
1. **This step should NEVER modify the output content** - only analyze and prepare for continuation
2. **Always preserve the `stepsCompleted` array** - don't modify it in this step
3. **Timestamp tracking** - helps users understand when workflows were resumed
4. **Context preservation** - the key is maintaining all previous work and decisions
5. **Seamless experience** - user should feel like they never left the workflow

8
src/modules/bmb/workflows/create-workflow/templates/step-file.md → src/modules/bmb/docs/workflows/templates/step-file.md
View File

@ -3,7 +3,7 @@ name: "step-{{stepNumber}}-{{stepName}}"
description: "{{stepDescription}}"
# Path Definitions
workflow_path: "{project-root}/{bmad_folder}/{{targetModule}}/workflows/{{workflowName}}"
workflow_path: "{project-root}/{*bmad_folder*}/{{targetModule}}/workflows/{{workflowName}}"
# File References
thisStepFile: "{workflow_path}/steps/step-{{stepNumber}}-{{stepName}}.md"
@ -15,9 +15,9 @@ workflowFile: "{workflow_path}/workflow.md"
outputFile: "{output_folder}/{{outputFileName}}-{project_name}.md"
{{/hasOutput}}
# Task References
advancedElicitationTask: "{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml"
partyModeWorkflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md"
# Task References (list only if used in THIS step file instance and only the ones used, there might be others)
advancedElicitationTask: "{project-root}/{*bmad_folder*}/core/tasks/advanced-elicitation.xml"
partyModeWorkflow: "{project-root}/{*bmad_folder*}/core/workflows/party-mode/workflow.md"
{{#hasTemplates}}
# Template References

73
src/modules/bmb/docs/workflows/step-template.md → src/modules/bmb/docs/workflows/templates/step-template.md
View File

@ -2,33 +2,43 @@
This template provides the standard structure for all BMAD workflow step files. Copy and modify this template for each new step you create.
<!-- TEMPLATE START -->
---
```yaml
---
name: 'step-[N]-[short-name]'
description: '[Brief description of what this step accomplishes]'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/[workflow-name]'
<!-- Path Definitions -->
workflow*path: '{project-root}/{\_bmad_folder*}/bmb/reference/workflows/[workflow-name]' # the folder the workflow.md file is in
# File References (all use {variable} format in file)
thisStepFile: '{workflow_path}/steps/step-[N]-[short-name].md'
nextStepFile: '{workflow_path}/steps/step-[N+1]-[next-short-name].md' # Remove for final step
nextStep{N+1}: '{workflow_path}/steps/step-[N+1]-[next-short-name].md' # Remove for final step or no next step
altStep{Y}: '{workflow_path}/steps/step-[Y]-[some-other-step].md' # if there is an alternate next story depending on logic
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/[output-file-name]-{project_name}.md'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Task References (IF THE workflow uses and it makes sense in this step to have these )
advancedElicitationTask: '{project-root}/{_bmad_folder_}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{_bmad_folder_}/core/workflows/party-mode/workflow.md'
# Template References (if this step uses a specific templates)
# Template References (if this step uses templates)
profileTemplate: '{workflow_path}/templates/profile-section.md'
assessmentTemplate: '{workflow_path}/templates/assessment-section.md'
strategyTemplate: '{workflow_path}/templates/strategy-section.md'
# Add more as needed
# Data (CSV for example) References (if used in this step)
someData: '{workflow_path}/data/foo.csv'
# Add more as needed - but ONLY what is used in this specific step file!
---
```
# Step [N]: [Step Name]
@ -52,7 +62,7 @@ Example: "To analyze user requirements and document functional specifications th
- ✅ You are a [specific role, e.g., "business analyst" or "technical architect"]
- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role
- ✅ We engage in collaborative dialogue, not command-response
- ✅ You bring [your expertise], user brings [their expertise], and together we produce something better than the sum of our own parts
- ✅ You bring [your expertise], user brings [their expertise], and together we produce something better than we could on our own
- ✅ Maintain collaborative [adjective] tone throughout
### Step-Specific Rules:
@ -88,15 +98,10 @@ Example: "To analyze user requirements and document functional specifications th
[Specific instructions for second part of the work]
#### Content to Append (if applicable):
### N. Title (as many as needed)
```markdown
## [Section Title]
[Content template or instructions for what to append]
```
### N. (Continue as needed)
<!-- not ever step will include advanced elicitation or party mode, in which case generally will just have the C option -->
<!-- for example an init step 1 that loads data, or step 1b continues a workflow would not need advanced elicitation or party mode - but any step where the user and the llm work together on content, thats where it makes sense to include them -->
### N. Present MENU OPTIONS
@ -105,7 +110,7 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont
#### Menu Handling Logic:
- IF A: Execute {advancedElicitationTask} # Or custom action
- IF P: Execute {partyModeWorkflow}
- IF P: Execute {partyModeWorkflow} # Or custom action
- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#n-present-menu-options)
@ -113,8 +118,8 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont
- 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
- User can chat or ask questions - always respond and then end with display again of the menu options
- After other menu items execution completes, redisplay the menu
- User can chat or ask questions - always respond when conversation ends, redisplay the menu
## CRITICAL STEP COMPLETION NOTE
@ -122,8 +127,6 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont
ONLY WHEN [C continue option] is selected and [completion requirements], will you then load and read fully `[installed_path]/step-[next-number]-[name].md` to execute and begin [next step description].
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
@ -140,15 +143,19 @@ ONLY WHEN [C continue option] is selected and [completion requirements], will yo
- [Step-specific failure mode 2]
- Proceeding without user input/selection
- Not updating required documents/frontmatter
- [General failure modes]
- [Step-specific failure mode N]
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
---
<!-- TEMPLATE END-->
## Common Menu Patterns
## Common Menu Patterns to use in the final sequence item in a step file.
### Standard Menu (A/P/C)
FYI Again - party mode is useful for the user to reach out and get opinions from other agents.
Advanced elicitation is use to direct you to think of alternative outputs of a sequence you just performed.
### Standard Menu - when a sequence in a step results in content produced by the agent or human that could be improved before proceeding.
```markdown
### N. Present MENU OPTIONS
@ -170,7 +177,7 @@ Display: "**Select an Option:** [A] [Advanced Elicitation] [P] Party Mode [C] Co
- User can chat or ask questions - always respond and then end with display again of the menu options
```
### Auto-Proceed Menu (No User Choice)
### Optional Menu - Auto-Proceed Menu (No User Choice or confirm, just flow right to the next step once completed)
```markdown
### N. Present MENU OPTIONS
@ -196,8 +203,8 @@ Display: "**Select an Option:** [A] [Custom Action 1] [B] [Custom Action 2] [C]
#### Menu Handling Logic:
- IF A: [Custom handler for option A]
- IF B: [Custom handler for option B]
- IF A: [Custom handler route for option A]
- IF B: [Custom handler route for option B]
- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#n-present-menu-options)
@ -214,7 +221,7 @@ Display: "**Select an Option:** [A] [Custom Action 1] [B] [Custom Action 2] [C]
```markdown
### N. Present MENU OPTIONS
Display: "**Select an Option:** [A] [Custom Label] [C] Continue"
Display: "**Select an Option:** [A] [Continue to Step Foo] [A] [Continue to Step Bar]"
#### Menu Handling Logic:

104
src/modules/bmb/docs/workflows/templates/workflow-template.md Normal file
View File

@ -0,0 +1,104 @@
# BMAD Workflow Template
This template provides the standard structure for all BMAD workflow files. Copy and modify this template for each new workflow you create.
<!-- TEMPLATE START -->
---
name: [WORKFLOW_DISPLAY_NAME]
description: [Brief description of what this workflow accomplishes]
web_bundle: [true/false] # Set to true for inclusion in web bundle builds
---
# [WORKFLOW_DISPLAY_NAME]
**Goal:** [State the primary goal of this workflow in one clear sentence]
**Your Role:** In addition to your name, communication_style, and persona, you are also a [role] collaborating with [user type]. This is a partnership, not a client-vendor relationship. You bring [your expertise], while the user brings [their expertise]. Work together as equals.
## WORKFLOW ARCHITECTURE
### Core Principles
- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time
- **Just-In-Time Loading**: Only 1 current step file will be loaded, read, and executed to completion - never load future step files until told to do so
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
- **Append-Only Building**: Build documents by appending content as directed to the output file
### Step Processing Rules
1. **READ COMPLETELY**: Always read the entire step file before taking any action
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
### Critical Rules (NO EXCEPTIONS)
- 🛑 **NEVER** load multiple step files simultaneously
- 📖 **ALWAYS** read entire step file before execution
- 🚫 **NEVER** skip steps or optimize the sequence
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
- 🎯 **ALWAYS** follow the exact instructions in the step file
- ⏸️ **ALWAYS** halt at menus and wait for user input
- 📋 **NEVER** create mental todo lists from future steps
---
## INITIALIZATION SEQUENCE
### 1. Module Configuration Loading
Load and read full config from {project-root}/{_bmad_folder_}/[MODULE FOLDER]/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, [MODULE VARS]
### 2. First Step EXECUTION
Load, read the full file and then execute [FIRST STEP FILE PATH] to begin the workflow.
<!-- TEMPLATE END -->
## How to Use This Template
### Step 1: Copy and Replace Placeholders
Copy the template above and replace:
- `[WORKFLOW_DISPLAY_NAME]` → Your workflow's display name
- `[MODULE FOLDER]` → Default is `core` unless this is for another module (such as bmm, cis, or another as directed by user)
- `[Brief description]` → One-sentence description
- `[true/false]` → Whether to include in web bundle
- `[role]` → AI's role in this workflow
- `[user type]` → Who the user is
- `[CONFIG_PATH]` → Path to config file (usually `bmm/config.yaml` or `bmb/config.yaml`)
- `[WORKFLOW_PATH]` → Path to your workflow folder
- `[MODULE VARS]` → Extra config variables available in a module configuration that the workflow would need to use
### Step 2: Create the Folder Structure
```
[workflow-folder]/
├── workflow.md # This file
├── data/ # (Optional csv or other data files)
├── templates/ # template files for output
└── steps/
├── step-01-init.md
├── step-02-[name].md
└── ...
```
### Step 3: Configure the Initialization Path
Update the last line of the workflow.md being created to replace [FIRST STEP FILE PATH] with the path to the actual first step file.
Example: Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow.
### NOTE: You can View a real example of a perfect workflow.md file that was created from this template
`{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition/workflow.md`

2
src/modules/bmb/workflows/create-workflow/templates/workflow.md → src/modules/bmb/docs/workflows/templates/workflow.md
View File

@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading
Load and read full config from {project-root}/{bmad_folder}/{{targetModule}}/config.yaml and resolve:
Load and read full config from {project-root}/{_bmad_folder_}/{{targetModule}}/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`

152
src/modules/bmb/docs/workflows/workflow-template.md
View File

@ -1,152 +0,0 @@
# BMAD Workflow Template
This template provides the standard structure for all BMAD workflow files. Copy and modify this template for each new workflow you create.
## Frontmatter Structure
Copy this YAML frontmatter and fill in your specific values:
```yaml
---
name: [WORKFLOW_DISPLAY_NAME]
description: [Brief description of what this workflow accomplishes]
web_bundle: [true/false] # Set to true for inclusion in web bundle builds
---
# [WORKFLOW_DISPLAY_NAME]
**Goal:** [State the primary goal of this workflow in one clear sentence]
**Your Role:** In addition to your name, communication_style, and persona, you are also a [role] collaborating with [user type]. This is a partnership, not a client-vendor relationship. You bring [your expertise], while the user brings [their expertise]. Work together as equals.
---
## WORKFLOW ARCHITECTURE
This uses **step-file architecture** for disciplined execution:
### Core Principles
- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
- **Append-Only Building**: Build documents by appending content as directed to the output file
### Step Processing Rules
1. **READ COMPLETELY**: Always read the entire step file before taking any action
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
### Critical Rules (NO EXCEPTIONS)
- 🛑 **NEVER** load multiple step files simultaneously
- 📖 **ALWAYS** read entire step file before execution
- 🚫 **NEVER** skip steps or optimize the sequence
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
- 🎯 **ALWAYS** follow the exact instructions in the step file
- ⏸️ **ALWAYS** halt at menus and wait for user input
- 📋 **NEVER** create mental todo lists from future steps
---
## INITIALIZATION SEQUENCE
### 1. Configuration Loading
Load and read full config from {project-root}/{bmad_folder}/[module such as core, bmm, bmb]/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, [any additional variables]
**Note:** Use variable substitution patterns for flexible installation paths:
- `{project-root}` - Root directory of the project
- `{bmad_folder}` - Name of the BMAD folder (usually `.bmad`)
- `[module]` - Module name (core, bmm, bmb, or custom)
### 2. First Step EXECUTION
Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow.
```
## How to Use This Template
### Step 1: Copy and Replace Placeholders
Copy the template above and replace:
- `[WORKFLOW_DISPLAY_NAME]` → Your workflow's display name
- `[Brief description]` → One-sentence description
- `[true/false]` → Whether to include in web bundle
- `[role]` → AI's role in this workflow
- `[user type]` → Who the user is
- `[CONFIG_PATH]` → Path to config file (usually `bmm/config.yaml` or `bmb/config.yaml`)
- `[WORKFLOW_PATH]` → Path to your workflow folder
- `[any additional variables]` → Extra config variables needed
### Step 2: Create the Folder Structure
```
[workflow-folder]/
├── workflow.md # This file
└── steps/
├── step-01-init.md
├── step-02-[name].md
└── ...
```
### Step 3: Configure the Initialization Path
Update the last line to point to your actual first step file:
```markdown
Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow.
```
## Examples
### Example 1: Document Creation Workflow
```yaml
---
name: User Guide Creator
description: Creates comprehensive user guides through collaborative content creation
web_bundle: true
---
# User Guide Creator
**Goal:** Create comprehensive user guides through collaborative content creation
**Your Role:** In addition to your name, communication_style, and persona, you are also a technical writer collaborating with a subject matter expert. This is a partnership, not a client-vendor relationship. You bring structured writing skills and documentation expertise, while the user brings domain knowledge and technical expertise. Work together as equals.
```
### Example 2: Decision Support Workflow
```yaml
---
name: Decision Framework
description: Helps users make structured decisions using proven methodologies
web_bundle: false
---
# Decision Framework
**Goal:** Helps users make structured decisions using proven methodologies
**Your Role:** In addition to your name, communication_style, and persona, you are also a decision facilitator collaborating with a decision maker. This is a partnership, not a client-vendor relationship. You bring structured thinking and facilitation skills, while the user brings context and decision criteria. Work together as equals.
```
## Best Practices
1. **Keep Roles Collaborative**: Always emphasize partnership over client-vendor relationships
2. **Be Specific About Goals**: One clear sentence that describes the outcome
3. **Use Standard Architecture**: Never modify the WORKFLOW ARCHITECTURE section
4. **Include web_bundle**: Set to true for production-ready workflows
5. **Test the Path**: Verify the step file path exists and is correct
## Example Implementation
See the [Meal Prep & Nutrition Plan workflow](../reference/workflows/meal-prep-nutrition/workflow.md) for a complete implementation of this template.
Remember: This template is the STANDARD for all BMAD workflows. Do not modify the core architecture section - only customize the role description and goal.

5
src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md
View File

@ -157,7 +157,8 @@ Display: **Proceeding to user profile collection...**
### ✅ SUCCESS:
- Document created from template
- Frontmatter initialized with step 1 marked complete
- update frontmatter `stepsCompleted` to add 4 at the end of the array before loading next step
- Frontmatter initialized with `stepsCompleted: [1]`
- User welcomed to the process
- Ready to proceed to step 2
@ -173,5 +174,3 @@ ONLY WHEN initialization setup is complete and document is created, will you the
- Skipping welcome message
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
---

50
src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md
View File

@ -7,10 +7,7 @@ workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-n
# File References
thisStepFile: '{workflow_path}/steps/step-01b-continue.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/nutrition-plan-{project_name}.md'
# Template References
# This step doesn't use content templates, reads from existing output file
---
# Step 1B: Workflow Continuation
@ -38,9 +35,9 @@ To resume the nutrition planning workflow from where it was left off, ensuring s
### Step-Specific Rules:
- 🎯 Focus ONLY on analyzing and resuming workflow state
- 🚫 FORBIDDEN to modify content completed in previous steps
- 🚫 FORBIDDEN to modify content during this step
- 💬 Maintain continuity with previous sessions
- 🚪 DETECT exact continuation point from frontmatter
- 🚪 DETECT exact continuation point from frontmatter of incomplete file {outputFile}
## EXECUTION PROTOCOLS:
@ -60,39 +57,19 @@ To resume the nutrition planning workflow from where it was left off, ensuring s
### 1. Analyze Current State
Review the frontmatter to understand:
Review the frontmatter of {outputFile} to understand:
- `stepsCompleted`: Which steps are already done
- `lastStep`: The most recently completed step number
- `userProfile`: User information already collected
- `nutritionGoals`: Goals already established
- All other frontmatter variables
- `stepsCompleted`: Which steps are already done, the rightmost value of the array is the last step completed. For example stepsCompleted: [1, 2, 3] would mean that steps 1, then 2, and then 3 were finished.
Examine the nutrition-plan.md template to understand:
### 2. Read the full step of every completed step
- What sections are already completed
- What recommendations have been made
- Current progress through the plan
- Any notes or adjustments documented
- read each step file that corresponds to the stepsCompleted > 1.
### 2. Confirm Continuation Point
EXAMPLE: In the example `stepsCompleted: [1, 2, 3]` your would find the step 2 file by file name (step-02-profile.md) and step 3 file (step-03-assessment.md). the last file in the array is the last one completed, so you will follow the instruction to know what the next step to start processing is. reading that file would for example show that the next file is `steps/step-04-strategy.md`.
Based on `lastStep`, prepare to continue with:
### 3. Review the output completed previously
- If `lastStep` = "init" → Continue to Step 3: Dietary Assessment
- If `lastStep` = "assessment" → Continue to Step 4: Meal Strategy
- If `lastStep` = "strategy" → Continue to Step 5/6 based on cooking frequency
- If `lastStep` = "shopping" → Continue to Step 6: Prep Schedule
### 3. Update Status
Before proceeding, update frontmatter:
```yaml
stepsCompleted: [existing steps]
lastStep: current
continuationDate: [current date]
```
In addition to reading ONLY each step file that was completed, you will then read the {outputFile} to further understand what is done so far.
### 4. Welcome Back Dialog
@ -103,7 +80,6 @@ continuationDate: [current date]
- Briefly summarize progress made
- Confirm any changes since last session
- Validate that user is still aligned with goals
- Proceed to next appropriate step
### 6. Present MENU OPTIONS
@ -118,19 +94,13 @@ Display: **Resuming workflow - Select an Option:** [C] Continue
#### Menu Handling Logic:
- IF C: Update frontmatter with continuation info, then load, read entire file, then execute appropriate next step based on `lastStep`
- IF lastStep = "init": load {workflow_path}/step-03-assessment.md
- IF lastStep = "assessment": load {workflow_path}/step-04-strategy.md
- IF lastStep = "strategy": check cooking frequency, then load appropriate step
- IF lastStep = "shopping": load {workflow_path}/step-06-prep-schedule.md
- IF C: follow the suggestion of the last completed step reviewed to continue as it suggested
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options)
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and continuation analysis is complete, will you then update frontmatter and load, read entire file, then execute the appropriate next step file.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:

2
src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md
View File

@ -53,7 +53,7 @@ To gather comprehensive user profile information through collaborative conversat
- 🎯 Engage in natural conversation to gather profile information
- 💾 After collecting all information, append to {outputFile}
- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step
- 📖 Update frontmatter `stepsCompleted` to add 2 at the end of the array before loading next step
- 🚫 FORBIDDEN to load next step until user selects 'C' and content is saved
## CONTEXT BOUNDARIES:

1
src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md
View File

@ -57,6 +57,7 @@ To analyze nutritional requirements, identify restrictions, and calculate target
- 🎯 Use data from CSV files for comprehensive analysis
- 💾 Calculate macros based on profile and goals
- 📖 Document all findings in nutrition-plan.md
- 📖 Update frontmatter `stepsCompleted` to add 3 at the end of the array before loading next step
- 🚫 FORBIDDEN to prescribe medical nutrition therapy
## CONTEXT BOUNDARIES:

4
src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md
View File

@ -168,8 +168,8 @@ Display: **Select an Option:** [A] Meal Variety Optimization [P] Chef & Dietitia
- HALT and AWAIT ANSWER
- IF A: Execute `{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml`
- IF P: Execute `{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md`
- IF C: Save content to nutrition-plan.md, update frontmatter, check cooking frequency:
- IF P: Execute `{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md` with a chef and dietitian expert also as part of the party
- IF C: Save content to nutrition-plan.md, update frontmatter `stepsCompleted` to add 4 at the end of the array before loading next step, check cooking frequency:
- IF cooking frequency > 2x/week: load, read entire file, then execute `{workflow_path}/step-05-shopping.md`
- IF cooking frequency ≤ 2x/week: load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md`
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options)

2
src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md
View File

@ -159,7 +159,7 @@ Display: **Select an Option:** [A] Budget Optimization Strategies [P] Shopping P
- HALT and AWAIT ANSWER
- IF A: Execute `{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml`
- IF P: Execute `{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md`
- IF C: Save content to nutrition-plan.md, update frontmatter, then load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md`
- IF C: Save content to nutrition-plan.md, update frontmatter `stepsCompleted` to add 5 at the end of the array before loading next step, then load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md`
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options)
## CRITICAL STEP COMPLETION NOTE

4
src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md
View File

@ -180,14 +180,14 @@ Display: **Select an Option:** [A] Advanced Prep Techniques [P] Coach Perspectiv
- HALT and AWAIT ANSWER
- IF A: Execute `{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml`
- IF P: Execute `{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md`
- IF C: Update frontmatter with all steps completed, mark workflow complete, display final message
- IF C: update frontmatter `stepsCompleted` to add 6 at the end of the array before loading next step, mark workflow complete, display final message
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options)
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and content is saved to document:
1. Update frontmatter with all steps completed and indicate final completion
1. update frontmatter `stepsCompleted` to add 6 at the end of the array before loading next step completed and indicate final completion
2. Display final completion message
3. End workflow session

4
src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md
View File

@ -49,9 +49,9 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading
Load and read full config from {project-root}/{bmad_folder}/bmm/config.yaml and resolve:
Load and read full config from {project-root}/{bmad_folder}/core/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `user_skill_level`
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`
### 2. First Step EXECUTION

6
src/modules/bmb/workflows/create-agent/data/validation-complete.md
View File

@ -81,10 +81,10 @@
**Agent Documentation References**
- Agent compilation guide: `{project-root}/.bmad/bmb/docs/agents/agent-compilation.md`
- Agent types guide: `{project-root}/.bmad/bmb/docs/agents/understanding-agent-types.md`
- Agent compilation guide: `{project-root}/{bmad_folder}/bmb/docs/agents/agent-compilation.md`
- Agent types guide: `{project-root}/{bmad_folder}/bmb/docs/agents/understanding-agent-types.md`
- Architecture docs: simple, expert, module agent architectures
- Menu patterns guide: `{project-root}/.bmad/bmb/docs/agents/agent-menu-patterns.md`
- Menu patterns guide: `{project-root}/{bmad_folder}/bmb/docs/agents/agent-menu-patterns.md`
- Status: ✅ ALL REFERENCES PRESERVED
**Communication Presets**

6
src/modules/bmb/workflows/create-agent/steps/step-01-brainstorm.md
View File

@ -10,11 +10,11 @@ thisStepFile: '{workflow_path}/steps/step-01-brainstorm.md'
nextStepFile: '{workflow_path}/steps/step-02-discover.md'
workflowFile: '{workflow_path}/workflow.md'
brainstormContext: '{workflow_path}/data/brainstorm-context.md'
brainstormWorkflow: '{project-root}/.bmad/core/workflows/brainstorming/workflow.md'
brainstormWorkflow: '{project-root}/{bmad_folder}/core/workflows/brainstorming/workflow.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 1: Optional Brainstorming

6
src/modules/bmb/workflows/create-agent/steps/step-02-discover.md
View File

@ -10,7 +10,7 @@ thisStepFile: '{workflow_path}/steps/step-02-discover.md'
nextStepFile: '{workflow_path}/steps/step-03-persona.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/agent-purpose-{project_name}.md'
agentTypesGuide: '{project-root}/.bmad/bmb/docs/agents/understanding-agent-types.md'
agentTypesGuide: '{project-root}/{bmad_folder}/bmb/docs/agents/understanding-agent-types.md'
simpleExamples: '{workflow_path}/data/reference/agents/simple-examples/'
expertExamples: '{workflow_path}/data/reference/agents/expert-examples/'
moduleExamples: '{workflow_path}/data/reference/agents/module-examples/'
@ -19,8 +19,8 @@ moduleExamples: '{workflow_path}/data/reference/agents/module-examples/'
agentPurposeTemplate: '{workflow_path}/templates/agent-purpose-and-type.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 2: Discover Agent Purpose and Type

6
src/modules/bmb/workflows/create-agent/steps/step-03-persona.md
View File

@ -11,14 +11,14 @@ nextStepFile: '{workflow_path}/steps/step-04-commands.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/agent-persona-{project_name}.md'
communicationPresets: '{workflow_path}/data/communication-presets.csv'
agentMenuPatterns: '{project-root}/.bmad/bmb/docs/agents/agent-menu-patterns.md'
agentMenuPatterns: '{project-root}/{bmad_folder}/bmb/docs/agents/agent-menu-patterns.md'
# Template References
personaTemplate: '{workflow_path}/templates/agent-persona.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 3: Shape Agent's Personality

12
src/modules/bmb/workflows/create-agent/steps/step-04-commands.md
View File

@ -10,17 +10,17 @@ thisStepFile: '{workflow_path}/steps/step-04-commands.md'
nextStepFile: '{workflow_path}/steps/step-05-name.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/agent-commands-{project_name}.md'
agentMenuPatterns: '{project-root}/.bmad/bmb/docs/agents/agent-menu-patterns.md'
simpleArchitecture: '{project-root}/.bmad/bmb/docs/agents/simple-agent-architecture.md'
expertArchitecture: '{project-root}/.bmad/bmb/docs/agents/expert-agent-architecture.md'
moduleArchitecture: '{project-root}/.bmad/bmb/docs/agents/module-agent-architecture.md'
agentMenuPatterns: '{project-root}/{bmad_folder}/bmb/docs/agents/agent-menu-patterns.md'
simpleArchitecture: '{project-root}/{bmad_folder}/bmb/docs/agents/simple-agent-architecture.md'
expertArchitecture: '{project-root}/{bmad_folder}/bmb/docs/agents/expert-agent-architecture.md'
moduleArchitecture: '{project-root}/{bmad_folder}/bmb/docs/agents/module-agent-architecture.md'
# Template References
commandsTemplate: '{workflow_path}/templates/agent-commands.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 4: Build Capabilities and Commands

4
src/modules/bmb/workflows/create-agent/steps/step-05-name.md
View File

@ -15,8 +15,8 @@ outputFile: '{output_folder}/agent-identity-{project_name}.md'
identityTemplate: '{workflow_path}/templates/agent-identity.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 5: Agent Naming and Identity

6
src/modules/bmb/workflows/create-agent/steps/step-06-build.md
View File

@ -10,15 +10,15 @@ thisStepFile: '{workflow_path}/steps/step-06-build.md'
nextStepFile: '{workflow_path}/steps/step-07-validate.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/agent-yaml-{project_name}.md'
moduleOutputFile: '{project-root}/.bmad/{target_module}/agents/{agent_filename}.agent.yaml'
moduleOutputFile: '{project-root}/{bmad_folder}/{target_module}/agents/{agent_filename}.agent.yaml'
standaloneOutputFile: '{workflow_path}/data/{agent_filename}/{agent_filename}.agent.yaml'
# Template References
completeAgentTemplate: '{workflow_path}/templates/agent-complete-{agent_type}.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 6: Build Complete Agent YAML

6
src/modules/bmb/workflows/create-agent/steps/step-07-validate.md
View File

@ -10,15 +10,15 @@ thisStepFile: '{workflow_path}/steps/step-07-validate.md'
nextStepFile: '{workflow_path}/steps/step-08-setup.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/agent-validation-{project_name}.md'
agentValidationChecklist: '{project-root}/.bmad/bmb/workflows/create-agent/agent-validation-checklist.md'
agentValidationChecklist: '{project-root}/{bmad_folder}/bmb/workflows/create-agent/agent-validation-checklist.md'
agentFile: '{{output_file_path}}'
# Template References
validationTemplate: '{workflow_path}/templates/validation-results.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 7: Quality Check and Validation

4
src/modules/bmb/workflows/create-agent/steps/step-08-setup.md
View File

@ -16,8 +16,8 @@ agentSidecarFolder: '{{standalone_output_folder}}/{{agent_filename}}-sidecar'
sidecarTemplate: '{workflow_path}/templates/expert-sidecar-structure.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 8: Expert Agent Workspace Setup

6
src/modules/bmb/workflows/create-agent/steps/step-09-customize.md
View File

@ -10,14 +10,14 @@ thisStepFile: '{workflow_path}/steps/step-09-customize.md'
nextStepFile: '{workflow_path}/steps/step-10-build-tools.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/agent-customization-{project_name}.md'
configOutputFile: '{project-root}/.bmad/_cfg/agents/{target_module}-{agent_filename}.customize.yaml'
configOutputFile: '{project-root}/{bmad_folder}/_cfg/agents/{target_module}-{agent_filename}.customize.yaml'
# Template References
customizationTemplate: '{workflow_path}/templates/agent-customization.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 9: Optional Customization File

4
src/modules/bmb/workflows/create-agent/steps/step-10-build-tools.md
View File

@ -17,8 +17,8 @@ compiledAgentFile: '{{output_folder}}/{{agent_filename}}.md'
buildHandlingTemplate: '{workflow_path}/templates/build-results.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 10: Build Tools Handling

4
src/modules/bmb/workflows/create-agent/steps/step-11-celebrate.md
View File

@ -16,8 +16,8 @@ compiledAgentFile: '{{compiled_agent_path}}'
completionTemplate: '{workflow_path}/templates/completion-summary.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 11: Celebration and Next Steps

20
src/modules/bmb/workflows/create-agent/workflow.md
View File

@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading
Load and read full config from `{project-root}/.bmad/bmb/config.yaml`:
Load and read full config from `{project-root}/{bmad_folder}/bmb/config.yaml`:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`
@ -63,12 +63,12 @@ Load, read completely, then execute `steps/step-01-brainstorm.md` to begin the w
# Technical documentation for agent building
agent_compilation: "{project-root}/.bmad/bmb/docs/agents/agent-compilation.md"
understanding_agent_types: "{project-root}/.bmad/bmb/docs/agents/understanding-agent-types.md"
simple_agent_architecture: "{project-root}/.bmad/bmb/docs/agents/simple-agent-architecture.md"
expert_agent_architecture: "{project-root}/.bmad/bmb/docs/agents/expert-agent-architecture.md"
module_agent_architecture: "{project-root}/.bmad/bmb/docs/agents/module-agent-architecture.md"
agent_menu_patterns: "{project-root}/.bmad/bmb/docs/agents/agent-menu-patterns.md"
agent_compilation: "{project-root}/{bmad_folder}/bmb/docs/agents/agent-compilation.md"
understanding_agent_types: "{project-root}/{bmad_folder}/bmb/docs/agents/understanding-agent-types.md"
simple_agent_architecture: "{project-root}/{bmad_folder}/bmb/docs/agents/simple-agent-architecture.md"
expert_agent_architecture: "{project-root}/{bmad_folder}/bmb/docs/agents/expert-agent-architecture.md"
module_agent_architecture: "{project-root}/{bmad_folder}/bmb/docs/agents/module-agent-architecture.md"
agent_menu_patterns: "{project-root}/{bmad_folder}/bmb/docs/agents/agent-menu-patterns.md"
# Data and templates
@ -83,9 +83,9 @@ module_agent_examples: "{project-root}/src/modules/bmb/reference/agents/module-e
# Output configuration
custom_agent_location: "{project-root}/.bmad/custom/src/agents"
module_output_file: "{project-root}/.bmad/{target_module}/agents/{agent_filename}.agent.yaml"
custom_agent_location: "{project-root}/{bmad_folder}/custom/src/agents"
module_output_file: "{project-root}/{bmad_folder}/{target_module}/agents/{agent_filename}.agent.yaml"
standalone_output_folder: "{custom_agent_location}/{agent_filename}"
standalone_output_file: "{standalone_output_folder}/{agent_filename}.agent.yaml"
standalone_info_guide: "{standalone_output_folder}/info-and-installation-guide.md"
config_output_file: "{project-root}/.bmad/\_cfg/agents/{target_module}-{agent_filename}.customize.yaml"
config_output_file: "{project-root}/{bmad_folder}/\_cfg/agents/{target_module}-{agent_filename}.customize.yaml"

105
src/modules/bmb/workflows/create-workflow/steps/step-01-init.md
View File

@ -1,6 +1,6 @@
---
name: 'step-01-init'
description: 'Initialize workflow creation session by detecting continuation state and setting up project'
description: 'Initialize workflow creation session by gathering project information and setting up unique workflow folder'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
@ -9,24 +9,19 @@ workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
thisStepFile: '{workflow_path}/steps/step-01-init.md'
nextStepFile: '{workflow_path}/steps/step-02-gather.md'
workflowFile: '{workflow_path}/workflow.md'
# Output files for workflow creation process
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
# Template References
projectInfoTemplate: '{workflow_path}/templates/project-info.md'
workflowPlanTemplate: '{workflow_path}/templates/workflow-plan.md'
# No workflow plan template needed - will create plan file directly
---
# Step 1: Workflow Creation Initialization
## STEP GOAL:
To initialize the workflow creation process by detecting continuation state, understanding project context, and preparing for collaborative workflow design.
To initialize the workflow creation process by understanding project context, determining a unique workflow name, and preparing for collaborative workflow design.
## MANDATORY EXECUTION RULES (READ FIRST):
@ -50,7 +45,7 @@ To initialize the workflow creation process by detecting continuation state, und
- 🎯 Focus ONLY on initialization and project understanding
- 🚫 FORBIDDEN to start designing workflow steps in this step
- 💬 Ask questions conversationally to understand context
- 🚪 DETECT existing workflow state and handle continuation properly
- 🚪 ENSURE unique workflow naming to avoid conflicts
## EXECUTION PROTOCOLS:
@ -68,35 +63,7 @@ To initialize the workflow creation process by detecting continuation state, und
## INITIALIZATION SEQUENCE:
### 1. Check for Existing Workflow Creation
First, check if there's already a workflow folder with the proposed name:
- Look for folder at `{custom_workflow_location}/{new_workflow_name}/`
- If exists, check if it contains a workflow.md file
- If not exists, this is a fresh workflow creation session
### 2. Handle Continuation (If Workflow Exists)
If the workflow folder exists and has been worked on:
- **STOP here** and continue with step 4 (Welcome Back)
- Do not proceed with fresh initialization
- Let step 4 handle the continuation logic
### 3. Handle Completed Workflow
If the workflow folder exists AND is complete:
- Ask user: "I found an existing workflow '{new_workflow_name}' from [date]. Would you like to:
1. Create a new workflow with a different name
2. Review or modify the existing workflow"
- If option 1: Get a new workflow name
- If option 2: Load step 5 (Review)
### 4. Fresh Workflow Setup (If No Workflow)
#### A. Project Discovery
### 1. Project Discovery
Welcome the user and understand their needs:
"Welcome! I'm excited to help you create a new workflow. Let's start by understanding what you want to build."
@ -107,33 +74,55 @@ Ask conversationally:
- What problem will this workflow solve?
- Who will use this workflow?
- What module will it belong to (bmb, bmm, cis, custom, stand-alone)?
- What would you like to name this workflow folder? (kebab-case, e.g., "user-story-generator")
#### B. Create Workflow Plan Document
Also, Ask / suggest a workflow name / folder: (kebab-case, e.g., "user-story-generator")
Create the workflow plan document at `{workflowPlanFile}` using the workflow plan template `{workflowPlanTemplate}`.
Initialize frontmatter with:
### 2. Ensure Unique Workflow Name
```yaml
After getting the workflow name:
**Check for existing workflows:**
- Look for folder at `{custom_workflow_location}/{new_workflow_name}/`
- If it exists, inform the user and suggest or get from them a unique name or postfix
**Example alternatives:**
- Original: "user-story-generator"
- Alternatives: "user-story-creator", "user-story-generator-2025", "user-story-generator-enhanced"
**Loop until we have a unique name that doesn't conflict.**
### 3. Determine Target Location
Based on the module selection, confirm the target location:
- For bmb module: `{custom_workflow_location}` (defaults to `{bmad_folder}/custom/src/workflows`)
- For other modules: Check their install-config.yaml for custom workflow locations
- Confirm the exact folder path where the workflow will be created
- Store the confirmed path as `{targetWorkflowPath}`
### 4. Create Workflow Plan Document
Create the workflow plan document at `{workflowPlanFile}` with the following initial content:
```markdown
---
workflowName: ''
targetModule: ''
workflowType: ''
flowPattern: ''
date: [current date]
user_name: { user_name }
stepsCompleted: [1]
lastStep: 'init'
---
# Workflow Creation Plan: {new_workflow_name}
## Initial Project Context
- **Module:** [module from user]
- **Target Location:** {targetWorkflowPath}
- **Created:** [current date]
```
This plan will capture all requirements and design details before building the actual workflow.
### 5. Welcome Message
"Great! I'm ready to help you create a structured workflow using our step-based architecture. We'll work together to design a workflow that's collaborative, maintainable, and follows best practices."
### 6. Present MENU OPTIONS
### 5. Present MENU OPTIONS
Display: **Proceeding to requirements gathering...**
@ -145,7 +134,7 @@ Display: **Proceeding to requirements gathering...**
#### Menu Handling Logic:
- After setup completion, immediately load, read entire file, then execute `{workflow_path}/step-02-gather.md` to begin requirements gathering
- After setup completion and the workflow folder with the workflow plan file created already, only then immediately load, read entire file, and then execute `{workflow_path}/steps/step-02-gather.md` to begin requirements gathering
---

38
src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md
View File

@ -7,18 +7,16 @@ workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-02-gather.md'
nextStepFile: '{workflow_path}/steps/step-03-tools-overview.md'
workflowFile: '{workflow_path}/workflow.md'
nextStepFile: '{workflow_path}/steps/step-03-tools-configuration.md'
# Output files for workflow creation process
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Template References
requirementsTemplate: '{workflow_path}/templates/requirements-section.md'
# No template needed - will append requirements directly to workflow plan
---
# Step 2: Requirements Gathering
@ -156,25 +154,7 @@ Define what the workflow produces:
- Should outputs be saved automatically?
- What format should outputs be in?
### 8. Target Location and Module Configuration
Determine where the workflow will be created:
- For bmb module: Workflows go to `{custom_workflow_location}` (defaults to `{bmad_folder}/custom/src/workflows`)
- For other modules: Check their install-config.yaml for custom workflow locations
- Confirm the exact folder path where the workflow will be created
- Ensure the folder name doesn't conflict with existing workflows
### 9. Technical Constraints
Discuss technical requirements:
- Any specific tools or dependencies needed?
- Does it need to integrate with other systems?
- Any performance considerations?
- Should it be standalone or callable by other workflows?
### 10. Success Criteria
### 8. Success Criteria
Define what makes the workflow successful:
@ -183,13 +163,11 @@ Define what makes the workflow successful:
- Are there measurable outcomes?
- What would make a user satisfied with the result?
## STORE REQUIREMENTS:
#### STORE REQUIREMENTS:
After collecting all requirements, append them to {workflowPlanFile} using {requirementsTemplate}:
After collecting all requirements, append them to {workflowPlanFile} in a format that will be be used later to design in more detail and create the workflow structure.
This information will be used in the design phase to create the workflow structure.
### 8. Present MENU OPTIONS
### 9. Present MENU OPTIONS
Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
@ -210,7 +188,7 @@ Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Conti
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and requirements are stored, will you then load, read entire file, then execute {nextStepFile} to execute and begin workflow structure design step.
ONLY WHEN C is selected and requirements are stored in the output file, will you then load, read entire file, then execute {nextStepFile} to execute and begin workflow structure design step.
---

250
src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md Normal file
View File

@ -0,0 +1,250 @@
---
name: 'step-03-tools-configuration'
description: 'Configure all required tools (core, memory, external) and installation requirements in one comprehensive step'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-03-tools-configuration.md'
nextStepFile: '{workflow_path}/steps/step-04-plan-review.md'
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
# Documentation References
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Template References
# No template needed - will append tools configuration directly to workflow plan
---
# Step 3: Tools Configuration
## STEP GOAL:
To comprehensively configure all tools needed for the workflow (core tools, memory, external tools) and determine installation requirements.
## 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 workflow architect and integration 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 expertise in BMAD tools and integration patterns
- ✅ User brings their workflow requirements and preferences
### Step-Specific Rules:
- 🎯 Focus ONLY on configuring tools based on workflow requirements
- 🚫 FORBIDDEN to skip tool categories - each affects workflow design
- 💬 Present options clearly, let user make informed choices
- 🚫 DO NOT hardcode tool descriptions - reference CSV
## EXECUTION PROTOCOLS:
- 🎯 Load tools dynamically from CSV, not hardcoded
- 💾 Document all tool choices in workflow plan
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step
- 🚫 FORBIDDEN to load next step until user selects 'C'
## CONTEXT BOUNDARIES:
- Requirements from step 2 inform tool selection
- All tool choices affect workflow design
- This is the ONLY tools configuration step
- Installation requirements affect implementation decisions
## TOOLS CONFIGURATION PROCESS:
### 1. Initialize Tools Configuration
"Configuring **Tools and Integrations**
Based on your workflow requirements, let's configure all the tools your workflow will need. This includes core BMAD tools, memory systems, and any external integrations."
### 2. Load and Present Available Tools
Load `{commonToolsCsv}` and present tools by category:
"**Available BMAD Tools and Integrations:**
**Core Tools (Always Available):**
- [List tools from CSV where propose='always', with descriptions]
**Optional Tools (Available When Needed):**
- [List tools from CSV where propose='example', with descriptions]
_Note: I'm loading these dynamically from our tools database to ensure you have the most current options._"
### 3. Configure Core BMAD Tools
"**Core BMAD Tools Configuration:**
These tools significantly enhance workflow quality and user experience:"
For each core tool from CSV (`propose='always'`):
1. **Party-Mode**
- Use case: [description from CSV]
- Where to integrate: [ask user for decision points, creative phases]
2. **Advanced Elicitation**
- Use case: [description from CSV]
- Where to integrate: [ask user for quality gates, review points]
3. **Brainstorming**
- Use case: [description from CSV]
- Where to integrate: [ask user for idea generation, innovation points]
### 4. Configure LLM Features
"**LLM Feature Integration:**
These capabilities enhance what your workflow can do:"
From CSV (`propose='always'` LLM features):
4. **Web-Browsing**
- Capability: [description from CSV]
- When needed: [ask user about real-time data needs]
5. **File I/O**
- Capability: [description from CSV]
- Operations: [ask user about file operations needed]
6. **Sub-Agents**
- Capability: [description from CSV]
- Use cases: [ask user about delegation needs]
7. **Sub-Processes**
- Capability: [description from CSV]
- Use cases: [ask user about parallel processing needs]
### 5. Configure Memory Systems
"**Memory and State Management:**
Determine if your workflow needs to maintain state between sessions:"
From CSV memory tools:
8. **Sidecar File**
- Use case: [description from CSV]
- Needed when: [ask about session continuity, agent initialization]
### 6. Configure External Tools (Optional)
"**External Integrations (Optional):**
These tools connect your workflow to external systems:"
From CSV (`propose='example'`):
- MCP integrations, database connections, APIs, etc.
- For each relevant tool: present description and ask if needed
- Note any installation requirements
### 7. Installation Requirements Assessment
"**Installation and Dependencies:**
Some tools require additional setup:"
Based on selected tools:
- Identify tools requiring installation
- Assess user's comfort level with installations
- Document installation requirements
### 8. Document Complete Tools Configuration
Append to {workflowPlanFile}:
```markdown
## Tools Configuration
### Core BMAD Tools
- **Party-Mode**: [included/excluded] - Integration points: [specific phases]
- **Advanced Elicitation**: [included/excluded] - Integration points: [specific phases]
- **Brainstorming**: [included/excluded] - Integration points: [specific phases]
### LLM Features
- **Web-Browsing**: [included/excluded] - Use cases: [specific needs]
- **File I/O**: [included/excluded] - Operations: [file management needs]
- **Sub-Agents**: [included/excluded] - Use cases: [delegation needs]
- **Sub-Processes**: [included/excluded] - Use cases: [parallel processing needs]
### Memory Systems
- **Sidecar File**: [included/excluded] - Purpose: [state management needs]
### External Integrations
- [List selected external tools with purposes]
### Installation Requirements
- [List tools requiring installation]
- **User Installation Preference**: [willing/not willing]
- **Alternative Options**: [if not installing certain tools]
```
### 9. Present MENU OPTIONS
Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
#### 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
- User can chat or ask questions - always respond and then end with display again of the menu options
- Use menu handling logic section below
#### Menu Handling Logic:
- IF A: Execute {advancedElicitationTask}
- IF P: Execute {partyModeWorkflow}
- IF C: Save tools configuration to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile}
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#9-present-menu-options)
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and tools configuration is saved will you load {nextStepFile} to review the complete plan.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- All tool categories configured based on requirements
- User made informed choices for each tool
- Complete configuration documented in plan
- Installation requirements identified
- Ready to proceed to plan review
### ❌ SYSTEM FAILURE:
- Skipping tool categories
- Hardcoding tool descriptions instead of using CSV
- Not documenting user choices
- Proceeding without user confirmation
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

127
src/modules/bmb/workflows/create-workflow/steps/step-03-tools-overview.md
View File

@ -1,127 +0,0 @@
---
name: 'step-03-tools-overview'
description: 'Present available tools from CSV and gather initial user requirements'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-03-tools-overview.md'
nextStepFile: '{workflow_path}/steps/step-04-core-tools.md'
workflowFile: '{workflow_path}/workflow.md'
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
# Documentation References
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
---
# Step 3: Tools Overview
## STEP GOAL:
Load and present available tools from the CSV, then gather the user's general tool requirements for their workflow.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are a workflow architect and integration specialist
- ✅ We engage in collaborative dialogue, not command-response
- ✅ You bring expertise in BMAD tools and workflow optimization
- ✅ User brings their workflow requirements
## EXECUTION PROTOCOLS:
- 🎯 Load CSV and present tools dynamically
- 💾 Gather user's general tool requirements
- 📖 Document requirements in workflow plan
- 🚫 FORBIDDEN to proceed without user input
## SEQUENCE OF INSTRUCTIONS:
### 1. Initialize Tools Discussion
"Beginning **Tools Integration and Configuration**
Based on your workflow requirements, I'll help identify the best tools and integrations. Let me first load the available tools from our reference."
### 2. Load and Present Available Tools
Load `{commonToolsCsv}` and present tools organized by type:
"**Available BMAD Tools and Integrations:**
**Always Available (Recommended for Most Workflows):**
- [List tools from CSV where propose='always', organized by type]
**Example Tools (Available When Needed):**
- [List tools from CSV where propose='example', organized by type]
\*\*Tools requiring installation will be noted."
### 3. Gather Initial Requirements
"**Your Tool Requirements:**
Based on your workflow type and goals, what tools do you anticipate needing?
1. **Core BMAD Tools:** Do you want collaborative idea generation, critical evaluation, or brainstorming capabilities?
2. **LLM Features:** Will you need web access, file management, sub-agents, or parallel processing?
3. **Memory:** Does your workflow need persistent state across sessions?
4. **External Tools:** Will you need MCP integrations like documentation access, browser automation, or database connections?
**Initial Tool Preferences:** [gather user's general requirements]"
### 4. Document Requirements
Append to {workflowPlanFile}:
```markdown
## Tool Requirements Summary
**Initial Tool Preferences:**
- Core BMAD Tools: [user selections]
- LLM Features: [user selections]
- Memory Requirements: [user selections]
- External Tools: [user selections]
**Installation Willingness:** [user comfort level with installing tools]
```
### 5. Menu Options
Display: **Select an Option:** [C] Continue to Core Tools [M] Modify Requirements
#### Menu Handling Logic:
- IF C: Append tools overview to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
- IF M: Refine requirements discussion
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and requirements are documented will you load {nextStepFile} to configure core tools.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- CSV loaded and tools presented clearly
- User's initial tool requirements gathered
- Requirements documented in workflow plan
- User ready to proceed to detailed configuration
### ❌ SYSTEM FAILURE:
- Not loading tools from CSV
- Duplicating CSV content in step file
- Proceeding without user requirements input

145
src/modules/bmb/workflows/create-workflow/steps/step-04-core-tools.md
View File

@ -1,145 +0,0 @@
---
name: 'step-04-core-tools'
description: 'Configure always-available core tools and their integration points'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-04-core-tools.md'
nextStepFile: '{workflow_path}/steps/step-05-memory-requirements.md'
workflowFile: '{workflow_path}/workflow.md'
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
# Documentation References
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
---
# Step 4: Core Tools Configuration
## STEP GOAL:
Configure always-available core tools (party-mode, advanced-elicitation, brainstorming, and LLM features) with specific integration points in the workflow.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are a workflow architect and integration specialist
- ✅ We engage in collaborative dialogue, not command-response
- ✅ You bring expertise in BMAD tools and integration patterns
## EXECUTION PROTOCOLS:
- 🎯 Load core tools from CSV and configure integration points
- 💾 Confirm user choices for each core tool
- 📖 Document configuration in workflow plan
- 🚫 FORBIDDEN to proceed without user confirmation
## SEQUENCE OF INSTRUCTIONS:
### 1. Initialize Core Tools Configuration
"Configuring **Core BMAD Tools and Features**
These core tools significantly enhance workflow quality. Let's configure each one for optimal integration into your workflow."
### 2. Present Core Tools from CSV
Load `{commonToolsCsv}` and filter for `propose='always'`:
"**Core Tools (Always Available):**
**Workflows & Tasks:**
- **Party-Mode:** [description from CSV]
- **Advanced Elicitation:** [description from CSV]
- **Brainstorming:** [description from CSV]
**LLM Tool Features:**
- **Web-Browsing:** [description from CSV]
- **File I/O:** [description from CSV]
- **Sub-Agents:** [description from CSV]
- **Sub-Processes:** [description from CSV]
**Tool-Memory:**
- **Sidecar File:** [description from CSV]"
### 3. Configure Integration Points
For each tool, ask about integration:
"**Core Tools Integration:**
**Workflows & Tasks:**
1. **Party-Mode** - Where should collaborative AI sessions be offered? [decision points, creative phases]
2. **Advanced Elicitation** - Where should critical evaluation checkpoints be placed? [after content creation, quality gates]
3. **Brainstorming** - Where should creative ideation be integrated? [idea generation phases, innovation points]
**LLM Features:** 4. **Web-Browsing** - When is current information needed? [real-time data, current events] 5. **File I/O** - What document operations are required? [file creation, data management] 6. **Sub-Agents** - Where would specialized delegation help? [complex tasks, parallel processing] 7. **Sub-Processes** - Where would parallel processing improve performance? [long operations, resource optimization]
**Tool-Memory:** 8. **Sidecar File** - Does your workflow need persistent state? [session continuity, agent initialization]"
### 4. Document Core Tools Configuration
Append to {workflowPlanFile}:
```markdown
## Core Tools Configuration
### Workflows & Tasks
**Party-Mode:** [included/excluded] - Integration points: [specific phases]
**Advanced Elicitation:** [included/excluded] - Integration points: [specific phases]
**Brainstorming:** [included/excluded] - Integration points: [specific phases]
### LLM Tool Features
**Web-Browsing:** [included/excluded] - Integration points: [specific phases]
**File I/O:** [included/excluded] - Integration points: [specific phases]
**Sub-Agents:** [included/excluded] - Integration points: [specific phases]
**Sub-Processes:** [included/excluded] - Integration points: [specific phases]
### Tool-Memory
**Sidecar File:** [included/excluded] - Use case: [history tracking, agent initialization]
```
### 5. Menu Options
Display: **Select an Option:** [C] Continue to Memory Configuration [M] Modify Core Tools
#### Menu Handling Logic:
- IF C: Append core tools configuration to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
- IF M: Return to tool configuration
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and core tools are documented will you load {nextStepFile} to configure memory requirements.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Core tools presented using CSV descriptions
- Integration points configured for each selected tool
- Configuration documented in workflow plan
- User understands how tools enhance workflow
### ❌ SYSTEM FAILURE:
- Duplicating CSV content instead of referencing it
- Not confirming integration points with user
- Proceeding without user confirmation of configuration

216
src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md Normal file
View File

@ -0,0 +1,216 @@
---
name: 'step-04-plan-review'
description: 'Review complete workflow plan (requirements + tools) and get user approval before design'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-04-plan-review.md'
nextStepFormDesign: '{workflow_path}/steps/step-05-output-format-design.md'
nextStepDesign: '{workflow_path}/steps/step-06-design.md'
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Template References
# No template needed - will append review summary directly to workflow plan
---
# Step 4: Plan Review and Approval
## STEP GOAL:
To present the complete workflow plan (requirements and tools configuration) for user review and approval before proceeding to design.
## 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 workflow architect and systems designer
- ✅ 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 expertise in workflow design review and quality assurance
- ✅ User brings their specific requirements and approval authority
### Step-Specific Rules:
- 🎯 Focus ONLY on reviewing and refining the plan
- 🚫 FORBIDDEN to start designing workflow steps in this step
- 💬 Present plan clearly and solicit feedback
- 🚫 DO NOT proceed to design without user approval
## EXECUTION PROTOCOLS:
- 🎯 Present complete plan summary from {workflowPlanFile}
- 💾 Capture any modifications or refinements
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step
- 🚫 FORBIDDEN to load next step until user approves plan
## CONTEXT BOUNDARIES:
- All requirements from step 2 are available
- Tools configuration from step 3 is complete
- Focus ONLY on review and approval
- This is the final check before design phase
## PLAN REVIEW PROCESS:
### 1. Initialize Plan Review
"**Workflow Plan Review**
We've gathered all requirements and configured tools for your workflow. Let's review the complete plan to ensure it meets your needs before we start designing the workflow structure."
### 2. Present Complete Plan Summary
Load and present from {workflowPlanFile}:
"**Complete Workflow Plan: {new_workflow_name}**
**1. Project Overview:**
- [Present workflow purpose, user type, module from plan]
**2. Workflow Requirements:**
- [Present all gathered requirements]
**3. Tools Configuration:**
- [Present selected tools and integration points]
**4. Technical Specifications:**
- [Present technical constraints and requirements]
**5. Success Criteria:**
- [Present success metrics from requirements]"
### 3. Detailed Review by Category
"**Detailed Review:**
**A. Workflow Scope and Purpose**
- Is the workflow goal clearly defined?
- Are the boundaries appropriate?
- Any missing requirements?
**B. User Interaction Design**
- Does the interaction style match your needs?
- Are collaboration points clear?
- Any adjustments needed?
**C. Tools Integration**
- Are selected tools appropriate for your workflow?
- Are integration points logical?
- Any additional tools needed?
**D. Technical Feasibility**
- Are all requirements achievable?
- Any technical constraints missing?
- Installation requirements acceptable?"
### 4. Collect Feedback and Refinements
"**Review Feedback:**
Please review each section and provide feedback:
1. What looks good and should stay as-is?
2. What needs modification or refinement?
3. What's missing that should be added?
4. Anything unclear or confusing?"
For each feedback item:
- Document the requested change
- Discuss implications on workflow design
- Confirm the refinement with user
### 5. Update Plan with Refinements
Update {workflowPlanFile} with any approved changes:
- Modify requirements section as needed
- Update tools configuration if changed
- Add any missing specifications
- Ensure all changes are clearly documented
### 6. Output Document Check
"**Output Document Check:**
Before we proceed to design, does your workflow produce any output documents or files?
Based on your requirements:
- [Analyze if workflow produces documents/files]
- Consider: Does it create reports, forms, stories, or any persistent output?"
**If NO:**
"Great! Your workflow focuses on actions/interactions without document output. We'll proceed directly to designing the workflow steps."
**If YES:**
"Perfect! Let's design your output format to ensure your workflow produces exactly what you need."
### 7. Present MENU OPTIONS
Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Design
#### 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
- User can chat or ask questions - always respond and then end with display again of the menu options
- Use menu handling logic section below
#### Menu Handling Logic:
- IF A: Execute {advancedElicitationTask}
- IF P: Execute {partyModeWorkflow}
- IF C: Check if workflow produces documents:
- If YES: Update frontmatter, then load nextStepFormDesign
- If NO: Update frontmatter, then load nextStepDesign
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected AND the user has explicitly approved the plan and the plan document is updated as needed, then you load either {nextStepFormDesign} or {nextStepDesign}
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Complete plan presented clearly from {workflowPlanFile}
- User feedback collected and documented
- All refinements incorporated
- User explicitly approves the plan
- Plan ready for design phase
### ❌ SYSTEM FAILURE:
- Not loading plan from {workflowPlanFile}
- Skipping review categories
- Proceeding without user approval
- Not documenting refinements
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

136
src/modules/bmb/workflows/create-workflow/steps/step-05-memory-requirements.md
View File

@ -1,136 +0,0 @@
---
name: 'step-05-memory-requirements'
description: 'Assess memory requirements and configure memory implementation'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-05-memory-requirements.md'
nextStepFile: '{project_path}/steps/step-06-external-tools.md'
workflowFile: '{workflow_path}/workflow.md'
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
# Documentation References
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
---
# Step 5: Memory Requirements Assessment
## STEP GOAL:
Assess whether the workflow needs memory capabilities and configure appropriate memory implementation.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are a workflow architect and integration specialist
- ✅ We engage in collaborative dialogue, not command-response
- ✅ You bring expertise in memory implementation patterns
## EXECUTION PROTOCOLS:
- 🎯 Assess memory needs based on workflow requirements
- 💾 Present memory options from CSV
- 📖 Configure memory implementation if needed
- 🚫 FORBIDDEN to push memory when not required
## SEQUENCE OF INSTRUCTIONS:
### 1. Initialize Memory Assessment
"Assessing **Memory Requirements**
Most workflows complete their task and exit without needing persistent memory. However, some specialized workflows benefit from session-to-session continuity."
### 2. Present Memory Options from CSV
Load `{commonToolsCsv}` and filter for `type='tool-memory'`:
"**Memory Options:**
**Available Memory Types:**
- [List tool-memory options from CSV with descriptions]
**Key Question:** Does your workflow need to maintain state across multiple sessions?"
### 3. Memory Requirements Analysis
"**Memory Assessment Questions:**
1. **Session Continuity:** Will your workflow need to resume where it left off?
2. **Agent Initialization:** Will your workflow initialize agents with previous context?
3. **Pattern Recognition:** Would semantic search of past experiences be valuable?
4. **Self-Improvement:** Will your workflow learn from previous executions?
**Most workflows:** No memory needed (they complete and exit)
**Some workflows:** Sidecar files for history tracking
**Advanced workflows:** Vector database for semantic learning"
### 4. Configure Memory (If Needed)
If user selects memory:
"**Memory Configuration:**
Based on your needs, which memory type?
1. **Sidecar File** - History tracking and session continuity
2. **Vector Database** - Semantic search and pattern recognition
3. **Both** - Comprehensive memory capabilities
4. **None** - No persistent memory required
**Memory Management:** Privacy controls, cleanup strategies, access patterns"
### 5. Document Memory Configuration
Append to {workflowPlanFile}:
```markdown
## Memory Configuration
### Memory Requirements
**Sidecar File:** [selected/not selected] - Use case: [specific implementation]
**Vector Database:** [selected/not selected] - Use case: [specific implementation]
**Memory Management:** [cleanup, privacy, access patterns]
**Integration:** [how memory enhances workflow continuity]
```
### 6. Menu Options
Display: **Select an Option:** [C] Continue to External Tools [M] Modify Memory
#### Menu Handling Logic:
- IF C: Append memory configuration to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
- IF M: Refine memory requirements
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and memory is documented will you load {nextStepFile} to configure external tools.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Memory options presented from CSV
- User's memory needs properly assessed
- Configuration documented appropriately
- No memory pushed when not needed
### ❌ SYSTEM FAILURE:
- Assuming memory is needed without assessment
- Duplicating CSV descriptions in step file
- Not documenting memory management strategies

289
src/modules/bmb/workflows/create-workflow/steps/step-05-output-format-design.md Normal file
View File

@ -0,0 +1,289 @@
---
name: 'step-05-output-format-design'
description: 'Design the output format for workflows that produce documents or files'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-05-output-format-design.md'
nextStepFile: '{workflow_path}/steps/step-06-design.md'
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 5: Output Format Design
## STEP GOAL:
To design and document the output format for workflows that produce documents or files, determining whether they need strict templates or flexible formatting.
## 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 workflow architect and output format 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 expertise in document design and template creation
- ✅ User brings their specific output requirements and preferences
### Step-Specific Rules:
- 🎯 Focus ONLY on output format design
- 🚫 FORBIDDEN to design workflow steps in this step
- 💬 Help user understand the format spectrum
- 🚫 DO NOT proceed without clear format requirements
## EXECUTION PROTOCOLS:
- 🎯 Guide user through format spectrum with examples
- 💾 Document format decisions in workflow plan
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before loading next step
- 🚫 FORBIDDEN to load next step until user selects 'C'
## CONTEXT BOUNDARIES:
- Approved plan from step 4 is available
- Focus ONLY on output document formatting
- Skip this step if workflow produces no documents
- This step only runs when documents need structure
## OUTPUT FORMAT DESIGN PROCESS:
### 1. Initialize Output Format Discussion
"**Designing Your Output Format**
Based on your approved plan, your workflow will produce output documents. Let's design how these outputs should be formatted."
### 2. Present the Format Spectrum
"**Output Format Spectrum - Where does your workflow fit?**
**Strictly Structured Examples:**
- Government forms - exact fields, precise positions
- Legal documents - must follow specific templates
- Technical specifications - required sections, specific formats
- Compliance reports - mandatory fields, validation rules
**Structured Examples:**
- Project reports - required sections, flexible content
- Business proposals - consistent format, customizable sections
- Technical documentation - standard structure, adaptable content
- Research papers - IMRAD format, discipline-specific variations
**Semi-structured Examples:**
- Character sheets (D&D) - core stats + flexible background
- Lesson plans - required components, flexible delivery
- Recipes - ingredients/method format, flexible descriptions
- Meeting minutes - agenda/attendees/actions, flexible details
**Free-form Examples:**
- Creative stories - narrative flow, minimal structure
- Blog posts - title/body, organic organization
- Personal journals - date/entry, free expression
- Brainstorming outputs - ideas, flexible organization"
### 3. Determine Format Type
"**Which format type best fits your workflow?**
1. **Strict Template** - Must follow exact format with specific fields
2. **Structured** - Required sections but flexible within each
3. **Semi-structured** - Core sections plus optional additions
4. **Free-form** - Content-driven with minimal structure
Please choose 1-4:"
### 4. Deep Dive Based on Choice
#### IF Strict Template (Choice 1):
"**Strict Template Design**
You need exact formatting. Let's define your requirements:
**Template Source Options:**
A. Upload existing template/image to follow
B. Create new template from scratch
C. Use standard form (e.g., government, industry)
D. AI proposes template based on your needs
**Template Requirements:**
- Exact field names and positions
- Required vs optional fields
- Validation rules
- File format (PDF, DOCX, etc.)
- Any legal/compliance considerations"
#### IF Structured (Choice 2):
"**Structured Document Design**
You need consistent sections with flexibility:
**Section Definition:**
- What sections are required?
- Any optional sections?
- Section ordering rules?
- Cross-document consistency needs?
**Format Guidelines:**
- Any formatting standards (APA, MLA, corporate)?
- Section header styles?
- Content organization principles?"
#### IF Semi-structured (Choice 3):
"**Semi-structured Design**
Core sections with flexibility:
**Core Components:**
- What information must always appear?
- Which parts can vary?
- Any organizational preferences?
**Polishing Options:**
- Would you like automatic TOC generation?
- Summary section at the end?
- Consistent formatting options?"
#### IF Free-form (Choice 4):
"**Free-form Content Design**
Focus on content with minimal structure:
**Organization Needs:**
- Basic headers for readability?
- Date/title information?
- Any categorization needs?
**Final Polish Options:**
- Auto-generated summary?
- TOC based on content?
- Formatting for readability?"
### 5. Template Creation (if applicable)
For Strict/Structured workflows:
"**Template Creation Approach:**
A. **Design Together** - We'll create the template step by step
B. **AI Proposes** - I'll suggest a structure based on your needs
C. **Import Existing** - Use/upload your existing template
Which approach would you prefer?"
If A or B:
- Design/create template sections
- Define placeholders
- Specify field types and validation
- Document template structure in plan
If C:
- Request file upload or detailed description
- Analyze template structure
- Document requirements
### 6. Document Format Decisions
Append to {workflowPlanFile}:
```markdown
## Output Format Design
**Format Type**: [Strict/Structured/Semi-structured/Free-form]
**Output Requirements**:
- Document type: [report/form/story/etc]
- File format: [PDF/MD/DOCX/etc]
- Frequency: [single/batch/continuous]
**Structure Specifications**:
[Detailed structure based on format type]
**Template Information**:
- Template source: [created/imported/standard]
- Template file: [path if applicable]
- Placeholders: [list if applicable]
**Special Considerations**:
- Legal/compliance requirements
- Validation needs
- Accessibility requirements
```
### 7. Present MENU OPTIONS
Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
#### 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
- User can chat or ask questions - always respond and then end with display again of the menu options
- Use menu handling logic section below
#### Menu Handling Logic:
- IF A: Execute {advancedElicitationTask}
- IF P: Execute {partyModeWorkflow}
- IF C: Save output format design to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile}
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and output format is documented will you load {nextStepFile} to begin workflow step design.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- User understands format spectrum
- Format type clearly identified
- Template requirements documented (if applicable)
- Output format saved in plan
### ❌ SYSTEM FAILURE:
- Not showing format examples
- Skipping format requirements
- Not documenting decisions in plan
- Assuming format without asking
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

118
src/modules/bmb/workflows/create-workflow/steps/step-09-design.md → src/modules/bmb/workflows/create-workflow/steps/step-06-design.md
View File

@ -1,31 +1,30 @@
---
name: 'step-09-design'
description: 'Design the workflow structure and step sequence based on gathered requirements and tools configuration'
name: 'step-06-design'
description: 'Design the workflow structure and step sequence based on gathered requirements, tools configuration, and output format'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-09-design.md'
nextStepFile: '{workflow_path}/steps/step-10-plan-review.md'
thisStepFile: '{workflow_path}/steps/step-06-design.md'
nextStepFile: '{workflow_path}/steps/step-07-build.md'
workflowFile: '{workflow_path}/workflow.md'
# Output files for workflow creation process
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Template References
designTemplate: '{workflow_path}/templates/design-section.md'
# No template needed - will append design details directly to workflow plan
---
# Step 3: Workflow Structure Design
# Step 6: Workflow Structure Design
## STEP GOAL:
To collaboratively design the workflow structure, step sequence, and interaction patterns based on the requirements gathered in the previous step.
To collaboratively design the workflow structure, step sequence, and interaction patterns based on the approved plan and output format requirements.
## MANDATORY EXECUTION RULES (READ FIRST):
@ -55,12 +54,13 @@ To collaboratively design the workflow structure, step sequence, and interaction
- 🎯 Guide collaborative design process
- 💾 After completing design, append to {workflowPlanFile}
- 📖 Update plan frontmatter `stepsCompleted: [1, 2, 3]` before loading next step
- 📖 Update plan frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` before loading next step
- 🚫 FORBIDDEN to load next step until user selects 'C' and design is saved
## CONTEXT BOUNDARIES:
- Requirements from step 2 are available and should inform design
- Approved plan from step 4 is available and should inform design
- Output format design from step 5 (if completed) guides structure
- Load architecture documentation when needed for guidance
- Focus ONLY on structure and flow design
- Don't implement actual files in this step
@ -70,9 +70,10 @@ To collaboratively design the workflow structure, step sequence, and interaction
When designing, you may load these documents as needed:
- `{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md` - Step file structure
- `{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md` - Workflow configuration
- `{project-root}/{bmad_folder}/bmb/docs/workflows/architecture.md` - Architecture principles
- `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md` - Step file structure
- `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-01-init-continuable-template.md` - Continuable init step template
- `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-1b-template.md` - Continuation step template
- `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md` - Workflow configuration
- `{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition/workflow.md` - Complete example
## WORKFLOW DESIGN PROCESS:
@ -84,10 +85,18 @@ Let's reference our step creation documentation for best practices:
Load and reference step-file architecture guide:
```
Read: {project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md
Read: {project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md
```
This shows the standard structure for step files. Based on the requirements, collaboratively design:
This shows the standard structure for step files. Also reference:
```
Read: {project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-1b-template.md
```
This shows the continuation step pattern for workflows that might take multiple sessions.
Based on the approved plan, collaboratively design:
- How many major steps does this workflow need? (Recommend 3-7)
- What is the goal of each step?
@ -95,6 +104,25 @@ This shows the standard structure for step files. Based on the requirements, col
- Should any steps repeat or loop?
- What are the decision points within steps?
### 1a. Continuation Support Assessment
**Ask the user:**
"Will this workflow potentially take multiple sessions to complete? Consider:
- Does this workflow generate a document/output file?
- Might users need to pause and resume the workflow?
- Does the workflow involve extensive data collection or analysis?
- Are there complex decisions that might require multiple sessions?
If **YES** to any of these, we should include continuation support using step-01b-continue.md."
**If continuation support is needed:**
- Include step-01-init.md (with continuation detection logic)
- Include step-01b-continue.md (for resuming workflows)
- Ensure every step updates `stepsCompleted` in output frontmatter
- Design the workflow to persist state between sessions
### 2. Interaction Pattern Design
Design how users will interact with the workflow:
@ -170,31 +198,35 @@ Present the design for review:
- Ensure steps can be loaded independently
- Design for Just-In-Time loading
### Collaborative Dialogue
### Sequential Flow with Clear Progression
- Design for conversation, not command-response
- Include decision points for user input
- Make the workflow adaptable to user context
- Each step should build on previous work
- Include clear decision points
- Maintain logical progression toward goal
### Sequential Enforcement
### Menu-Based Interactions
- Design clear step dependencies
- Ensure logical flow between steps
- Include state tracking for progress
- Include consistent menu patterns
- Provide clear options at decision points
- Allow for conversation within steps
### Error Prevention
### State Management
- Include validation at key points
- Design for common failure scenarios
- Provide clear guidance to users
- Track progress using `stepsCompleted` array
- Persist state in output file frontmatter
- Support continuation where appropriate
## CONTENT TO APPEND TO PLAN:
### 9. Document Design in Plan
After completing the design, append to {workflowPlanFile}:
Append to {workflowPlanFile}:
Load and append the content from {designTemplate}
- Complete step outline with names and purposes
- Flow diagram or sequence description
- Interaction patterns
- File structure requirements
- Special features and handling
### 9. Present MENU OPTIONS
### 10. Present MENU OPTIONS
Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
@ -210,12 +242,12 @@ Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Conti
- IF A: Execute {advancedElicitationTask}
- IF P: Execute {partyModeWorkflow}
- IF C: Save content to {workflowPlanFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#9-present-menu-options)
- IF C: Save design to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile}
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#10-present-menu-options)
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and content is saved to workflow plan and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin workflow file generation step.
ONLY WHEN C is selected and design is saved will you load {nextStepFile} to begin implementation.
---
@ -224,16 +256,16 @@ ONLY WHEN C is selected and content is saved to workflow plan and frontmatter is
### ✅ SUCCESS:
- Workflow structure designed collaboratively
- Step sequence mapped and agreed upon
- Interaction patterns designed
- Design documented in {outputFile}
- Frontmatter updated with step completion
- All steps clearly defined and sequenced
- Interaction patterns established
- File structure planned
- User agreement on design
### ❌ SYSTEM FAILURE:
- Creating implementation details instead of design
- Skipping design review with user
- Proceeding without complete design
- Not updating document frontmatter
- Designing without user collaboration
- Skipping design principles
- Not documenting design in plan
- Proceeding without user agreement
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

154
src/modules/bmb/workflows/create-workflow/steps/step-06-external-tools.md
View File

@ -1,154 +0,0 @@
---
name: 'step-06-external-tools'
description: 'Configure MCP integrations and installation requirements'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-06-external-tools.md'
nextStepFile: '{workflow_path}/steps/step-07-installation-guidance.md'
workflowFile: '{workflow_path}/workflow.md'
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
# Documentation References
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
---
# Step 6: External Tools Configuration
## STEP GOAL:
Identify and configure MCP integrations and external tools that the workflow requires.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are a workflow architect and integration specialist
- ✅ We engage in collaborative dialogue, not command-response
- ✅ You bring expertise in MCP integrations and external tools
## EXECUTION PROTOCOLS:
- 🎯 Load external tools from CSV
- 💾 Identify specific MCP needs for workflow
- 📖 Document which tools require installation
- 🚫 FORBIDDEN to proceed without confirming tool selections
## SEQUENCE OF INSTRUCTIONS:
### 1. Initialize External Tools Assessment
"Configuring **External Tools and MCP Integrations**
These tools extend workflow capabilities but typically require installation. Let's identify what your workflow actually needs."
### 2. Present External Tools from CSV
Load `{commonToolsCsv}` and filter for `propose='example'` and `type='mcp'`:
"**Available External Tools:**
**MCP Integrations (Require Installation):**
- [List MCP tools from CSV with URLs and descriptions]
**Example Workflows/Tasks:**
- [List example workflows/tasks from CSV with descriptions]
**Installation Note:** Tools marked with `requires_install=yes` will need setup steps."
### 3. Identify Specific Tool Needs
"**External Tool Requirements:**
Based on your workflow goals, which external tools do you need?
**Common MCP Needs:**
- **Documentation Access:** Context-7 for current API docs
- **Browser Automation:** Playwright for web interactions
- **Git Operations:** Direct version control integration
- **Database Access:** Multiple database connectivity
- **Custom Tools:** Any domain-specific MCPs you need
**Your Requirements:**
1. What external data or APIs will your workflow access?
2. Does your workflow need web browser automation?
3. Will it interact with version control systems?
4. Are database connections required?
5. Any custom MCPs you plan to use?"
### 4. Document External Tools Selection
Append to {workflowPlanFile}:
```markdown
## External Tools Configuration
### MCP Integrations
**Selected Tools:** [list from CSV]
**Purpose:** [how each MCP enhances workflow]
**Integration Points:** [where external tools are essential]
**Installation Required:** [yes/no, which tools]
### Example Workflows/Tasks
**Selected:** [list chosen workflows/tasks]
**Purpose:** [how they enhance workflow capabilities]
**Integration:** [where they fit in workflow flow]
```
### 5. Installation Assessment
"**Installation Requirements Assessment:**
**Tools Requiring Installation:** [list from CSV where requires_install=yes]
**Installation Guidance Options:**
1. Include detailed setup steps in workflow
2. Provide user installation checklist
3. Assume tools are pre-installed
**Your Preference:** [ask user how to handle installation]"
### 6. Menu Options
Display: **Select an Option:** [C] Continue to Installation Guidance [M] Modify External Tools
#### Menu Handling Logic:
- IF C: Append external tools configuration to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
- IF M: Refine external tool requirements
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and external tools are documented will you load {nextStepFile} to configure installation guidance.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- External tools presented from CSV with installation requirements
- User's specific tool needs identified and documented
- Installation requirements clearly marked
- User understands which tools need setup
### ❌ SYSTEM FAILURE:
- Not filtering CSV for relevant tool types
- Missing installation requirement information
- Proceeding without confirming tool selections

90
src/modules/bmb/workflows/create-workflow/steps/step-11-build.md → src/modules/bmb/workflows/create-workflow/steps/step-07-build.md
View File

@ -1,34 +1,32 @@
---
name: 'step-11-build'
name: 'step-07-build'
description: 'Generate all workflow files based on the approved plan'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-11-build.md'
nextStepFile: '{workflow_path}/steps/step-12-review.md'
thisStepFile: '{workflow_path}/steps/step-07-build.md'
nextStepFile: '{workflow_path}/steps/step-08-review.md'
workflowFile: '{workflow_path}/workflow.md'
# Output files for workflow creation process
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
# Template References
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md'
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md'
contentTemplate: '{workflow_path}/templates/content-template.md'
buildSummaryTemplate: '{workflow_path}/templates/build-summary.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
stepInitContinuableTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-01-init-continuable-template.md'
step1bTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-1b-template.md'
# No content templates needed - will create content as needed during build
# No build summary template needed - will append summary directly to workflow plan
---
# Step 5: Workflow File Generation
# Step 7: Workflow File Generation
## STEP GOAL:
To generate all the workflow files (workflow.md, step files, templates, and supporting files) based on the approved plan from the previous review step.
To generate all the workflow files (workflow.md, step files, templates, and supporting files) based on the approved plan from the previous design step.
## MANDATORY EXECUTION RULES (READ FIRST):
@ -58,20 +56,22 @@ To generate all the workflow files (workflow.md, step files, templates, and supp
- 🎯 Generate files systematically from design
- 💾 Document all generated files and their locations
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` before loading next step
- 🚫 FORBIDDEN to load next step until user selects 'C' and build is complete
## CONTEXT BOUNDARIES:
- Approved plan from step 10 guides implementation
- Approved plan from step 6 guides implementation
- Generate files in target workflow location
- Load templates and documentation as needed during build
- Follow step-file architecture principles
## BUILD REFERENCE MATERIALS:
- When building each step file, you must follow template `{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md`
- When building the main workflow.md file, you must follow template `{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md`
- When building each step file, you must follow template `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md`
- When building continuable step-01-init.md files, use template `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-01-init-continuable-template.md`
- When building continuation steps, use template `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-1b-template.md`
- When building the main workflow.md file, you must follow template `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md`
- Example step files from {project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition/workflow.md for patterns
## FILE GENERATION SEQUENCE:
@ -99,6 +99,7 @@ Create the workflow folder structure in the target location:
├── workflow.md
├── steps/
│ ├── step-01-init.md
│ ├── step-01b-continue.md (if continuation support needed)
│ ├── step-02-[name].md
│ └── ...
├── templates/
@ -116,14 +117,54 @@ Load and follow {workflowTemplate}:
- Create workflow.md using template structure
- Insert workflow name and description
- Configure all path variables ({project-root}, {bmad_folder}, {workflow_path})
- Configure all path variables ({project-root}, {_bmad_folder_}, {workflow_path})
- Set web_bundle flag to true unless user has indicated otherwise
- Define role and goal
- Include initialization path to step-01
### 4. Generate Step Files
For each step in the design:
#### 4a. Check for Continuation Support
**Check the workflow plan for continuation support:**
- Look for "continuation support: true" or similar flag
- Check if step-01b-continue.md was included in the design
- If workflow generates output documents, continuation is typically needed
#### 4b. Generate step-01-init.md (with continuation logic)
If continuation support is needed:
- Load and follow {stepInitContinuableTemplate}
- This template automatically includes all required continuation detection logic
- Customize with workflow-specific information:
- Update workflow_path references
- Set correct outputFile and templateFile paths
- Adjust role and persona to match workflow type
- Customize welcome message for workflow context
- Configure input document discovery patterns (if any)
- Template automatically handles:
- continueFile reference in frontmatter
- Logic to check for existing output files with stepsCompleted
- Routing to step-01b-continue.md for continuation
- Fresh workflow initialization
#### 4c. Generate step-01b-continue.md (if needed)
**If continuation support is required:**
- Load and follow {step1bTemplate}
- Customize with workflow-specific information:
- Update workflow_path references
- Set correct outputFile path
- Adjust role and persona to match workflow type
- Customize welcome back message for workflow context
- Ensure proper nextStep detection logic based on step numbers
#### 4d. Generate Remaining Step Files
For each remaining step in the design:
- Load and follow {stepTemplate}
- Create step file using template structure
@ -131,12 +172,12 @@ For each step in the design:
- Ensure proper frontmatter with path references
- Include appropriate menu handling and universal rules
- Follow all mandatory rules and protocols from template
- **Critical**: Ensure each step updates `stepsCompleted` array when completing
### 5. Generate Templates (If Needed)
For document workflows:
- Load {contentTemplate}
- Create template.md with proper structure
- Include all variables from design
- Ensure variable naming consistency
@ -219,7 +260,12 @@ Create a summary of what was generated:
After generating all files, append to {workflowPlanFile}:
Load and append the content from {buildSummaryTemplate}
Create a build summary including:
- List of all files created with full paths
- Any customizations from templates
- Manual steps needed
- Next steps for testing
### 9. Present MENU OPTIONS

159
src/modules/bmb/workflows/create-workflow/steps/step-07-installation-guidance.md
View File

@ -1,159 +0,0 @@
---
name: 'step-07-installation-guidance'
description: 'Configure installation guidance for tools that require setup'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-07-installation-guidance.md'
nextStepFile: '{workflow_path}/steps/step-08-tools-summary.md'
workflowFile: '{workflow_path}/workflow.md'
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
# Documentation References
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
---
# Step 7: Installation Guidance Configuration
## STEP GOAL:
Configure installation guidance for any selected tools that require setup, ensuring users can successfully prepare their environment.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are a workflow architect and integration specialist
- ✅ We engage in collaborative dialogue, not command-response
- ✅ You bring expertise in tool installation and setup procedures
## EXECUTION PROTOCOLS:
- 🎯 Identify tools requiring installation from CSV
- 💾 Configure installation approach based on user preference
- 📖 Generate or skip installation guidance as appropriate
- 🚫 FORBIDDEN to proceed without confirming installation approach
## SEQUENCE OF INSTRUCTIONS:
### 1. Initialize Installation Guidance
"Configuring **Installation Guidance**
Let's ensure users can successfully set up any tools your workflow requires. This prevents runtime errors and improves user experience."
### 2. Identify Installation Requirements
Load `{commonToolsCsv}` and filter for selected tools with `requires_install=yes`:
"**Installation Requirements:**
**Tools Requiring Installation:**
- [List selected tools from CSV where requires_install=yes]
- [Include URLs from CSV for each tool]
**No Installation Required:**
- [List selected tools from CSV where requires_install=no]
- All BMAD core tools, LLM features, and sidecar file memory"
### 3. Installation Approach Options
"**Installation Guidance Options:**
Based on your selected tools, how should the workflow handle installation?
1. **Include Installation Steps** - Add detailed setup instructions in early workflow step
2. **User Instructions Only** - Provide guidance but don't embed in workflow
3. **Assume Pre-Installed** - Skip installation guidance (advanced users)
**Installation Prerequisites (if included):**
- Node.js 18+ (for Node.js-based MCPs)
- Python 3.8+ (for Python-based MCPs)
- Git for cloning repositories
- MCP-compatible AI client (Claude Desktop or similar)"
### 4. Configure Installation Guidance
If user chooses installation guidance:
"**Installation Step Configuration:**
For each tool requiring installation, the workflow will include:
- Clone/download instructions using URL from CSV
- Dependency installation commands
- Configuration file setup
- Server startup procedures
- Claude Desktop configuration steps
**Installation Checklist (if included):**
- [ ] Download and install Claude Desktop
- [ ] Clone MCP repositories
- [ ] Install required dependencies
- [ ] Configure MCP servers
- [ ] Add to Claude configuration
- [ ] Test connectivity
- [ ] Verify functionality"
### 5. Document Installation Configuration
Append to {workflowPlanFile}:
```markdown
## Installation Guidance Configuration
### Installation Approach
**Selected Approach:** [detailed steps/user instructions/assume pre-installed]
**Tools Requiring Installation:** [list with URLs]
**Installation Step Placement:** [early in workflow, after setup]
### Installation Content
**Prerequisites:** [system requirements]
**Setup Steps:** [commands and procedures]
**Verification:** [testing procedures]
**User Support:** [troubleshooting guidance]
```
### 6. Menu Options
Display: **Select an Option:** [C] Continue to Tools Summary [M] Modify Installation Approach
#### Menu Handling Logic:
- IF C: Append installation configuration to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
- IF M: Refine installation approach
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and installation guidance is documented will you load {nextStepFile} to complete tools configuration.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Installation requirements clearly identified from CSV
- Installation approach configured based on user preference
- Documentation prepared for setup procedures
- User understands how tools will be installed
### ❌ SYSTEM FAILURE:
- Missing installation requirement assessment
- Not using URLs from CSV for installation guidance
- Proceeding without confirming installation approach

44
src/modules/bmb/workflows/create-workflow/steps/step-12-review.md → src/modules/bmb/workflows/create-workflow/steps/step-08-review.md
View File

@ -1,27 +1,31 @@
---
name: 'step-12-review'
name: 'step-08-review'
description: 'Review the generated workflow and provide final validation and next steps'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-12-review.md'
thisStepFile: '{workflow_path}/steps/step-08-review.md'
workflowFile: '{workflow_path}/workflow.md'
# Output files for workflow creation process
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Template References
reviewTemplate: '{workflow_path}/templates/review-section.md'
completionTemplate: '{workflow_path}/templates/completion-section.md'
# No review template needed - will append review summary directly to workflow plan
# No completion template needed - will append completion details directly
# Next step reference
nextStepFile: '{workflow_path}/steps/step-09-complete.md'
---
# Step 6: Workflow Review and Completion
# Step 8: Workflow Review and Completion
## STEP GOAL:
@ -55,7 +59,7 @@ To review the generated workflow for completeness, accuracy, and adherence to be
- 🎯 Conduct thorough review of generated workflow
- 💾 Document review findings and completion status
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` and mark complete
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` and mark complete
- 🚫 This is the final step - no next step to load
## CONTEXT BOUNDARIES:
@ -197,26 +201,36 @@ Provide specific recommendations:
After completing review, append to {workflowPlanFile}:
Load and append the content from {reviewTemplate}
Append review findings to {workflowPlanFile}:
Then load and append the content from {completionTemplate}
Create a review summary including:
## FINAL MENU OPTIONS
- Completeness check results
- Accuracy validation
- Compliance with best practices
- Any issues found
Display: **All Files Created Successfully!** [C] Complete & Get Validation Instructions
Then append completion details:
- Final approval status
- Deployment recommendations
- Usage guidance
### 10. Present MENU OPTIONS
Display: **Select an Option:** [C] Continue to Completion
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- Provide compliance check guidance for new context execution
- After other menu items execution, return to this menu
- ONLY proceed to next step when user selects 'C'
- User can chat or ask questions - always respond and then end with display again of the menu options
- Use menu handling logic section below
#### Menu Handling Logic:
- IF C: Save content to {workflowPlanFile}, update frontmatter, then provide validation instructions for running in new context
- IF Any other comments or queries: respond and redisplay menu
- IF C: Save review to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile}
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#10-present-menu-options)
## COMPLIANCE CHECK INSTRUCTIONS

167
src/modules/bmb/workflows/create-workflow/steps/step-08-tools-summary.md
View File

@ -1,167 +0,0 @@
---
name: 'step-08-tools-summary'
description: 'Summarize tools configuration and proceed to workflow design'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-08-tools-summary.md'
nextStepFile: '{workflow_path}/steps/step-09-design.md'
workflowFile: '{workflow_path}/workflow.md'
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
# Documentation References
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
---
# Step 8: Tools Configuration Summary
## STEP GOAL:
Summarize the complete tools configuration and confirm readiness to proceed to workflow design.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are a workflow architect and integration specialist
- ✅ We engage in collaborative dialogue, not command-response
- ✅ You bring expertise in tools integration and workflow optimization
## EXECUTION PROTOCOLS:
- 🎯 Compile complete tools configuration summary
- 💾 Present final configuration for user confirmation
- 📖 Update workflow plan with comprehensive summary
- 🚫 FORBIDDEN to proceed to design without user confirmation
## SEQUENCE OF INSTRUCTIONS:
### 1. Initialize Tools Summary
"**Tools Configuration Summary**
Let's review your complete tools configuration before proceeding to workflow design. This ensures all integrations are properly planned."
### 2. Present Complete Configuration
Load all previous configurations from {workflowPlanFile} and CSV:
"**Complete Tools Configuration:**
**Core BMAD Tools:**
- [List selected core tools with integration points]
- [Load descriptions from CSV for confirmation]
**LLM Tool Features:**
- [List selected LLM features with integration points]
- [Load descriptions from CSV for confirmation]
**Tool-Memory:**
- [Selected memory types with implementation details]
- [Load descriptions from CSV for confirmation]
**External Tools:**
- [List selected MCP integrations with URLs]
- [Load descriptions from CSV for confirmation]
- [Mark which require installation]
**Installation Guidance:**
- [Approach selected and tools included]
- [Setup steps configured as needed]
**Integration Strategy:**
- [How tools enhance rather than disrupt workflow]
- [Checkpoint approaches and user choice points]
- [Performance optimization opportunities]"
### 3. Final Configuration Confirmation
"**Final Configuration Review:**
**Your workflow will include:**
- **Total Tools:** [count of selected tools]
- **Core Tools:** [number selected]
- **External Tools:** [number selected]
- **Installation Required:** [yes/no, which tools]
**Key Integration Points:**
- [Major phases where tools enhance workflow]
- [User experience considerations]
- [Performance optimizations]
**Ready to proceed with this configuration?**"
### 4. Update Workflow Plan with Final Summary
Append to {workflowPlanFile}:
```markdown
## Final Tools Configuration Summary
### Tools Inventory
**Core BMAD Tools:** [count and list]
**LLM Features:** [count and list]
**Memory Implementation:** [type and use case]
**External Tools:** [count and list with URLs]
**Installation Required:** [tools and setup complexity]
### Integration Strategy
**User Experience:** [how tools enhance workflow]
**Checkpoint Approach:** [when tools are offered]
**Performance Optimization:** [efficiency improvements]
**Installation Strategy:** [how users prepare environment]
### Ready for Design
All tools configured and ready for workflow design phase.
```
### 5. Menu Options
Display: **Select an Option:** [C] Continue to Workflow Design [M] Modify Configuration
#### Menu Handling Logic:
- IF C: Save final summary, update frontmatter stepsCompleted: [3, 4, 5, 6, 7, 8], then load {nextStepFile}
- IF M: Return to specific configuration step
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and summary is saved will you load {nextStepFile} to begin workflow design phase.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Complete tools configuration summarized clearly
- All descriptions loaded from CSV (not duplicated)
- User confirms configuration before proceeding
- Frontmatter updated with completed steps
- Ready to proceed to workflow design
### ❌ SYSTEM FAILURE:
- Not presenting complete configuration summary
- Duplicating CSV content instead of referencing it
- Proceeding to design without user confirmation
- Not updating workflow plan with final summary

187
src/modules/bmb/workflows/create-workflow/steps/step-09-complete.md Normal file
View File

@ -0,0 +1,187 @@
---
name: 'step-09-complete'
description: 'Final completion and wrap-up of workflow creation process'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-09-complete.md'
workflowFile: '{workflow_path}/workflow.md'
# Output files for workflow creation process
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
completionFile: '{targetWorkflowPath}/completion-summary-{new_workflow_name}.md'
---
# Step 9: Workflow Creation Complete
## STEP GOAL:
To complete the workflow creation process with a final summary, confirmation, and next steps for using the new workflow.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are a workflow architect and systems designer
- ✅ 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 expertise in workflow deployment and usage guidance
- ✅ User brings their specific workflow needs
### Step-Specific Rules:
- 🎯 Focus ONLY on completion and next steps
- 🚫 FORBIDDEN to modify the generated workflow
- 💬 Provide clear guidance on how to use the workflow
- 🚫 This is the final step - no next step to load
## EXECUTION PROTOCOLS:
- 🎯 Present completion summary
- 💾 Create final completion documentation
- 📖 Update plan frontmatter with completion status
- 🚫 This is the final step
## CONTEXT BOUNDARIES:
- All previous steps are complete
- Workflow has been generated and reviewed
- Focus ONLY on completion and next steps
- This step concludes the create-workflow process
## COMPLETION PROCESS:
### 1. Initialize Completion
"**Workflow Creation Complete!**
Congratulations! We've successfully created your new workflow. Let's finalize everything and ensure you have everything you need to start using it."
### 2. Final Summary
Present a complete summary of what was created:
**Workflow Created:** {new_workflow_name}
**Location:** {targetWorkflowPath}
**Files Generated:** [list from build step]
### 3. Create Completion Summary
Create {completionFile} with:
```markdown
---
workflowName: { new_workflow_name }
creationDate: [current date]
module: [module from plan]
status: COMPLETE
stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]
---
# Workflow Creation Summary
## Workflow Information
- **Name:** {new_workflow_name}
- **Module:** [module]
- **Created:** [date]
- **Location:** {targetWorkflowPath}
## Generated Files
[List all files created]
## Quick Start Guide
[How to run the new workflow]
## Next Steps
[Post-creation recommendations]
```
### 4. Usage Guidance
Provide clear instructions on how to use the new workflow:
**How to Use Your New Workflow:**
1. **Running the Workflow:**
- [Instructions based on workflow type]
- [Initial setup if needed]
2. **Common Use Cases:**
- [Typical scenarios for using the workflow]
- [Expected inputs and outputs]
3. **Tips for Success:**
- [Best practices for this specific workflow]
- [Common pitfalls to avoid]
### 5. Post-Creation Recommendations
"**Next Steps:**
1. **Test the Workflow:** Run it with sample data to ensure it works as expected
2. **Customize if Needed:** You can modify the workflow based on your specific needs
3. **Share with Team:** If others will use this workflow, provide them with the location and instructions
4. **Monitor Usage:** Keep track of how well the workflow meets your needs"
### 6. Final Confirmation
"**Is there anything else you need help with regarding your new workflow?**
- I can help you test it
- We can make adjustments if needed
- I can help you create documentation for users
- Or any other support you need"
### 7. Update Final Status
Update {workflowPlanFile} frontmatter:
- Set status to COMPLETE
- Set completion date
- Add stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]
## MENU OPTIONS
Display: **Workflow Creation Complete!** [T] Test Workflow [M] Make Adjustments [D] Get Help
#### Menu Handling Logic:
- IF T: Offer to run the newly created workflow with sample data
- IF M: Offer to make specific adjustments to the workflow
- IF D: Provide additional help and resources
- IF Any other: Respond to user needs
## CRITICAL STEP COMPLETION NOTE
This is the final step. When the user is satisfied, the workflow creation process is complete.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Workflow fully created and reviewed
- Completion summary generated
- User understands how to use the workflow
- All documentation is in place
### ❌ SYSTEM FAILURE:
- Not providing clear usage instructions
- Not creating completion summary
- Leaving user without next steps
**Master Rule:** Ensure the user has everything needed to successfully use their new workflow.

215
src/modules/bmb/workflows/create-workflow/steps/step-10-plan-review.md
View File

@ -1,215 +0,0 @@
---
name: 'step-10-plan-review'
description: 'Review the complete workflow plan before generating files'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
# File References
thisStepFile: '{workflow_path}/steps/step-10-plan-review.md'
nextStepFile: '{workflow_path}/steps/step-11-build.md'
workflowFile: '{workflow_path}/workflow.md'
# Output files for workflow creation process
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 4: Workflow Plan Review
## STEP GOAL:
To present the complete workflow plan for user review and approval before generating the actual workflow files.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 🔄 CRITICAL: Always read the complete step file before taking any action
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are a workflow architect and systems designer
- ✅ 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 present the plan clearly and answer questions
- ✅ User provides approval or requests changes
### Step-Specific Rules:
- 🎯 Focus ONLY on reviewing the plan, not building yet
- 🚫 FORBIDDEN to generate any workflow files in this step
- 💬 Present the complete plan clearly and answer all questions
- 🚪 GET explicit approval before proceeding to build
## EXECUTION PROTOCOLS:
- 🎯 Present the complete workflow plan for review
- 💾 Update plan frontmatter with review status
- 📖 Only proceed to build step with explicit user approval
- 🚫 FORBIDDEN to skip review or proceed without consent
## CONTEXT BOUNDARIES:
- Requirements and design from previous steps are in the plan
- Focus ONLY on review and approval
- Don't modify the design significantly here
- This is the final checkpoint before file generation
## REVIEW REFERENCE MATERIALS:
When reviewing, you may load for comparison:
- Example workflow: `{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition/workflow.md`
- Step examples from same workflow's steps folder
- Architecture guide: `{project-root}/{bmad_folder}/bmb/docs/workflows/architecture.md`
## PLAN REVIEW PROCESS:
### 1. Present the Complete Plan
Read the entire {workflowPlanFile} and present it to the user:
- Executive Summary
- Requirements Analysis
- Detailed Design
- Implementation Plan
- Target Location and file structure
### 2. Analyze Plan for Gaps and Issues
Perform systematic analysis of the loaded plan:
**Logical Flow Check:**
- Do requirements align with proposed solution?
- Are tools appropriate for the workflow type?
- Is step sequence logical and complete?
- Are there missing transitions between steps?
**Completeness Review:**
- All requirements captured and addressed?
- Design covers all user scenarios?
- Implementation plan includes all necessary files?
- Are there unclear or ambiguous specifications?
**Architecture Validation:**
- Follows BMAD step-file architecture?
- Proper use of template patterns?
- Menu flow is logical and complete?
- Variable naming is consistent?
**Issue Identification:**
If gaps or issues found:
- Clearly identify each issue
- Propose specific solutions
- Ask for user input on resolution approach
### 3. Present Menu for Plan Approval
Display: **Plan Review Complete - Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Build
### 4. Address Questions and Concerns
Ask for specific feedback:
- Does this plan fully address your requirements?
- Are there any missing aspects?
- Would you like any changes to the design?
- Are you satisfied with the proposed structure?
### 5. Confirm or Revise
Based on feedback:
- If approved: Proceed to build step
- If changes needed: Go back to design step with specific feedback
- If major revisions: Consider going back to requirements step
## REVIEW CHECKPOINTS:
### Requirements Coverage
- [ ] All user requirements addressed
- [ ] Success criteria defined
- [ ] Technical constraints considered
- [ ] User interaction level appropriate
### Design Quality
- [ ] Step flow is logical
- [ ] Instruction style chosen appropriately
- [ ] Menu systems designed properly
- [ ] Error handling included
### Implementation Feasibility
- [ ] File structure is clear
- [ ] Target location confirmed
- [ ] Templates identified correctly
- [ ] Dependencies documented
## PLAN APPROVAL:
### Explicit Confirmation Required
Before proceeding to build, get explicit confirmation:
"Based on this plan, I will generate:
- [List of files]
in [target location]"
Ready to proceed when you are! Select your option below to build or modify the plan.
### 6. Present MENU OPTIONS
Display: **Review Complete - Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Build
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed to build step with explicit 'C' selection AND approval
- After other menu items execution, return to this menu
- User can chat or ask questions - always respond and then end with display again of the menu options
- Use menu handling logic section below
#### Menu Handling Logic:
- IF A: Execute {advancedElicitationTask}
- IF P: Execute {partyModeWorkflow}
- IF C: AND user has approved the plan, update plan frontmatter, then load, read entire file, then execute {nextStepFile}
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options)
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected AND user has explicitly approved the plan, will you then update the plan frontmatter and load, read entire file, then execute {nextStepFile} to execute and begin workflow file generation step.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Complete plan presented clearly
- All user questions answered
- Feedback collected and documented
- Explicit approval received (or revisions planned)
- Plan ready for implementation
### ❌ SYSTEM FAILURE:
- Skipping the review presentation
- Proceeding without explicit approval
- Not answering user questions
- Rushing through the review process
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

36
src/modules/bmb/workflows/create-workflow/templates/build-summary.md
View File

@ -1,36 +0,0 @@
## Build Summary
### Files Generated
{{#generatedFiles}}
- **{{type}}**: {{path}}
{{/generatedFiles}}
### Customizations Made
{{#customizations}}
- {{.}}
{{/customizations}}
### Manual Steps Required
{{#manualSteps}}
- {{.}}
{{/manualSteps}}
### Build Validation Results
- **Syntax Check**: {{syntaxCheckResult}}
- **Path Validation**: {{pathValidationResult}}
- **Variable Consistency**: {{variableConsistencyResult}}
- **Template Compliance**: {{templateComplianceResult}}
### Next Steps for Testing
1. Run `workflow {{targetModule}}/workflows/{{workflowName}}` to test
2. Verify all steps execute properly
3. Check output generation
4. Validate user interaction points

39
src/modules/bmb/workflows/create-workflow/templates/completion-section.md
View File

@ -1,39 +0,0 @@
## Workflow Creation Complete!
### Final Deliverables
✅ **Main Workflow**: {{targetWorkflowPath}}/workflow.md
✅ **Step Files**: {{stepCount}} step files created
✅ **Templates**: {{templateCount}} templates created
✅ **Documentation**: Complete documentation provided
### Deployment Instructions
1. **Installation**: Run the BMAD Method installer to your project location
2. **Compilation**: Select 'Compile Agents' after confirming the folder
3. **Testing**: Use `workflow {{targetWorkflowPath}}` to test
### Usage Guide
```bash
# To invoke the workflow (from custom location)
workflow {{customWorkflowLocation}}/{{workflowName}}
# Or if standalone is true
/{{workflowCommand}}
```
### Support
- Created by: {{user_name}}
- Date: {{completionDate}}
- Module: {{targetModule}}
- Type: {{workflowType}}
### Thank You!
Thank you for using the Standalone Workflow Builder. Your workflow has been created following best practices for step-file architecture and collaborative design principles.
---
_Workflow creation completed successfully on {{completionDate}}_

21
src/modules/bmb/workflows/create-workflow/templates/content-template.md
View File

@ -1,21 +0,0 @@
# {{documentTitle}}
**Created:** {{date}}
**Author:** {{user_name}}
**Workflow:** {{workflowName}}
## Executive Summary
{{executiveSummary}}
## Details
{{mainContent}}
## Conclusion
{{conclusion}}
---
_Generated by the {{workflowName}} workflow_

53
src/modules/bmb/workflows/create-workflow/templates/design-section.md
View File

@ -1,53 +0,0 @@
## Workflow Design
### Step Structure
**Total Steps**: {{totalSteps}}
**Step Overview**:
{{stepOverview}}
### Detailed Step Plan
{{stepDetails}}
### Interaction Design
- **Menu Pattern**: {{menuPattern}}
- **User Input Points**: {{userInputPoints}}
- **AI Autonomy Level**: {{aiAutonomyLevel}}
- **Decision Flow**: {{decisionFlow}}
### Data Flow Architecture
- **Input Requirements**: {{dataInputRequirements}}
- **Intermediate Variables**: {{intermediateVariables}}
- **Output Mapping**: {{outputMapping}}
- **State Management**: {{stateManagement}}
### File Organization
- **Core Files**: {{coreFiles}}
- **Templates**: {{templates}}
- **Data Files**: {{dataFiles}}
- **Supporting Files**: {{supportingFiles}}
### AI Role Definition
- **Primary Role**: {{primaryRole}}
- **Expertise Areas**: {{expertiseAreas}}
- **Communication Style**: {{communicationStyle}}
- **Collaboration Approach**: {{collaborationApproach}}
### Quality Assurance
- **Validation Points**: {{validationPoints}}
- **Error Handling**: {{errorHandling}}
- **Recovery Strategies**: {{recoveryStrategies}}
- **Success Criteria**: {{designSuccessCriteria}}
### Special Features
- **Conditional Logic**: {{conditionalLogic}}
- **Branch Points**: {{branchPoints}}
- **Integrations**: {{designIntegrations}}
- **Multi-Scenario Support**: {{multiScenarioSupport}}

18
src/modules/bmb/workflows/create-workflow/templates/project-info.md
View File

@ -1,18 +0,0 @@
# Workflow Creation: {{workflow_name}}
**Created:** {{date}}
**Author:** {{user_name}}
**Module:** {{targetModule}}
**Type:** {{workflowType}}
## Project Overview
{{projectOverview}}
## Requirements Collected
{{requirementsCollected}}
---
_This document tracks the workflow creation process. The final workflow will be generated separately._

47
src/modules/bmb/workflows/create-workflow/templates/requirements-section.md
View File

@ -1,47 +0,0 @@
## Requirements Summary
### Workflow Purpose
- **Problem to Solve**: {{problemStatement}}
- **Primary Users**: {{targetUsers}}
- **Main Outcome**: {{primaryOutcome}}
- **Usage Frequency**: {{usageFrequency}}
### Workflow Classification
- **Type**: {{workflowType}}
- **Flow Pattern**: {{flowPattern}}
- **Interaction Style**: {{interactionStyle}}
- **Instruction Style**: {{instructionStyle}}
- **Autonomy Level**: {{autonomyLevel}}
### Input Requirements
- **Required Inputs**: {{requiredInputs}}
- **Optional Inputs**: {{optionalInputs}}
- **Prerequisites**: {{prerequisites}}
### Output Specifications
- **Primary Output**: {{primaryOutput}}
- **Intermediate Outputs**: {{intermediateOutputs}}
- **Output Format**: {{outputFormat}}
### Technical Constraints
- **Dependencies**: {{dependencies}}
- **Integrations**: {{integrations}}
- **Performance Requirements**: {{performanceRequirements}}
### Target Location
- **Module**: {{targetModule}}
- **Folder Name**: {{workflowFolderName}}
- **Target Path**: {{targetWorkflowPath}}
- **Custom Workflow Location**: {{customWorkflowLocation}}
### Success Criteria
- **Quality Metrics**: {{qualityMetrics}}
- **Success Indicators**: {{successIndicators}}
- **User Satisfaction**: {{userSatisfactionCriteria}}

56
src/modules/bmb/workflows/create-workflow/templates/review-section.md
View File

@ -1,56 +0,0 @@
## Workflow Review Results
### File Structure Review
**Status**: {{fileStructureStatus}}
- Required Files: {{requiredFilesStatus}}
- Directory Structure: {{directoryStructureStatus}}
- Naming Conventions: {{namingConventionsStatus}}
### Configuration Validation
**Status**: {{configValidationStatus}}
- Metadata Completeness: {{metadataStatus}}
- Path Variables: {{pathVariablesStatus}}
- Dependencies: {{dependenciesStatus}}
### Step File Compliance
**Status**: {{stepComplianceStatus}}
- Template Structure: {{templateStructureStatus}}
- Mandatory Rules: {{mandatoryRulesStatus}}
- Menu Implementation: {{menuImplementationStatus}}
### Cross-File Consistency
**Status**: {{consistencyStatus}}
- Variable Naming: {{variableNamingStatus}}
- Path References: {{pathReferencesStatus}}
- Step Sequence: {{stepSequenceStatus}}
### Requirements Verification
**Status**: {{requirementsVerificationStatus}}
- Problem Addressed: {{problemAddressedStatus}}
- User Types Supported: {{userTypesStatus}}
- Inputs/Outputs: {{inputsOutputsStatus}}
### Best Practices Adherence
**Status**: {{bestPracticesStatus}}
- File Size Limits: {{fileSizeStatus}}
- Collaborative Dialogue: {{collaborativeDialogueStatus}}
- Error Handling: {{errorHandlingStatus}}
### Issues Found
{{#issues}}
- **{{severity}}**: {{description}}
{{/issues}}

54
src/modules/bmb/workflows/create-workflow/templates/workflow-plan.md
View File

@ -1,54 +0,0 @@
# Workflow Creation Plan: {{workflowName}}
**Created:** {{date}}
**Author:** {{user_name}}
**Module:** {{targetModule}}
**Type:** {{workflowType}}
## Executive Summary
{{executiveSummary}}
## Requirements Analysis
[Requirements will be appended here from step 2]
## Detailed Design
[Design details will be appended here from step 3]
## Implementation Plan
[Implementation plan will be appended here from step 4]
## Review and Validation
[Review results will be appended here from step 5]
---
## Final Configuration
### Output Files to Generate
{{#outputFiles}}
- {{type}}: {{path}}
{{/outputFiles}}
### Target Location
- **Folder**: {{targetWorkflowPath}}
- **Module**: {{targetModule}}
- **Custom Location**: {{customWorkflowLocation}}
### Final Checklist
- [ ] All requirements documented
- [ ] Workflow designed and approved
- [ ] Files generated successfully
- [ ] Workflow tested and validated
## Ready for Implementation
When you approve this plan, I'll generate all the workflow files in the specified location with the exact structure and content outlined above.

4
src/modules/bmb/workflows/edit-agent/steps/step-01-discover-intent.md
View File

@ -10,8 +10,8 @@ thisStepFile: '{workflow_path}/steps/step-01-discover-intent.md'
nextStepFile: '{workflow_path}/steps/step-02-analyze-agent.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 1: Discover Edit Intent

24
src/modules/bmb/workflows/edit-agent/steps/step-02-analyze-agent.md
View File

@ -10,20 +10,20 @@ thisStepFile: '{workflow_path}/steps/step-02-analyze-agent.md'
nextStepFile: '{workflow_path}/steps/step-03-propose-changes.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Documentation References (load JIT based on user goals)
understanding_agent_types: '{project-root}/.bmad/bmb/docs/agents/understanding-agent-types.md'
agent_compilation: '{project-root}/.bmad/bmb/docs/agents/agent-compilation.md'
simple_architecture: '{project-root}/.bmad/bmb/docs/agents/simple-agent-architecture.md'
expert_architecture: '{project-root}/.bmad/bmb/docs/agents/expert-agent-architecture.md'
module_architecture: '{project-root}/.bmad/bmb/docs/agents/module-agent-architecture.md'
menu_patterns: '{project-root}/.bmad/bmb/docs/agents/agent-menu-patterns.md'
communication_presets: '{project-root}/.bmad/bmb/workflows/create-agent/data/communication-presets.csv'
reference_simple_agent: '{project-root}/.bmad/bmb/reference/agents/simple-examples/commit-poet.agent.yaml'
reference_expert_agent: '{project-root}/.bmad/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml'
validation: '{project-root}/.bmad/bmb/workflows/create-agent/data/agent-validation-checklist.md'
understanding_agent_types: '{project-root}/{bmad_folder}/bmb/docs/agents/understanding-agent-types.md'
agent_compilation: '{project-root}/{bmad_folder}/bmb/docs/agents/agent-compilation.md'
simple_architecture: '{project-root}/{bmad_folder}/bmb/docs/agents/simple-agent-architecture.md'
expert_architecture: '{project-root}/{bmad_folder}/bmb/docs/agents/expert-agent-architecture.md'
module_architecture: '{project-root}/{bmad_folder}/bmb/docs/agents/module-agent-architecture.md'
menu_patterns: '{project-root}/{bmad_folder}/bmb/docs/agents/agent-menu-patterns.md'
communication_presets: '{project-root}/{bmad_folder}/bmb/workflows/create-agent/data/communication-presets.csv'
reference_simple_agent: '{project-root}/{bmad_folder}/bmb/reference/agents/simple-examples/commit-poet.agent.yaml'
reference_expert_agent: '{project-root}/{bmad_folder}/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml'
validation: '{project-root}/{bmad_folder}/bmb/workflows/create-agent/data/agent-validation-checklist.md'
---
# Step 2: Analyze Agent

8
src/modules/bmb/workflows/edit-agent/steps/step-03-propose-changes.md
View File

@ -11,12 +11,12 @@ nextStepFile: '{workflow_path}/steps/step-04-apply-changes.md'
agentFile: '{{agent_path}}'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Documentation References (load JIT if needed)
communication_presets: '{project-root}/.bmad/bmb/workflows/create-agent/data/communication-presets.csv'
agent_compilation: '{project-root}/.bmad/bmb/docs/agents/agent-compilation.md'
communication_presets: '{project-root}/{bmad_folder}/bmb/workflows/create-agent/data/communication-presets.csv'
agent_compilation: '{project-root}/{bmad_folder}/bmb/docs/agents/agent-compilation.md'
---
# Step 3: Propose Changes

4
src/modules/bmb/workflows/edit-agent/steps/step-04-apply-changes.md
View File

@ -11,8 +11,8 @@ agentFile: '{{agent_path}}'
nextStepFile: '{workflow_path}/steps/step-05-validate.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 4: Apply Changes

8
src/modules/bmb/workflows/edit-agent/steps/step-05-validate.md
View File

@ -10,12 +10,12 @@ thisStepFile: '{workflow_path}/steps/step-05-validate.md'
agentFile: '{{agent_path}}'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Documentation References (load JIT)
validation: '{project-root}/.bmad/bmb/workflows/create-agent/data/agent-validation-checklist.md'
agent_compilation: '{project-root}/.bmad/bmb/docs/agents/agent-compilation.md'
validation: '{project-root}/{bmad_folder}/bmb/workflows/create-agent/data/agent-validation-checklist.md'
agent_compilation: '{project-root}/{bmad_folder}/bmb/docs/agents/agent-compilation.md'
---
# Step 5: Validate Changes

8
src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md
View File

@ -11,10 +11,6 @@ nextStepFile: '{workflow_path}/steps/step-02-discover.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.md'
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Template References
analysisTemplate: '{workflow_path}/templates/workflow-analysis.md'
---
@ -134,8 +130,8 @@ Based on what the user wants to edit:
Load reference documentation as needed:
- `{project-root}/{bmad_folder}/bmb/docs/workflows/architecture.md`
- `{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md`
- `{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md`
- `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md`
- `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md`
Check against best practices:

4
src/modules/bmb/workflows/edit-workflow/steps/step-03-improve.md
View File

@ -69,8 +69,8 @@ To facilitate collaborative improvements to the workflow, working iteratively on
Load documentation as needed for specific improvements:
- `{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md`
- `{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md`
- `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md`
- `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md`
- `{project-root}/{bmad_folder}/bmb/docs/workflows/architecture.md`
### 2. Address Each Improvement Iteratively

4
src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md
View File

@ -15,8 +15,8 @@ complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md'
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
---
# Step 1: Goal Confirmation and Workflow Target

10
src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md
View File

@ -16,8 +16,8 @@ targetWorkflowFile: '{target_workflow_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md'
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
---
# Step 2: Workflow.md Validation
@ -132,10 +132,10 @@ For each deviation:
"**Initialization Validation:**"
- Configuration Loading uses correct path format: `{project-root}/{bmad_folder}/[module]/config.yaml` (variable substitution pattern)
- Configuration Loading uses correct path format: `{project-root}/{*bmad_folder*}/[module]/config.yaml` (variable substitution pattern)
- First step follows pattern: `step-01-init.md` OR documented deviation
- Required config variables properly listed
- Variables use proper substitution pattern: {project-root}, {bmad_folder}, {workflow_path}, etc.
- Variables use proper substitution pattern: {project-root}, {_bmad_folder_}, {workflow_path}, etc.
For violations:
@ -198,7 +198,7 @@ Append to {complianceReportFile}:
"**Phase 1 Complete:** Workflow.md validation finished with detailed violation analysis.
**Ready for Phase 2:** Step-by-step validation against step-template.md
**Ready for Phase 3:** Step-by-step validation against step-template.md
This will check each step file for:

14
src/modules/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md
View File

@ -16,8 +16,8 @@ targetWorkflowStepsPath: '{target_workflow_steps_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md'
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
---
# Step 3: Step-by-Step Validation
@ -138,8 +138,8 @@ Check for proper references:
```yaml
# Task References
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{*bmad_folder*}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{*bmad_folder*}/core/workflows/party-mode/workflow.md'
```
**Violations to document:**
@ -186,7 +186,7 @@ For each step:
"**Path Variable Validation:**"
- Check format: `{project-root}/{bmad_folder}/bmb/...` vs `{project-root}/src/modules/bmb/...`
- Check format: `{project-root}/{*bmad_folder*}/bmb/...` vs `{project-root}/src/modules/bmb/...`
- Ensure consistent variable usage across all step files
- Validate relative vs absolute path usage
@ -232,13 +232,13 @@ For each step file with violations:
2. [Second most frequent]
3. [Third most frequent]
**Ready for Phase 3:** Holistic workflow analysis
**Ready for Phase 4:** File Validation workflow analysis
- Flow optimization assessment
- Goal alignment verification
- Meta-workflow failure analysis
**Select an Option:** [C] Continue to Holistic Analysis [X] Exit"
**Select an Option:** [C] Continue to File Validation [X] Exit"
## Menu Handling Logic:

6
src/modules/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md
View File

@ -16,8 +16,8 @@ targetWorkflowPath: '{target_workflow_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md'
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
csvStandards: '{project-root}/{bmad_folder}/bmb/docs/workflows/csv-data-file-standards.md'
---
@ -253,7 +253,7 @@ For each file with issues:
- **Formatting Standards:** [summary of markdown compliance issues]
- **Data Validation:** [summary of CSV standards compliance]
**Ready for Phase 5:** Holistic workflow analysis
**Ready for Phase 5:** Intent Spectrum Validation analysis
- Flow validation and goal alignment
- Meta-workflow failure analysis

6
src/modules/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md
View File

@ -16,8 +16,8 @@ targetWorkflowPath: '{target_workflow_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md'
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
intentSpectrum: '{project-root}/{bmad_folder}/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md'
---
@ -222,7 +222,7 @@ Append to {complianceReportFile}:
- **User Understanding:** Confirmed implications and benefits
- **Implementation Ready:** Guidance provided for maintaining position
**Ready for Phase 6:** Holistic workflow analysis
**Ready for Phase 6:** Web Subprocess Validation analysis
- Flow validation and completion paths
- Goal alignment and optimization assessment

6
src/modules/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md
View File

@ -16,8 +16,8 @@ targetWorkflowStepsPath: '{target_workflow_steps_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md'
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
intentSpectrum: '{project-root}/{bmad_folder}/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md'
---
@ -315,7 +315,7 @@ Append to {complianceReportFile}:
- **Performance Impact:** [expected efficiency gains]
- **User Experience Benefits:** [specific improvements]
**Ready for Phase 6:** Holistic workflow analysis
**Ready for Phase 7:** Holistic workflow analysis
- Flow validation and completion paths
- Goal alignment with optimized resources

6
src/modules/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md
View File

@ -16,8 +16,8 @@ targetWorkflowFile: '{target_workflow_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md'
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
intentSpectrum: '{project-root}/{bmad_folder}/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md'
---
@ -215,7 +215,7 @@ Evaluate workflow from user perspective:
- **Optimization Opportunities:** [number key improvements identified]
- **Meta-Workflow Failures:** [number issues that should have been prevented]
**Ready for Phase 6:** Comprehensive compliance report generation
**Ready for Phase 8:** Comprehensive compliance report generation
- All findings compiled into structured report
- Severity-ranked violation list

4
src/modules/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md
View File

@ -15,8 +15,8 @@ targetWorkflowFile: '{target_workflow_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md'
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
---
# Step 8: Comprehensive Compliance Report Generation

6
src/modules/bmm/agents/architect.agent.yaml
View File

@ -26,12 +26,8 @@ agent:
exec: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/architecture/workflow.md"
description: Create an Architecture Document to Guide Development of a PRD (required for BMad Method projects)
- trigger: validate-architecture
validate-workflow: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/architecture/workflow.yaml"
description: Validate Architecture Document (Recommended, use another LLM and fresh context for best results)
- trigger: implementation-readiness
workflow: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/implementation-readiness/workflow.yaml"
exec: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/implementation-readiness/workflow.md"
description: Validate PRD, UX, Architecture, Epics and stories aligned (Optional but recommended before development)
- trigger: create-excalidraw-diagram

10
src/modules/bmm/agents/pm.agent.yaml
View File

@ -27,14 +27,14 @@ agent:
exec: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/workflow.md"
description: Create Product Requirements Document (PRD) (Required for BMad Method flow)
- trigger: validate-prd
validate-workflow: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/workflow.yaml"
description: Validate PRD (Highly Recommended, use fresh context and different LLM for best results)
- trigger: create-epics-and-stories
workflow: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.yaml"
exec: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md"
description: Create Epics and User Stories from PRD (Required for BMad Method flow AFTER the Architecture is completed)
- trigger: implementation-readiness
exec: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/implementation-readiness/workflow.md"
description: Validate PRD, UX, Architecture, Epics and stories aligned (Optional but recommended before development)
- trigger: correct-course
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/correct-course/workflow.yaml"
description: Course Correction Analysis (optional during implementation when things go off track)

5
src/modules/bmm/docs/workflows-implementation.md
View File

@ -108,7 +108,8 @@ Stories move through these states in the sprint status file:
**As Needed:**
- Run `workflow-status` anytime to check progress
- Run `sprint-status` anytime in Phase 4 to inspect sprint-status.yaml and get the next implementation command
- Run `workflow-status` for cross-phase routing and project-level paths
- Run `correct-course` if significant changes needed
---
@ -155,7 +156,7 @@ PRD (PM) → Architecture (Architect)
## Troubleshooting
**Q: Which workflow should I run next?**
A: Run `workflow-status` - it reads the sprint status file and tells you exactly what to do.
A: Run `workflow-status` - it reads the sprint status file and tells you exactly what to do. During implementation (Phase 4) run `sprint-status` (fast check against sprint-status.yaml).
**Q: Story needs significant changes mid-implementation?**
A: Run `correct-course` to analyze impact and route appropriately.

4
src/modules/bmm/workflows/1-analysis/product-brief/steps/step-02-vision.md
View File

@ -12,8 +12,8 @@ workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/analysis/product-brief-{{project_name}}-{{date}}.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 2: Product Vision Discovery

4
src/modules/bmm/workflows/1-analysis/product-brief/steps/step-03-users.md
View File

@ -12,8 +12,8 @@ workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/analysis/product-brief-{{project_name}}-{{date}}.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 3: Target Users Discovery

4
src/modules/bmm/workflows/1-analysis/product-brief/steps/step-04-metrics.md
View File

@ -12,8 +12,8 @@ workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/analysis/product-brief-{{project_name}}-{{date}}.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 4: Success Metrics Definition

4
src/modules/bmm/workflows/1-analysis/product-brief/steps/step-05-scope.md
View File

@ -12,8 +12,8 @@ workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/analysis/product-brief-{{project_name}}-{{date}}.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
---
# Step 5: MVP Scope Definition

80
src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/epics-template.md
View File

@ -1,80 +0,0 @@
# {{project_name}} - Epic Breakdown
**Author:** {{user_name}}
**Date:** {{date}}
**Project Level:** {{project_level}}
**Target Scale:** {{target_scale}}
---
## Overview
This document provides the complete epic and story breakdown for {{project_name}}, decomposing the requirements from the [PRD](./PRD.md) into implementable stories.
**Living Document Notice:** This is the initial version. It will be updated after UX Design and Architecture workflows add interaction and technical details to stories.
{{epics_summary}}
---
## Functional Requirements Inventory
{{fr_inventory}}
---
## FR Coverage Map
{{fr_coverage_map}}
---
<!-- Repeat for each epic (N = 1, 2, 3...) -->
## Epic {{N}}: {{epic_title_N}}
{{epic_goal_N}}
<!-- Repeat for each story (M = 1, 2, 3...) within epic N -->
### Story {{N}}.{{M}}: {{story_title_N_M}}
As a {{user_type}},
I want {{capability}},
So that {{value_benefit}}.
**Acceptance Criteria:**
**Given** {{precondition}}
**When** {{action}}
**Then** {{expected_outcome}}
**And** {{additional_criteria}}
**Prerequisites:** {{dependencies_on_previous_stories}}
**Technical Notes:** {{implementation_guidance}}
<!-- End story repeat -->
---
<!-- End epic repeat -->
---
## FR Coverage Matrix
{{fr_coverage_matrix}}
---
## Summary
{{epic_breakdown_summary}}
---
_For implementation: Use the `create-story` workflow to generate individual story implementation plans from this epic breakdown._
_This document will be updated after UX Design and Architecture workflows to incorporate interaction details and technical decisions._

387
src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/instructions.md
View File

@ -1,387 +0,0 @@
# Epic and Story Creation with Full Technical Context
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
<critical>PREREQUISITES: PRD.md AND Architecture.md MUST be completed before running this workflow</critical>
<critical>UX Design.md is highly recommended if the product has user interfaces</critical>
<critical>EVERY story must be completable by a single dev agent in one focused session</critical>
<critical>⚠️ EPIC STRUCTURE PRINCIPLE: Each epic MUST deliver USER VALUE, not just technical capability. Epics are NOT organized by technical layers (database, API, frontend). Each epic should result in something USERS can actually use or benefit from. Exception: Foundation/setup stories at the start of first epic are acceptable.</critical>
<critical>Communicate all responses in {communication_language} and adapt to {user_skill_level}</critical>
<critical>Generate all documents in {document_output_language}</critical>
<critical>LIVING DOCUMENT: Write to epics.md continuously as you work - never wait until the end</critical>
<critical>Input documents specified in workflow.yaml input_file_patterns - workflow engine handles fuzzy matching, whole vs sharded document discovery automatically</critical>
<critical>⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever.</critical>
<critical>⚠️ CHECKPOINT PROTOCOL: After EVERY <template-output> tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints.</critical>
<workflow>
<step n="0" goal="Validate prerequisites and load all context">
<action>Welcome {user_name} to comprehensive epic and story creation</action>
<action>**CRITICAL PREREQUISITE VALIDATION:**</action>
<action>Verify required documents exist and are complete:
1. **PRD.md** - Contains functional requirements (FRs) and product scope
2. **Architecture.md** - Contains technical decisions, API contracts, data models
3. **UX Design.md** (if UI exists) - Contains interaction patterns, mockups, user flows
Missing any required document means this workflow cannot proceed successfully.</action>
<check if="!prd_content">
<output>❌ **PREREQUISITE FAILED: PRD.md not found**
The PRD is required to define what functionality needs to be built.
Please complete the PRD workflow first, then run this workflow again.</output>
<exit workflow="Missing required PRD document"/>
</check>
<check if="!architecture_content">
<output>❌ **PREREQUISITE FAILED: Architecture.md not found**
The Architecture document is required to provide technical implementation context for stories.
Please complete the Architecture workflow first, then run this workflow again.</output>
<exit workflow="Missing required Architecture document"/>
</check>
<action>List the documents loaded</action>
<action>**LOAD ALL CONTEXT DOCUMENTS:**</action>
<action>Load and analyze PRD.md:
Extract ALL functional requirements:
- Complete FR inventory (FR1, FR2, FR3...)
- Non-functional requirements and constraints
- Project scope boundaries (MVP vs growth vs vision)
- User types and their goals
- Success criteria
- Technical constraints
- Compliance requirements
**FR Inventory Creation:**
List every functional requirement with description for coverage tracking.
</action>
<action>Load and analyze Architecture.md:
Extract ALL technical implementation context relevant to the PRD functional requirements and project needs:
Scan comprehensively for any technical details needed to create complete user stories, including but not limited to:
- Technology stack decisions and framework choices
- API design, contracts, and integration patterns
- Data models, schemas, and relationships
- Authentication, authorization, and security patterns
- Performance requirements and scaling approaches
- Error handling, logging, and monitoring strategies
- Deployment architecture and infrastructure considerations
- Any other technical decisions, patterns, or constraints that impact implementation
Focus on extracting whatever technical context exists in the Architecture document that will be needed to create comprehensive, actionable user stories for all PRD requirements.
</action>
<action if="UX Design Exists">
Load and analyze UX Design.md:
Extract ALL user experience context relevant to the PRD functional requirements and project needs:
Scan comprehensively for any user experience details needed to create complete user stories, including but not limited to:
- User flows, journey patterns, and interaction design
- Screen layouts, components, and visual specifications
- Interaction patterns, behaviors, and micro-interactions
- Responsive design and mobile-first considerations
- Accessibility requirements and inclusive design patterns
- Animations, transitions, and feedback mechanisms
- Error states, validation patterns, and user guidance
- Any other UX/UI decisions, patterns, or specifications that impact implementation
Focus on extracting whatever user experience context exists in the UX document that will be needed to create comprehensive, actionable user stories for all PRD requirements.
</action>
<template-output>context_validation</template-output>
<template-output>fr_inventory</template-output>
</step>
<step n="1" goal="Design epic structure with full technical context">
<action>**STRATEGIC EPIC PLANNING WITH COMPLETE CONTEXT:**</action>
<action>Now that you have ALL available context (PRD + Architecture + UX), design epics that deliver incremental user value while leveraging the technical design decisions.
**EPIC DESIGN PRINCIPLES:**
1. **User-Value First**: Each epic must enable users to accomplish something meaningful
2. **Leverage Architecture**: Build upon the technical decisions already made
3. **Incremental Delivery**: Each epic should be independently valuable
4. **Logical Dependencies**: Dependencies should flow naturally, not artificially
**USE YOUR FULL CONTEXT:**
From PRD: Group related functional requirements that deliver user outcomes
From Architecture: Respect technical boundaries and integration points
From UX: Design around user journeys and interaction flows
**VALID EPIC EXAMPLES:**
✅ **CORRECT - User Value with Technical Context:**
- Epic 1: Foundation Setup (infrastructure, deployment, core services)
- Epic 2: User Authentication & Profile Management (register, login, profile management)
- Epic 3: Content Creation & Management (create, edit, publish, organize content)
- Epic 4: Content Discovery & Interaction (browse, search, share, comment)
❌ **WRONG - Technical Layer Breakdown:**
- Epic 1: Database Schema & Models
- Epic 2: REST API Endpoints
- Epic 3: Frontend Components
- Epic 4: Authentication Service
**PRESENT YOUR EPIC STRUCTURE:**
For each proposed epic, provide:
- **Epic Title**: Value-based, not technical
- **User Value Statement**: What users can accomplish after this epic
- **PRD Coverage**: Which FRs this epic addresses
- **Technical Context**: How this leverages Architecture decisions
- **UX Integration**: How this incorporates user experience patterns (if available)
- **Dependencies**: What must come before (natural dependencies only)
**FOUNDATION EPIC GUIDELINES:**
For Epic 1, include technical foundation based on Architecture:
- Project setup and build system
- Core infrastructure and deployment pipeline
- Database schema setup
- Basic authentication foundation
- API framework setup
This enables all subsequent user-facing epics.
</action>
<template-output>epics_structure_plan</template-output>
<template-output>epics_technical_context</template-output>
</step>
<step n="2" goal="Create detailed stories with complete implementation context" repeat="for-each-epic">
<action>**EPIC {{N}} - COMPREHENSIVE STORY CREATION:**</action>
<action>For Epic {{N}}: {{epic_title}}, create bite-sized stories that incorporate ALL available context.
**STORY CREATION WITH FULL CONTEXT:**
For each story, you now have the complete picture:
- **WHAT to build** (from PRD FRs)
- **HOW to build it** (from Architecture decisions)
- **HOW users interact** (from UX patterns, if available)
**TRANSFORM STRATEGIC REQUIREMENTS INTO TACTICAL IMPLEMENTATION:**
PRD says: "Users can create accounts"
Architecture says: "Use PostgreSQL with bcrypt hashing, JWT tokens, rate limiting"
UX says: "Modal dialog with email/password fields, real-time validation, loading states"
Your story becomes: Specific implementation details with exact acceptance criteria
**STORY PATTERN FOR EACH EPIC {{N}}:**
**Epic Goal:** {{epic_goal}}
For each story M in Epic {{N}}:
- **User Story**: As a [user type], I want [specific capability], So that [value/benefit]
- **Acceptance Criteria**: BDD format with COMPLETE implementation details
- **Technical Implementation**: Specific guidance from Architecture
- **User Experience**: Exact interaction patterns from UX (if available)
- **Prerequisites**: Only previous stories, never forward dependencies
**DETAILED ACCEPTANCE CRITERIA GUIDELINES:**
Include ALL implementation specifics:
**From Architecture:**
- Exact API endpoints and contracts
- Database operations and validations
- Authentication/authorization requirements
- Error handling patterns
- Performance requirements
- Security considerations
- Integration points with other systems
**From UX (if available):**
- Specific screen/page references
- Interaction patterns and behaviors
- Form validation rules and error messages
- Responsive behavior
- Accessibility requirements
- Loading states and transitions
- Success/error feedback patterns
**From PRD:**
- Business rules and constraints
- User types and permissions
- Compliance requirements
- Success criteria
**STORY SIZING PRINCIPLE:**
Each story must be completable by a single dev agent in one focused session. If a story becomes too large, break it down further while maintaining user value.
**EXAMPLE RICH STORY:**
**Story:** User Registration with Email Verification
As a new user, I want to create an account using my email address, So that I can access the platform's features.
**Acceptance Criteria:**
Given I am on the landing page
When I click the "Sign Up" button
Then the registration modal opens (UX Mockup 3.2)
And I see email and password fields with proper labels
And the email field validates RFC 5322 format in real-time
And the password field shows strength meter (red→yellow→green)
And I see "Password must be 8+ chars with 1 uppercase, 1 number, 1 special"
When I submit valid registration data
Then POST /api/v1/auth/register is called (Architecture section 4.1)
And the user record is created in users table with bcrypt hash (Architecture 6.2)
And a verification email is sent via SendGrid (Architecture 7.3)
And I see "Check your email for verification link" message
And I cannot log in until email is verified
**Technical Notes:**
- Use PostgreSQL users table (Architecture section 6.2)
- Implement rate limiting: 3 attempts per hour per IP (Architecture 8.1)
- Return JWT token on successful verification (Architecture 5.2)
- Log registration events to audit_events table (Architecture 9.4)
- Form validation follows UX Design patterns (UX section 4.1)
**Prerequisites:** Epic 1.1 - Foundation Setup Complete
</action>
<action>**Generate all stories for Epic {{N}}**</action>
<template-output>epic*title*{{N}}</template-output>
<template-output>epic*goal*{{N}}</template-output>
<action>For each story M in epic {{N}}, generate story content</action>
<template-output>story*{{N}}*{{M}}</template-output>
<action>**EPIC {{N}} COMPLETION REVIEW:**</action>
<output>**Epic {{N}} Complete: {{epic_title}}**
Stories Created: {{count}}
**FR Coverage:** {{list of FRs covered by this epic}}
**Technical Context Used:** {{Architecture sections referenced}}
{{if ux_design_content}}
**UX Patterns Incorporated:** {{UX sections referenced}}
{{/if}}
Ready for checkpoint validation.</output>
<template-output>epic\_{{N}}\_complete</template-output>
</step>
<step n="3" goal="Final validation and coverage matrix">
<action>**COMPREHENSIVE VALIDATION WITH FULL CONTEXT:**</action>
<action>Review the complete epic and story breakdown for quality and completeness using ALL available context.
**FR COVERAGE VALIDATION:**
Create complete FR Coverage Matrix showing every PRD functional requirement mapped to specific stories:
- **FR1:** [description] → Epic X, Story X.Y (with implementation details)
- **FR2:** [description] → Epic Y, Story Y.A (with implementation details)
- **FR3:** [description] → Epic Z, Story Z.B (with implementation details)
- ...
**CRITICAL VALIDATION:** Every single FR from the PRD must be covered by at least one story with complete acceptance criteria.
**ARCHITECTURE INTEGRATION VALIDATION:**
Verify that Architecture decisions are properly implemented:
- All API endpoints from Architecture are covered in stories
- Data models from Architecture are properly created and populated
- Authentication/authorization patterns are consistently applied
- Performance requirements are addressed in relevant stories
- Security measures are implemented where required
- Error handling follows Architecture patterns
- Integration points between systems are properly handled
**UX INTEGRATION VALIDATION** {{if ux_design_content}}:
Verify that UX design patterns are properly implemented:
- User flows follow the designed journey
- Screen layouts and components match specifications
- Interaction patterns work as designed
- Responsive behavior matches breakpoints
- Accessibility requirements are met
- Error states and feedback patterns are implemented
- Form validation follows UX guidelines
- Loading states and transitions are implemented
{{/if}}
**STORY QUALITY VALIDATION:**
- All stories are sized for single dev agent completion
- Acceptance criteria are specific and testable
- Technical implementation guidance is clear
- User experience details are incorporated
- No forward dependencies exist
- Epic sequence delivers incremental value
- Foundation epic properly enables subsequent work
**FINAL QUALITY CHECK:**
Answer these critical questions:
1. **User Value:** Does each epic deliver something users can actually do/use?
2. **Completeness:** Are ALL PRD functional requirements covered?
3. **Technical Soundness:** Do stories properly implement Architecture decisions?
4. **User Experience:** {{if ux_design_content}} Do stories follow UX design patterns? {{/if}}
5. **Implementation Ready:** Can dev agents implement these stories autonomously?
</action>
<output>**✅ EPIC AND STORY CREATION COMPLETE**
**Output Generated:** epics.md with comprehensive implementation details
**Full Context Incorporated:**
- ✅ PRD functional requirements and scope
- ✅ Architecture technical decisions and contracts
{{if ux_design_content}}
- ✅ UX Design interaction patterns and specifications
{{/if}}
**FR Coverage:** {{count}} functional requirements mapped to {{story_count}} stories
**Epic Structure:** {{epic_count}} epics delivering incremental user value
**Ready for Phase 4:** Sprint Planning and Development Implementation
</output>
<template-output>final_validation</template-output>
<template-output>fr_coverage_matrix</template-output>
</step>
</workflow>

258
src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md Normal file
View File

@ -0,0 +1,258 @@
---
name: 'step-01-validate-prerequisites'
description: 'Validate required documents exist and extract all requirements for epic and story creation'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories'
# File References
thisStepFile: '{workflow_path}/steps/step-01-validate-prerequisites.md'
nextStepFile: '{workflow_path}/steps/step-02-design-epics.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/epics.md'
epicsTemplate: '{workflow_path}/templates/epics-template.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
# Template References
epicsTemplate: '{workflow_path}/templates/epics-template.md'
---
# Step 1: Validate Prerequisites and Extract Requirements
## STEP GOAL:
To validate that all required input documents exist and extract all requirements (FRs, NFRs, and additional requirements from UX/Architecture) needed for epic and story creation.
## 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 strategist and technical specifications writer
- ✅ 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 requirements extraction expertise
- ✅ User brings their product vision and context
### Step-Specific Rules:
- 🎯 Focus ONLY on extracting and organizing requirements
- 🚫 FORBIDDEN to start creating epics or stories in this step
- 💬 Extract requirements from ALL available documents
- 🚪 POPULATE the template sections exactly as needed
## EXECUTION PROTOCOLS:
- 🎯 Extract requirements systematically from all documents
- 💾 Populate {outputFile} with extracted requirements
- 📖 Update frontmatter with extraction progress
- 🚫 FORBIDDEN to load next step until user selects 'C' and requirements are extracted
## REQUIREMENTS EXTRACTION PROCESS:
### 1. Welcome and Overview
Welcome {user_name} to comprehensive epic and story creation!
**CRITICAL PREREQUISITE VALIDATION:**
Verify required documents exist and are complete:
1. **PRD.md** - Contains requirements (FRs and NFRs) and product scope
2. **Architecture.md** - Contains technical decisions, API contracts, data models
3. **UX Design.md** (if UI exists) - Contains interaction patterns, mockups, user flows
### 2. Document Discovery and Validation
Search for required documents using these patterns (sharded means a large document was split into multiple small files with an index.md into a folder) - if the whole document is found, use that instead of the sharded version:
**PRD Document Search Priority:**
1. `{output_folder}/*prd*.md` (whole document)
2. `{output_folder}/*prd*/index.md` (sharded version)
**Architecture Document Search Priority:**
1. `{output_folder}/*architecture*.md` (whole document)
2. `{output_folder}/*architecture*/index.md` (sharded version)
**UX Design Document Search (Optional):**
1. `{output_folder}/*ux*.md` (whole document)
2. `{output_folder}/*ux*/index.md` (sharded version)
Ask the user if there are any other documents, or if what you have found is all there is [Yes/No]. Wait for user confirmation. Once confirmed, create the {outputFile} from the {epicsTemplate} and in the front matter list the files in the array of `inputDocuments: []`.
### 3. Extract Functional Requirements (FRs)
From the PRD document (full or sharded), extract ALL functional requirements:
**Extraction Method:**
- Look for numbered items like "FR1:", "Functional Requirement 1:", or similar
- Identify requirement statements that describe what the system must DO
- Include user actions, system behaviors, and business rules
**Format the FR list as:**
```
FR1: [Clear, testable requirement description]
FR2: [Clear, testable requirement description]
...
```
### 4. Extract Non-Functional Requirements (NFRs)
From the PRD document, extract ALL non-functional requirements:
**Extraction Method:**
- Look for performance, security, usability, reliability requirements
- Identify constraints and quality attributes
- Include technical standards and compliance requirements
**Format the NFR list as:**
```
NFR1: [Performance/Security/Usability requirement]
NFR2: [Performance/Security/Usability requirement]
...
```
### 5. Extract Additional Requirements from Architecture
Review the Architecture document for technical requirements that impact epic and story creation:
**Look for:**
- **Starter Template**: Does Architecture specify a starter/greenfield template? If YES, document this for Epic 1 Story 1
- Infrastructure and deployment requirements
- Integration requirements with external systems
- Data migration or setup requirements
- Monitoring and logging requirements
- API versioning or compatibility requirements
- Security implementation requirements
**IMPORTANT**: If a starter template is mentioned in Architecture, note it prominently. This will impact Epic 1 Story 1.
**Format Additional Requirements as:**
```
- [Technical requirement from Architecture that affects implementation]
- [Infrastructure setup requirement]
- [Integration requirement]
...
```
### 6. Extract Additional Requirements from UX (if exists)
Review the UX document for requirements that affect epic and story creation:
**Look for:**
- Responsive design requirements
- Accessibility requirements
- Browser/device compatibility
- User interaction patterns that need implementation
- Animation or transition requirements
- Error handling UX requirements
**Add these to Additional Requirements list.**
### 7. Load and Initialize Template
Load {epicsTemplate} and initialize {outputFile}:
1. Copy the entire template to {outputFile}
2. Replace {{project_name}} with the actual project name
3. Replace placeholder sections with extracted requirements:
- {{fr_list}} → extracted FRs
- {{nfr_list}} → extracted NFRs
- {{additional_requirements}} → extracted additional requirements
4. Leave {{requirements_coverage_map}} and {{epics_list}} as placeholders for now
### 8. Present Extracted Requirements
Display to user:
**Functional Requirements Extracted:**
- Show count of FRs found
- Display the first few FRs as examples
- Ask if any FRs are missing or incorrectly captured
**Non-Functional Requirements Extracted:**
- Show count of NFRs found
- Display key NFRs
- Ask if any constraints were missed
**Additional Requirements:**
- Summarize technical requirements from Architecture
- Summarize UX requirements (if applicable)
- Verify completeness
### 9. Get User Confirmation
Ask: "Do these extracted requirements accurately represent what needs to be built? Any additions or corrections?"
Update the requirements based on user feedback until confirmation is received.
## CONTENT TO SAVE TO DOCUMENT:
After extraction and confirmation, update {outputFile} with:
- Complete FR list in {{fr_list}} section
- Complete NFR list in {{nfr_list}} section
- All additional requirements in {{additional_requirements}} section
### 10. Present MENU OPTIONS
Display: `**Confirm the Requirements are complete and correct to [C] continue:**`
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed to next step when user selects 'C'
- User can chat or ask questions - always respond and then end with display again of the menu option
#### Menu Handling Logic:
- IF C: Save all to {outputFile}, update frontmatter, only then load, read entire file, then execute {nextStepFile}
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#10-present-menu-options)
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and all requirements are saved to document and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin epic design step.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- All required documents found and validated
- All FRs extracted and formatted correctly
- All NFRs extracted and formatted correctly
- Additional requirements from Architecture/UX identified
- Template initialized with requirements
- User confirms requirements are complete and accurate
### ❌ SYSTEM FAILURE:
- Missing required documents
- Incomplete requirements extraction
- Template not properly initialized
- Not saving requirements to output file
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

232
src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md Normal file
View File

@ -0,0 +1,232 @@
---
name: 'step-02-design-epics'
description: 'Design and approve the epics_list that will organize all requirements into user-value-focused epics'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories'
# File References
thisStepFile: '{workflow_path}/steps/step-02-design-epics.md'
nextStepFile: '{workflow_path}/steps/step-03-create-stories.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/epics.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
# Template References
epicsTemplate: '{workflow_path}/templates/epics-template.md'
---
# Step 2: Design Epic List
## STEP GOAL:
To design and get approval for the epics_list that will organize all requirements into user-value-focused epics.
## 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 strategist and technical specifications writer
- ✅ 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 product strategy and epic design expertise
- ✅ User brings their product vision and priorities
### Step-Specific Rules:
- 🎯 Focus ONLY on creating the epics_list
- 🚫 FORBIDDEN to create individual stories in this step
- 💬 Organize epics around user value, not technical layers
- 🚪 GET explicit approval for the epics_list
- 🔗 **CRITICAL: Each epic must be standalone and enable future epics without requiring future epics to function**
## EXECUTION PROTOCOLS:
- 🎯 Design epics collaboratively based on extracted requirements
- 💾 Update {{epics_list}} in {outputFile}
- 📖 Document the FR coverage mapping
- 🚫 FORBIDDEN to load next step until user approves epics_list
## EPIC DESIGN PROCESS:
### 1. Review Extracted Requirements
Load {outputFile} and review:
- **Functional Requirements:** Count and review FRs from Step 1
- **Non-Functional Requirements:** Review NFRs that need to be addressed
- **Additional Requirements:** Review technical and UX requirements
### 2. Explain Epic Design Principles
**EPIC DESIGN PRINCIPLES:**
1. **User-Value First**: Each epic must enable users to accomplish something meaningful
2. **Requirements Grouping**: Group related FRs that deliver cohesive user outcomes
3. **Incremental Delivery**: Each epic should deliver value independently
4. **Logical Flow**: Natural progression from user's perspective
5. **🔗 Dependency-Free Within Epic**: Stories within an epic must NOT depend on future stories
**⚠️ CRITICAL PRINCIPLE:**
Organize by USER VALUE, not technical layers:
**✅ CORRECT Epic Examples (Standalone & Enable Future Epics):**
- Epic 1: User Authentication & Profiles (users can register, login, manage profiles) - **Standalone: Complete auth system**
- Epic 2: Content Creation (users can create, edit, publish content) - **Standalone: Uses auth, creates content**
- Epic 3: Social Interaction (users can follow, comment, like content) - **Standalone: Uses auth + content**
- Epic 4: Search & Discovery (users can find content and other users) - **Standalone: Uses all previous**
**❌ WRONG Epic Examples (Technical Layers or Dependencies):**
- Epic 1: Database Setup (creates all tables upfront) - **No user value**
- Epic 2: API Development (builds all endpoints) - **No user value**
- Epic 3: Frontend Components (creates reusable components) - **No user value**
- Epic 4: Deployment Pipeline (CI/CD setup) - **No user value**
**🔗 DEPENDENCY RULES:**
- Each epic must deliver COMPLETE functionality for its domain
- Epic 2 must not require Epic 3 to function
- Epic 3 can build upon Epic 1 & 2 but must stand alone
### 3. Design Epic Structure Collaboratively
**Step A: Identify User Value Themes**
- Look for natural groupings in the FRs
- Identify user journeys or workflows
- Consider user types and their goals
**Step B: Propose Epic Structure**
For each proposed epic:
1. **Epic Title**: User-centric, value-focused
2. **User Outcome**: What users can accomplish after this epic
3. **FR Coverage**: Which FR numbers this epic addresses
4. **Implementation Notes**: Any technical or UX considerations
**Step C: Create the epics_list**
Format the epics_list as:
```
## Epic List
### Epic 1: [Epic Title]
[Epic goal statement - what users can accomplish]
**FRs covered:** FR1, FR2, FR3, etc.
### Epic 2: [Epic Title]
[Epic goal statement - what users can accomplish]
**FRs covered:** FR4, FR5, FR6, etc.
[Continue for all epics]
```
### 4. Present Epic List for Review
Display the complete epics_list to user with:
- Total number of epics
- FR coverage per epic
- User value delivered by each epic
- Any natural dependencies
### 5. Create Requirements Coverage Map
Create {{requirements_coverage_map}} showing how each FR maps to an epic:
```
### FR Coverage Map
FR1: Epic 1 - [Brief description]
FR2: Epic 1 - [Brief description]
FR3: Epic 2 - [Brief description]
...
```
This ensures no FRs are missed.
### 6. Collaborative Refinement
Ask user:
- "Does this epic structure align with your product vision?"
- "Are all user outcomes properly captured?"
- "Should we adjust any epic groupings?"
- "Are there natural dependencies we've missed?"
### 7. Get Final Approval
**CRITICAL:** Must get explicit user approval:
"Do you approve this epic structure for proceeding to story creation?"
If user wants changes:
- Make the requested adjustments
- Update the epics_list
- Re-present for approval
- Repeat until approval is received
## CONTENT TO UPDATE IN DOCUMENT:
After approval, update {outputFile}:
1. Replace {{epics_list}} placeholder with the approved epic list
2. Replace {{requirements_coverage_map}} with the coverage map
3. Ensure all FRs are mapped to epics
### 8. Present MENU OPTIONS
Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
#### Menu Handling Logic:
- IF A: Execute {advancedElicitationTask}
- IF P: Execute {partyModeWorkflow}
- IF C: Save approved epics_list to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#8-present-menu-options)
#### 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 completes, redisplay the menu
- User can chat or ask questions - always respond when conversation ends, redisplay the menu options
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and the approved epics_list is saved to document, will you then load, read entire file, then execute {nextStepFile} to execute and begin story creation step.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Epics designed around user value
- All FRs mapped to specific epics
- epics_list created and formatted correctly
- Requirements coverage map completed
- User gives explicit approval for epic structure
- Document updated with approved epics
### ❌ SYSTEM FAILURE:
- Epics organized by technical layers
- Missing FRs in coverage map
- No user approval obtained
- epics_list not saved to document
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

271
src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md Normal file
View File

@ -0,0 +1,271 @@
---
name: 'step-03-create-stories'
description: 'Generate all epics with their stories following the template structure'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories'
# File References
thisStepFile: '{workflow_path}/steps/step-03-create-stories.md'
nextStepFile: '{workflow_path}/steps/step-04-final-validation.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/epics.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
# Template References
epicsTemplate: '{workflow_path}/templates/epics-template.md'
---
# Step 3: Generate Epics and Stories
## STEP GOAL:
To generate all epics with their stories based on the approved epics_list, following the template structure exactly.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 🔄 CRITICAL: Process epics sequentially
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are a product strategist and technical specifications writer
- ✅ 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 story creation and acceptance criteria expertise
- ✅ User brings their implementation priorities and constraints
### Step-Specific Rules:
- 🎯 Generate stories for each epic following the template exactly
- 🚫 FORBIDDEN to deviate from template structure
- 💬 Each story must have clear acceptance criteria
- 🚪 ENSURE each story is completable by a single dev agent
- 🔗 **CRITICAL: Stories MUST NOT depend on future stories within the same epic**
## EXECUTION PROTOCOLS:
- 🎯 Generate stories collaboratively with user input
- 💾 Append epics and stories to {outputFile} following template
- 📖 Process epics one at a time in sequence
- 🚫 FORBIDDEN to skip any epic or rush through stories
## STORY GENERATION PROCESS:
### 1. Load Approved Epic Structure
Load {outputFile} and review:
- Approved epics_list from Step 2
- FR coverage map
- All requirements (FRs, NFRs, additional)
- Template structure at the end of the document
### 2. Explain Story Creation Approach
**STORY CREATION GUIDELINES:**
For each epic, create stories that:
- Follow the exact template structure
- Are sized for single dev agent completion
- Have clear user value
- Include specific acceptance criteria
- Reference requirements being fulfilled
**🚨 DATABASE/ENTITY CREATION PRINCIPLE:**
Create tables/entities ONLY when needed by the story:
- ❌ WRONG: Epic 1 Story 1 creates all 50 database tables
- ✅ RIGHT: Each story creates/alters ONLY the tables it needs
**🔗 STORY DEPENDENCY PRINCIPLE:**
Stories must be independently completable in sequence:
- ❌ WRONG: Story 1.2 requires Story 1.3 to be completed first
- ✅ RIGHT: Each story can be completed based only on previous stories
- ❌ WRONG: "Wait for Story 1.4 to be implemented before this works"
- ✅ RIGHT: "This story works independently and enables future stories"
**STORY FORMAT (from template):**
```
### Story {N}.{M}: {story_title}
As a {user_type},
I want {capability},
So that {value_benefit}.
**Acceptance Criteria:**
**Given** {precondition}
**When** {action}
**Then** {expected_outcome}
**And** {additional_criteria}
```
**✅ GOOD STORY EXAMPLES:**
_Epic 1: User Authentication_
- Story 1.1: User Registration with Email
- Story 1.2: User Login with Password
- Story 1.3: Password Reset via Email
_Epic 2: Content Creation_
- Story 2.1: Create New Blog Post
- Story 2.2: Edit Existing Blog Post
- Story 2.3: Publish Blog Post
**❌ BAD STORY EXAMPLES:**
- Story: "Set up database" (no user value)
- Story: "Create all models" (too large, no user value)
- Story: "Build authentication system" (too large)
- Story: "Login UI (depends on Story 1.3 API endpoint)" (future dependency!)
- Story: "Edit post (requires Story 1.4 to be implemented first)" (wrong order!)
### 3. Process Epics Sequentially
For each epic in the approved epics_list:
#### A. Epic Overview
Display:
- Epic number and title
- Epic goal statement
- FRs covered by this epic
- Any NFRs or additional requirements relevant
#### B. Story Breakdown
Work with user to break down the epic into stories:
- Identify distinct user capabilities
- Ensure logical flow within the epic
- Size stories appropriately
#### C. Generate Each Story
For each story in the epic:
1. **Story Title**: Clear, action-oriented
2. **User Story**: Complete the As a/I want/So that format
3. **Acceptance Criteria**: Write specific, testable criteria
**AC Writing Guidelines:**
- Use Given/When/Then format
- Each AC should be independently testable
- Include edge cases and error conditions
- Reference specific requirements when applicable
#### D. Collaborative Review
After writing each story:
- Present the story to user
- Ask: "Does this story capture the requirement correctly?"
- "Is the scope appropriate for a single dev session?"
- "Are the acceptance criteria complete and testable?"
#### E. Append to Document
When story is approved:
- Append it to {outputFile} following template structure
- Use correct numbering (Epic N, Story M)
- Maintain proper markdown formatting
### 4. Epic Completion
After all stories for an epic are complete:
- Display epic summary
- Show count of stories created
- Verify all FRs for the epic are covered
- Get user confirmation to proceed to next epic
### 5. Repeat for All Epics
Continue the process for each epic in the approved list, processing them in order (Epic 1, Epic 2, etc.).
### 6. Final Document Completion
After all epics and stories are generated:
- Verify the document follows template structure exactly
- Ensure all placeholders are replaced
- Confirm all FRs are covered
- Check formatting consistency
## TEMPLATE STRUCTURE COMPLIANCE:
The final {outputFile} must follow this structure exactly:
1. **Overview** section with project name
2. **Requirements Inventory** with all three subsections populated
3. **FR Coverage Map** showing requirement to epic mapping
4. **Epic List** with approved epic structure
5. **Epic sections** for each epic (N = 1, 2, 3...)
- Epic title and goal
- All stories for that epic (M = 1, 2, 3...)
- Story title and user story
- Acceptance Criteria using Given/When/Then format
### 7. Present FINAL MENU OPTIONS
After all epics and stories are complete:
Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
#### Menu Handling Logic:
- IF A: Execute {advancedElicitationTask}
- IF P: Execute {partyModeWorkflow}
- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-final-menu-options)
#### 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
- User can chat or ask questions - always respond and then end with display again of the menu options
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN [C continue option] is selected and [all epics and stories saved to document following the template structure exactly], will you then load and read fully `{nextStepFile}` to execute and begin final validation phase.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- All epics processed in sequence
- Stories created for each epic
- Template structure followed exactly
- All FRs covered by stories
- Stories appropriately sized
- Acceptance criteria are specific and testable
- Document is complete and ready for development
### ❌ SYSTEM FAILURE:
- Deviating from template structure
- Missing epics or stories
- Stories too large or unclear
- Missing acceptance criteria
- Not following proper formatting
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

144
src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md Normal file
View File

@ -0,0 +1,144 @@
---
name: 'step-04-final-validation'
description: 'Validate complete coverage of all requirements and ensure implementation readiness'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories'
# File References
thisStepFile: '{workflow_path}/steps/step-04-final-validation.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/epics.md'
# Task References
advancedElicitationTask: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.md'
# Template References
epicsTemplate: '{workflow_path}/templates/epics-template.md'
---
# Step 4: Final Validation
## STEP GOAL:
To validate complete coverage of all requirements and ensure stories are ready for development.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 🔄 CRITICAL: Process validation sequentially without skipping
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are a product strategist and technical specifications writer
- ✅ 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 validation expertise and quality assurance
- ✅ User brings their implementation priorities and final review
### Step-Specific Rules:
- 🎯 Focus ONLY on validating complete requirements coverage
- 🚫 FORBIDDEN to skip any validation checks
- 💬 Validate FR coverage, story completeness, and dependencies
- 🚪 ENSURE all stories are ready for development
## EXECUTION PROTOCOLS:
- 🎯 Validate every requirement has story coverage
- 💾 Check story dependencies and flow
- 📖 Verify architecture compliance
- 🚫 FORBIDDEN to approve incomplete coverage
## CONTEXT BOUNDARIES:
- Available context: Complete epic and story breakdown from previous steps
- Focus: Final validation of requirements coverage and story readiness
- Limits: Validation only, no new content creation
- Dependencies: Completed story generation from Step 3
## VALIDATION PROCESS:
### 1. FR Coverage Validation
Review the complete epic and story breakdown to ensure EVERY FR is covered:
**CRITICAL CHECK:**
- Go through each FR from the Requirements Inventory
- Verify it appears in at least one story
- Check that acceptance criteria fully address the FR
- No FRs should be left uncovered
### 2. Architecture Implementation Validation
**Check for Starter Template Setup:**
- Does Architecture document specify a starter template?
- If YES: Epic 1 Story 1 must be "Set up initial project from starter template"
- This includes cloning, installing dependencies, initial configuration
**Database/Entity Creation Validation:**
- Are database tables/entities created ONLY when needed by stories?
- ❌ WRONG: Epic 1 creates all tables upfront
- ✅ RIGHT: Tables created as part of the first story that needs them
- Each story should create/modify ONLY what it needs
### 3. Story Quality Validation
**Each story must:**
- Be completable by a single dev agent
- Have clear acceptance criteria
- Reference specific FRs it implements
- Include necessary technical details
- **Not have forward dependencies** (can only depend on PREVIOUS stories)
- Be implementable without waiting for future stories
### 4. Epic Structure Validation
**Check that:**
- Epics deliver user value, not technical milestones
- Dependencies flow naturally
- Foundation stories only setup what's needed
- No big upfront technical work
### 5. Dependency Validation (CRITICAL)
**Epic Independence Check:**
- Does each epic deliver COMPLETE functionality for its domain?
- Can Epic 2 function without Epic 3 being implemented?
- Can Epic 3 function standalone using Epic 1 & 2 outputs?
- ❌ WRONG: Epic 2 requires Epic 3 features to work
- ✅ RIGHT: Each epic is independently valuable
**Within-Epic Story Dependency Check:**
For each epic, review stories in order:
- Can Story N.1 be completed without Stories N.2, N.3, etc.?
- Can Story N.2 be completed using only Story N.1 output?
- Can Story N.3 be completed using only Stories N.1 & N.2 outputs?
- ❌ WRONG: "This story depends on a future story"
- ❌ WRONG: Story references features not yet implemented
- ✅ RIGHT: Each story builds only on previous stories
### 6. Complete and Save
If all validations pass:
- Update any remaining placeholders in the document
- Ensure proper formatting
- Save the final epics.md
**Present Final Menu:**
**All validations complete!** [C] Complete Workflow
When C is selected, the workflow is complete and the epics.md is ready for development.

57
src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md Normal file
View File

@ -0,0 +1,57 @@
---
stepsCompleted: []
inputDocuments: []
---
# {{project_name}} - Epic Breakdown
## Overview
This document provides the complete epic and story breakdown for {{project_name}}, decomposing the requirements from the PRD, UX Design if it exists, and Architecture requirements into implementable stories.
## Requirements Inventory
### Functional Requirements
{{fr_list}}
### NonFunctional Requirements
{{nfr_list}}
### Additional Requirements
{{additional_requirements}}
### FR Coverage Map
{{requirements_coverage_map}}
## Epic List
{{epics_list}}
<!-- Repeat for each epic in epics_list (N = 1, 2, 3...) -->
## Epic {{N}}: {{epic_title_N}}
{{epic_goal_N}}
<!-- Repeat for each story (M = 1, 2, 3...) within epic N -->
### Story {{N}}.{{M}}: {{story_title_N_M}}
As a {{user_type}},
I want {{capability}},
So that {{value_benefit}}.
**Acceptance Criteria:**
<!-- for each AC on this story -->
**Given** {{precondition}}
**When** {{action}}
**Then** {{expected_outcome}}
**And** {{additional_criteria}}
<!-- End story repeat -->

58
src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md Normal file
View File

@ -0,0 +1,58 @@
---
name: 'Create Epics and Stories'
description: 'Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value. This workflow requires completed PRD + Architecture documents (UX recommended if UI exists) and breaks down requirements into implementation-ready epics and user stories that incorporate all available technical and design context. Creates detailed, actionable stories with complete acceptance criteria for development teams.'
web_bundle: true
---
# Create Epics and Stories
**Goal:** Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value, creating detailed, actionable stories with complete acceptance criteria for development teams.
**Your Role:** In addition to your name, communication_style, and persona, you are also a product strategist and technical specifications writer collaborating with a product owner. This is a partnership, not a client-vendor relationship. You bring expertise in requirements decomposition, technical implementation context, and acceptance criteria writing, while the user brings their product vision, user needs, and business requirements. Work together as equals.
---
## WORKFLOW ARCHITECTURE
This uses **step-file architecture** for disciplined execution:
### Core Principles
- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time
- **Just-In-Time Loading**: Only 1 current step file will be loaded, read, and executed to completion - never load future step files until told to do so
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
- **Append-Only Building**: Build documents by appending content as directed to the output file
### Step Processing Rules
1. **READ COMPLETELY**: Always read the entire step file before taking any action
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
### Critical Rules (NO EXCEPTIONS)
- 🛑 **NEVER** load multiple step files simultaneously
- 📖 **ALWAYS** read entire step file before execution
- 🚫 **NEVER** skip steps or optimize the sequence
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
- 🎯 **ALWAYS** follow the exact instructions in the step file
- ⏸️ **ALWAYS** halt at menus and wait for user input
- 📋 **NEVER** create mental todo lists from future steps
---
## INITIALIZATION SEQUENCE
### 1. Configuration Loading
Load and read full config from {project-root}/{bmad_folder}/bmm/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`
### 2. First Step EXECUTION
Load, read the full file and then execute `{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md` to begin the workflow.

53
src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.yaml
View File

@ -1,53 +0,0 @@
# Epic and Story Decomposition Workflow
name: create-epics-and-stories
description: "Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value. This workflow requires completed PRD + Architecture documents (UX recommended if UI exists) and breaks down requirements into implementation-ready epics and user stories that incorporate all available technical and design context. Creates detailed, actionable stories with complete acceptance criteria for development teams."
author: "BMad"
# Critical variables from config
config_source: "{project-root}/{bmad_folder}/bmm/config.yaml"
project_name: "{config_source}:project_name"
output_folder: "{config_source}:output_folder"
user_name: "{config_source}:user_name"
communication_language: "{config_source}:communication_language"
document_output_language: "{config_source}:document_output_language"
user_skill_level: "{config_source}:user_skill_level"
date: system-generated
# Smart input file references - handles both whole docs and sharded docs
# Priority: Whole document first, then sharded version
input_file_patterns:
prd:
description: "Product Requirements Document with FRs and NFRs (required)"
whole: "{output_folder}/*prd*.md"
sharded: "{output_folder}/*prd*/index.md"
load_strategy: "INDEX_GUIDED"
architecture:
description: "Architecture decisions and technical design (required)"
whole: "{output_folder}/*architecture*.md"
sharded: "{output_folder}/*architecture*/index.md"
load_strategy: "FULL_LOAD"
ux_design:
description: "UX design specification for interaction patterns (recommended if UI exists)"
whole: "{output_folder}/*ux*.md"
sharded: "{output_folder}/*ux*/index.md"
load_strategy: "FULL_LOAD"
# Module path and component files
installed_path: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories"
instructions: "{installed_path}/instructions.md"
template: "{installed_path}/epics-template.md"
# Output configuration
default_output_file: "{output_folder}/epics.md"
standalone: true
web_bundle:
name: "create-epics-and-stories"
description: "Transform PRD requirements into bite-sized stories organized in epics for 200k context dev agents"
author: "BMad"
instructions: "{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories/instructions.md"
template: "{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories/epics-template.md"
web_bundle_files:
- "{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories/instructions.md"
- "{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories/epics-template.md"

169
src/modules/bmm/workflows/3-solutioning/implementation-readiness/checklist.md
View File

@ -1,169 +0,0 @@
# Implementation Readiness Validation Checklist
## Document Completeness
### Core Planning Documents
- [ ] PRD exists and is complete
- [ ] PRD contains measurable success criteria
- [ ] PRD defines clear scope boundaries and exclusions
- [ ] Architecture document exists (architecture\*.md)
- [ ] Technical Specification exists with implementation details
- [ ] Epic and story breakdown document exists
- [ ] All documents are dated and versioned
### Document Quality
- [ ] No placeholder sections remain in any document
- [ ] All documents use consistent terminology
- [ ] Technical decisions include rationale and trade-offs
- [ ] Assumptions and risks are explicitly documented
- [ ] Dependencies are clearly identified and documented
## Alignment Verification
### PRD to Architecture Alignment
- [ ] Every functional requirement in PRD has architectural support documented
- [ ] All non-functional requirements from PRD are addressed in architecture
- [ ] Architecture doesn't introduce features beyond PRD scope
- [ ] Performance requirements from PRD match architecture capabilities
- [ ] Security requirements from PRD are fully addressed in architecture
- [ ] If architecture.md: Implementation patterns are defined for consistency
- [ ] If architecture.md: All technology choices have verified versions
- [ ] If UX spec exists: Architecture supports UX requirements
### PRD to Stories Coverage
- [ ] Every PRD requirement maps to at least one story
- [ ] All user journeys in PRD have complete story coverage
- [ ] Story acceptance criteria align with PRD success criteria
- [ ] Priority levels in stories match PRD feature priorities
- [ ] No stories exist without PRD requirement traceability
### Architecture to Stories Implementation
- [ ] All architectural components have implementation stories
- [ ] Infrastructure setup stories exist for each architectural layer
- [ ] Integration points defined in architecture have corresponding stories
- [ ] Data migration/setup stories exist if required by architecture
- [ ] Security implementation stories cover all architecture security decisions
## Story and Sequencing Quality
### Story Completeness
- [ ] All stories have clear acceptance criteria
- [ ] Technical tasks are defined within relevant stories
- [ ] Stories include error handling and edge cases
- [ ] Each story has clear definition of done
- [ ] Stories are appropriately sized (no epic-level stories remaining)
### Sequencing and Dependencies
- [ ] Stories are sequenced in logical implementation order
- [ ] Dependencies between stories are explicitly documented
- [ ] No circular dependencies exist
- [ ] Prerequisite technical tasks precede dependent stories
- [ ] Foundation/infrastructure stories come before feature stories
### Greenfield Project Specifics
- [ ] Initial project setup and configuration stories exist
- [ ] If using architecture.md: First story is starter template initialization command
- [ ] Development environment setup is documented
- [ ] CI/CD pipeline stories are included early in sequence
- [ ] Database/storage initialization stories are properly placed
- [ ] Authentication/authorization stories precede protected features
## Risk and Gap Assessment
### Critical Gaps
- [ ] No core PRD requirements lack story coverage
- [ ] No architectural decisions lack implementation stories
- [ ] All integration points have implementation plans
- [ ] Error handling strategy is defined and implemented
- [ ] Security concerns are all addressed
### Technical Risks
- [ ] No conflicting technical approaches between stories
- [ ] Technology choices are consistent across all documents
- [ ] Performance requirements are achievable with chosen architecture
- [ ] Scalability concerns are addressed if applicable
- [ ] Third-party dependencies are identified with fallback plans
## UX and Special Concerns (if applicable)
### UX Coverage
- [ ] UX requirements are documented in PRD
- [ ] UX implementation tasks exist in relevant stories
- [ ] Accessibility requirements have story coverage
- [ ] Responsive design requirements are addressed
- [ ] User flow continuity is maintained across stories
### Special Considerations
- [ ] Compliance requirements are fully addressed
- [ ] Internationalization needs are covered if required
- [ ] Performance benchmarks are defined and measurable
- [ ] Monitoring and observability stories exist
- [ ] Documentation stories are included where needed
## Overall Readiness
### Ready to Proceed Criteria
- [ ] All critical issues have been resolved
- [ ] High priority concerns have mitigation plans
- [ ] Story sequencing supports iterative delivery
- [ ] Team has necessary skills for implementation
- [ ] No blocking dependencies remain unresolved
### Quality Indicators
- [ ] Documents demonstrate thorough analysis
- [ ] Clear traceability exists across all artifacts
- [ ] Consistent level of detail throughout documents
- [ ] Risks are identified with mitigation strategies
- [ ] Success criteria are measurable and achievable
## Assessment Completion
### Report Quality
- [ ] All findings are supported by specific examples
- [ ] Recommendations are actionable and specific
- [ ] Severity levels are appropriately assigned
- [ ] Positive findings are highlighted
- [ ] Next steps are clearly defined
### Process Validation
- [ ] All expected documents were reviewed
- [ ] Cross-references were systematically checked
- [ ] Project level considerations were applied correctly
- [ ] Workflow status was checked and considered
- [ ] Output folder was thoroughly searched for artifacts
---
## Issue Log
### Critical Issues Found
<!-- checklist of critical issues or N/A -->
### High Priority Issues Found
<!-- checklist of high priority issues or N/A -->
### Medium Priority Issues Found
<!-- checklist of medium priority issues or N/A -->
---
_Use this checklist to ensure comprehensive validation of implementation readiness_

332
src/modules/bmm/workflows/3-solutioning/implementation-readiness/instructions.md
View File

@ -1,332 +0,0 @@
# Implementation Readiness - Workflow Instructions
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmm/workflows/3-solutioning/implementation-readiness/workflow.yaml</critical>
<critical>Communicate all findings and analysis in {communication_language} throughout the assessment</critical>
<critical>Input documents specified in workflow.yaml input_file_patterns - workflow engine handles fuzzy matching, whole vs sharded document discovery automatically</critical>
<critical>⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever.</critical>
<critical>⚠️ CHECKPOINT PROTOCOL: After EVERY <template-output> tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints.</critical>
<workflow>
<step n="0" goal="Validate workflow readiness" tag="workflow-status">
<action>Check if {workflow_status_file} exists</action>
<check if="status file not found">
<output>No workflow status file found. Implementation Readiness check can run standalone or as part of BMM workflow path.</output>
<output>**Recommended:** Run `workflow-init` first for project context tracking and workflow sequencing.</output>
<ask>Continue in standalone mode or exit to run workflow-init? (continue/exit)</ask>
<check if="continue">
<action>Set standalone_mode = true</action>
</check>
<check if="exit">
<action>Exit workflow</action>
</check>
</check>
<check if="status file found">
<action>Load the FULL file: {workflow_status_file}</action>
<action>Parse workflow_status section</action>
<action>Check status of "implementation-readiness" workflow</action>
<action>Get {selected_track} (quick-flow, bmad-method, or enterprise-bmad-method)</action>
<action>Find first non-completed workflow (next expected workflow)</action>
<action>Based on the selected_track, understand what artifacts should exist: - quick-flow: Tech spec and simple stories in an epic only (no PRD, minimal solutioning) - bmad-method and enterprise-bmad-method: PRD, UX design, epics/stories, architecture</action>
<check if="implementation-readiness status is file path (already completed)">
<output>⚠️ Implementation readiness check already completed: {{implementation-readiness status}}</output>
<ask>Re-running will create a new validation report. Continue? (y/n)</ask>
<check if="n">
<output>Exiting. Use workflow-status to see your next step.</output>
<action>Exit workflow</action>
</check>
</check>
<check if="implementation-readiness is not the next expected workflow">
<output>⚠️ Next expected workflow: {{next_workflow}}. Implementation readiness check is out of sequence.</output>
<ask>Continue with readiness check anyway? (y/n)</ask>
<check if="n">
<output>Exiting. Run {{next_workflow}} instead.</output>
<action>Exit workflow</action>
</check>
</check>
<action>Set standalone_mode = false</action>
</check>
<template-output>project_context</template-output>
</step>
<step n="0.5" goal="Discover and load input documents">
<invoke-protocol name="discover_inputs" />
<note>After discovery, these content variables are available: {prd_content}, {epics_content}, {architecture_content}, {ux_design_content}, {tech_spec_content}, {document_project_content}</note>
</step>
<step n="1" goal="Inventory loaded project artifacts">
<action>Review the content loaded by Step 0.5 and create an inventory</action>
<action>Inventory of available documents:
- PRD: {prd_content} (loaded if available)
- Architecture: {architecture_content} (loaded if available)
- Epics: {epics_content} (loaded if available)
- UX Design: {ux_design_content} (loaded if available)
- Tech Spec: {tech_spec_content} (loaded if available, Quick Flow track)
- Brownfield docs: {document_project_content} (loaded via INDEX_GUIDED if available)
</action>
<action>For each loaded document, extract:
- Document type and purpose
- Brief description of what it contains
- Flag any expected documents that are missing as potential issues
</action>
<template-output>document_inventory</template-output>
</step>
<step n="2" goal="Deep analysis of core planning documents">
<action>Thoroughly analyze each loaded document to extract:
- Core requirements and success criteria
- Architectural decisions and constraints
- Technical implementation approaches
- User stories and acceptance criteria
- Dependencies and sequencing requirements
- Any assumptions or risks documented
</action>
<action>For PRD analysis, focus on:
- User requirements and use cases
- Functional and non-functional requirements
- Success metrics and acceptance criteria
- Scope boundaries and explicitly excluded items
- Priority levels for different features
</action>
<action>For Architecture/Tech Spec analysis, focus on:
- System design decisions and rationale
- Technology stack and framework choices
- Integration points and APIs
- Data models and storage decisions
- Security and performance considerations
- Any architectural constraints that might affect story implementation
</action>
<action>For Epic/Story analysis, focus on:
- Coverage of PRD requirements
- Story sequencing and dependencies
- Acceptance criteria completeness
- Technical tasks within stories
- Estimated complexity and effort indicators
</action>
<template-output>document_analysis</template-output>
</step>
<step n="3" goal="Cross-reference validation and alignment check">
<action>PRD ↔ Architecture Alignment:
- Verify every PRD requirement has corresponding architectural support
- Check that architectural decisions don't contradict PRD constraints
- Identify any architectural additions beyond PRD scope (potential gold-plating)
- Ensure non-functional requirements from PRD are addressed in architecture document
- If using new architecture workflow: verify implementation patterns are defined
</action>
<action>PRD ↔ Stories Coverage:
- Map each PRD requirement to implementing stories
- Identify any PRD requirements without story coverage
- Find stories that don't trace back to PRD requirements
- Validate that story acceptance criteria align with PRD success criteria
</action>
<action>Architecture ↔ Stories Implementation Check:
- Verify architectural decisions are reflected in relevant stories
- Check that story technical tasks align with architectural approach
- Identify any stories that might violate architectural constraints
- Ensure infrastructure and setup stories exist for architectural components
</action>
<template-output>alignment_validation</template-output>
</step>
<step n="4" goal="Gap and risk analysis">
<action>Identify and categorize all gaps, risks, and potential issues discovered during validation</action>
<action>Check for Critical Gaps:
- Missing stories for core requirements
- Unaddressed architectural concerns
- Absent infrastructure or setup stories for greenfield projects
- Missing error handling or edge case coverage
- Security or compliance requirements not addressed
</action>
<action>Identify Sequencing Issues:
- Dependencies not properly ordered
- Stories that assume components not yet built
- Parallel work that should be sequential
- Missing prerequisite technical tasks
</action>
<action>Detect Potential Contradictions:
- Conflicts between PRD and architecture approaches
- Stories with conflicting technical approaches
- Acceptance criteria that contradict requirements
- Resource or technology conflicts
</action>
<action>Find Gold-Plating and Scope Creep:
- Features in architecture not required by PRD
- Stories implementing beyond requirements
- Technical complexity beyond project needs
- Over-engineering indicators
</action>
<action>Check Testability Review (if test-design exists in Phase 3):
**Note:** test-design is recommended for BMad Method, required for Enterprise Method
- Check if {output_folder}/test-design-system.md exists
- If exists: Review testability assessment (Controllability, Observability, Reliability)
- If testability concerns documented: Flag for gate decision
- If missing AND track is Enterprise: Flag as CRITICAL gap
- If missing AND track is Method: Note as recommendation (not blocker)
</action>
<template-output>gap_risk_analysis</template-output>
</step>
<step n="5" goal="UX and special concerns validation" optional="true">
<check if="UX artifacts exist or UX workflow in active path">
<action>Review UX artifacts and validate integration:
- Check that UX requirements are reflected in PRD
- Verify stories include UX implementation tasks
- Ensure architecture supports UX requirements (performance, responsiveness)
- Identify any UX concerns not addressed in stories
</action>
<action>Validate accessibility and usability coverage:
- Check for accessibility requirement coverage in stories
- Verify responsive design considerations if applicable
- Ensure user flow completeness across stories
</action>
</check>
<template-output>ux_validation</template-output>
</step>
<step n="6" goal="Generate comprehensive readiness assessment">
<action>Compile all findings into a structured readiness report with:
- Executive summary of readiness status
- Project context and validation scope
- Document inventory and coverage assessment
- Detailed findings organized by severity (Critical, High, Medium, Low)
- Specific recommendations for each issue
- Overall readiness recommendation (Ready, Ready with Conditions, Not Ready)
</action>
<action>Provide actionable next steps:
- List any critical issues that must be resolved
- Suggest specific document updates needed
- Recommend additional stories or tasks required
- Propose sequencing adjustments if needed
</action>
<action>Include positive findings:
- Highlight well-aligned areas
- Note particularly thorough documentation
- Recognize good architectural decisions
- Commend comprehensive story coverage where found
</action>
<template-output>readiness_assessment</template-output>
</step>
<step n="7" goal="Update status and complete" tag="workflow-status">
<check if="standalone_mode != true">
<action>Load the FULL file: {workflow_status_file}</action>
<action>Find workflow_status key "implementation-readiness"</action>
<critical>ONLY write the file path as the status value - no other text, notes, or metadata</critical>
<action>Update workflow_status["implementation-readiness"] = "{output_folder}/implementation-readiness-report-{{date}}.md"</action>
<action>Save file, preserving ALL comments and structure including STATUS DEFINITIONS</action>
<action>Find first non-completed workflow in workflow_status (next workflow to do)</action>
<action>Determine next agent from path file based on next workflow</action>
</check>
<action>Determine overall readiness status from the readiness_assessment (Ready, Ready with Conditions, or Not Ready)</action>
<output>**✅ Implementation Readiness Check Complete!**
**Assessment Report:**
- Readiness assessment saved to: {output_folder}/implementation-readiness-report-{{date}}.md
{{#if standalone_mode != true}}
**Status Updated:**
- Progress tracking updated: implementation-readiness marked complete
- Next workflow: {{next_workflow}}
{{else}}
**Note:** Running in standalone mode (no progress tracking)
{{/if}}
**Next Steps:**
{{#if standalone_mode != true}}
- **Next workflow:** {{next_workflow}} ({{next_agent}} agent)
- Review the assessment report and address any critical issues before proceeding
Check status anytime with: `workflow-status`
{{else}}
Since no workflow is in progress:
- Refer to the BMM workflow guide if unsure what to do next
- Or run `workflow-init` to create a workflow path and get guided next steps
{{/if}}
</output>
<check if="overall readiness status is Ready OR Ready with Conditions">
<output>**🚀 Ready for Implementation!**
Your project artifacts are aligned and complete. You can now proceed to Phase 4: Implementation.
</output>
<ask>Would you like to run the **sprint-planning** workflow to initialize your sprint tracking and prepare for development? (yes/no)</ask>
<check if="yes">
<action>Inform user that sprint-planning workflow will be invoked</action>
<invoke-workflow path="{project-root}/{bmad_folder}/bmm/workflows/4-implementation/sprint-planning/workflow.yaml" />
</check>
<check if="no">
<output>You can run sprint-planning later when ready: `sprint-planning`</output>
</check>
</check>
<check if="overall readiness status is Not Ready">
<output>**⚠️ Not Ready for Implementation**
Critical issues must be resolved before proceeding. Review the assessment report and address the identified gaps.
Once issues are resolved, re-run implementation-readiness to validate again.
</output>
</check>
<template-output>status_update_result</template-output>
</step>
</workflow>

189
src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-01-document-discovery.md Normal file
View File

@ -0,0 +1,189 @@
---
name: 'step-01-document-discovery'
description: 'Discover and inventory all project documents, handling duplicates and organizing file structure'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/implementation-readiness'
# File References
thisStepFile: '{workflow_path}/steps/step-01-document-discovery.md'
nextStepFile: '{workflow_path}/steps/step-02-prd-analysis.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/implementation-readiness-report-{{date}}.md'
templateFile: '{workflow_path}/templates/readiness-report-template.md'
---
# Step 1: Document Discovery
## STEP GOAL:
To discover, inventory, and organize all project documents, identifying duplicates and determining which versions to use for the assessment.
## 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 an expert Product Manager and Scrum Master
- ✅ Your focus is on finding organizing and documenting what exists
- ✅ You identify ambiguities and ask for clarification
- ✅ Success is measured in clear file inventory and conflict resolution
### Step-Specific Rules:
- 🎯 Focus ONLY on finding and organizing files
- 🚫 Don't read or analyze file contents
- 💬 Identify duplicate documents clearly
- 🚪 Get user confirmation on file selections
## EXECUTION PROTOCOLS:
- 🎯 Search for all document types systematically
- 💾 Group sharded files together
- 📖 Flag duplicates for user resolution
- 🚫 FORBIDDEN to proceed with unresolved duplicates
## DOCUMENT DISCOVERY PROCESS:
### 1. Initialize Document Discovery
"Beginning **Document Discovery** to inventory all project files.
I will:
1. Search for all required documents (PRD, Architecture, Epics, UX)
2. Group sharded documents together
3. Identify any duplicates (whole + sharded versions)
4. Present findings for your confirmation"
### 2. Document Search Patterns
Search for each document type using these patterns:
#### A. PRD Documents
- Whole: `{output_folder}/*prd*.md`
- Sharded: `{output_folder}/*prd*/index.md` and related files
#### B. Architecture Documents
- Whole: `{output_folder}/*architecture*.md`
- Sharded: `{output_folder}/*architecture*/index.md` and related files
#### C. Epics & Stories Documents
- Whole: `{output_folder}/*epic*.md`
- Sharded: `{output_folder}/*epic*/index.md` and related files
#### D. UX Design Documents
- Whole: `{output_folder}/*ux*.md`
- Sharded: `{output_folder}/*ux*/index.md` and related files
### 3. Organize Findings
For each document type found:
```
## [Document Type] Files Found
**Whole Documents:**
- [filename.md] ([size], [modified date])
**Sharded Documents:**
- Folder: [foldername]/
- index.md
- [other files in folder]
```
### 4. Identify Critical Issues
#### Duplicates (CRITICAL)
If both whole and sharded versions exist:
```
⚠️ CRITICAL ISSUE: Duplicate document formats found
- PRD exists as both whole.md AND prd/ folder
- YOU MUST choose which version to use
- Remove or rename the other version to avoid confusion
```
#### Missing Documents (WARNING)
If required documents not found:
```
⚠️ WARNING: Required document not found
- Architecture document not found
- Will impact assessment completeness
```
### 5. Add Initial Report Section
Initialize {outputFile} with {templateFile}.
### 6. Present Findings and Get Confirmation
Display findings and ask:
"**Document Discovery Complete**
[Show organized file list]
**Issues Found:**
- [List any duplicates requiring resolution]
- [List any missing documents]
**Required Actions:**
- If duplicates exist: Please remove/rename one version
- Confirm which documents to use for assessment
**Ready to proceed?** [C] Continue after resolving issues"
### 7. Present MENU OPTIONS
Display: **Select an Option:** [C] Continue to File Validation
#### EXECUTION RULES:
- ALWAYS halt and wait for user input after presenting menu
- ONLY proceed with 'C' selection
- If duplicates identified, insist on resolution first
- User can clarify file locations or request additional searches
#### Menu Handling Logic:
- IF C: Save document inventory to {outputFile}, update frontmatter with completed step and files being included, and only then load read fully and execute {nextStepFile}
- IF Any other comments or queries: help user respond then redisplay menu
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and document inventory is saved will you load {nextStepFile} to begin file validation.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- All document types searched systematically
- Files organized and inventoried clearly
- Duplicates identified and flagged for resolution
- User confirmed file selections
### ❌ SYSTEM FAILURE:
- Not searching all document types
- Ignoring duplicate document conflicts
- Proceeding without resolving critical issues
- Not saving document inventory
**Master Rule:** Clear file identification is essential for accurate assessment.

177
src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-02-prd-analysis.md Normal file
View File

@ -0,0 +1,177 @@
---
name: 'step-02-prd-analysis'
description: 'Read and analyze PRD to extract all FRs and NFRs for coverage validation'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/implementation-readiness'
# File References
thisStepFile: '{workflow_path}/steps/step-02-prd-analysis.md'
nextStepFile: '{workflow_path}/steps/step-03-epic-coverage-validation.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/implementation-readiness-report-{{date}}.md'
epicsFile: '{output_folder}/*epic*.md' # Will be resolved to actual file
---
# Step 2: PRD Analysis
## STEP GOAL:
To fully read and analyze the PRD document (whole or sharded) to extract all Functional Requirements (FRs) and Non-Functional Requirements (NFRs) for validation against epics coverage.
## 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 an expert Product Manager and Scrum Master
- ✅ Your expertise is in requirements analysis and traceability
- ✅ You think critically about requirement completeness
- ✅ Success is measured in thorough requirement extraction
### Step-Specific Rules:
- 🎯 Focus ONLY on reading and extracting from PRD
- 🚫 Don't validate files (done in step 1)
- 💬 Read PRD completely - whole or all sharded files
- 🚪 Extract every FR and NFR with numbering
## EXECUTION PROTOCOLS:
- 🎯 Load and completely read the PRD
- 💾 Extract all requirements systematically
- 📖 Document findings in the report
- 🚫 FORBIDDEN to skip or summarize PRD content
## PRD ANALYSIS PROCESS:
### 1. Initialize PRD Analysis
"Beginning **PRD Analysis** to extract all requirements.
I will:
1. Load the PRD document (whole or sharded)
2. Read it completely and thoroughly
3. Extract ALL Functional Requirements (FRs)
4. Extract ALL Non-Functional Requirements (NFRs)
5. Document findings for coverage validation"
### 2. Load and Read PRD
From the document inventory in step 1:
- If whole PRD file exists: Load and read it completely
- If sharded PRD exists: Load and read ALL files in the PRD folder
- Ensure complete coverage - no files skipped
### 3. Extract Functional Requirements (FRs)
Search for and extract:
- Numbered FRs (FR1, FR2, FR3, etc.)
- Requirements labeled "Functional Requirement"
- User stories or use cases that represent functional needs
- Business rules that must be implemented
Format findings as:
```
## Functional Requirements Extracted
FR1: [Complete requirement text]
FR2: [Complete requirement text]
FR3: [Complete requirement text]
...
Total FRs: [count]
```
### 4. Extract Non-Functional Requirements (NFRs)
Search for and extract:
- Performance requirements (response times, throughput)
- Security requirements (authentication, encryption, etc.)
- Usability requirements (accessibility, ease of use)
- Reliability requirements (uptime, error rates)
- Scalability requirements (concurrent users, data growth)
- Compliance requirements (standards, regulations)
Format findings as:
```
## Non-Functional Requirements Extracted
NFR1: [Performance requirement]
NFR2: [Security requirement]
NFR3: [Usability requirement]
...
Total NFRs: [count]
```
### 5. Document Additional Requirements
Look for:
- Constraints or assumptions
- Technical requirements not labeled as FR/NFR
- Business constraints
- Integration requirements
### 6. Add to Assessment Report
Append to {outputFile}:
```markdown
## PRD Analysis
### Functional Requirements
[Complete FR list from section 3]
### Non-Functional Requirements
[Complete NFR list from section 4]
### Additional Requirements
[Any other requirements or constraints found]
### PRD Completeness Assessment
[Initial assessment of PRD completeness and clarity]
```
### 7. Auto-Proceed to Next Step
After PRD analysis complete, immediately load next step for epic coverage validation.
## PROCEEDING TO EPIC COVERAGE VALIDATION
PRD analysis complete. Loading next step to validate epic coverage.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- PRD loaded and read completely
- All FRs extracted with full text
- All NFRs identified and documented
- Findings added to assessment report
### ❌ SYSTEM FAILURE:
- Not reading complete PRD (especially sharded versions)
- Missing requirements in extraction
- Summarizing instead of extracting full text
- Not documenting findings in report
**Master Rule:** Complete requirement extraction is essential for traceability validation.

178
src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-03-epic-coverage-validation.md Normal file
View File

@ -0,0 +1,178 @@
---
name: 'step-03-epic-coverage-validation'
description: 'Validate that all PRD FRs are covered in epics and stories'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/implementation-readiness'
# File References
thisStepFile: '{workflow_path}/steps/step-03-epic-coverage-validation.md'
nextStepFile: '{workflow_path}/steps/step-04-ux-alignment.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/implementation-readiness-report-{{date}}.md'
---
# Step 3: Epic Coverage Validation
## STEP GOAL:
To validate that all Functional Requirements from the PRD are captured in the epics and stories document, identifying any gaps in coverage.
## 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 an expert Product Manager and Scrum Master
- ✅ Your expertise is in requirements traceability
- ✅ You ensure no requirements fall through the cracks
- ✅ Success is measured in complete FR coverage
### Step-Specific Rules:
- 🎯 Focus ONLY on FR coverage validation
- 🚫 Don't analyze story quality (that's later)
- 💬 Compare PRD FRs against epic coverage list
- 🚪 Document every missing FR
## EXECUTION PROTOCOLS:
- 🎯 Load epics document completely
- 💾 Extract FR coverage from epics
- 📖 Compare against PRD FR list
- 🚫 FORBIDDEN to proceed without documenting gaps
## EPIC COVERAGE VALIDATION PROCESS:
### 1. Initialize Coverage Validation
"Beginning **Epic Coverage Validation**.
I will:
1. Load the epics and stories document
2. Extract FR coverage information
3. Compare against PRD FRs from previous step
4. Identify any FRs not covered in epics"
### 2. Load Epics Document
From the document inventory in step 1:
- Load the epics and stories document (whole or sharded)
- Read it completely to find FR coverage information
- Look for sections like "FR Coverage Map" or similar
### 3. Extract Epic FR Coverage
From the epics document:
- Find FR coverage mapping or list
- Extract which FR numbers are claimed to be covered
- Document which epics cover which FRs
Format as:
```
## Epic FR Coverage Extracted
FR1: Covered in Epic X
FR2: Covered in Epic Y
FR3: Covered in Epic Z
...
Total FRs in epics: [count]
```
### 4. Compare Coverage Against PRD
Using the PRD FR list from step 2:
- Check each PRD FR against epic coverage
- Identify FRs NOT covered in epics
- Note any FRs in epics but NOT in PRD
Create coverage matrix:
```
## FR Coverage Analysis
| FR Number | PRD Requirement | Epic Coverage | Status |
|-----------|----------------|---------------|---------|
| FR1 | [PRD text] | Epic X Story Y | ✓ Covered |
| FR2 | [PRD text] | **NOT FOUND** | ❌ MISSING |
| FR3 | [PRD text] | Epic Z Story A | ✓ Covered |
```
### 5. Document Missing Coverage
List all FRs not covered:
```
## Missing FR Coverage
### Critical Missing FRs
FR#: [Full requirement text from PRD]
- Impact: [Why this is critical]
- Recommendation: [Which epic should include this]
### High Priority Missing FRs
[List any other uncovered FRs]
```
### 6. Add to Assessment Report
Append to {outputFile}:
```markdown
## Epic Coverage Validation
### Coverage Matrix
[Complete coverage matrix from section 4]
### Missing Requirements
[List of uncovered FRs from section 5]
### Coverage Statistics
- Total PRD FRs: [count]
- FRs covered in epics: [count]
- Coverage percentage: [percentage]
```
### 7. Auto-Proceed to Next Step
After coverage validation complete, immediately load next step.
## PROCEEDING TO UX ALIGNMENT
Epic coverage validation complete. Loading next step for UX alignment.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- Epics document loaded completely
- FR coverage extracted accurately
- All gaps identified and documented
- Coverage matrix created
### ❌ SYSTEM FAILURE:
- Not reading complete epics document
- Missing FRs in comparison
- Not documenting uncovered requirements
- Incomplete coverage analysis
**Master Rule:** Every FR must have a traceable implementation path.

138
src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-04-ux-alignment.md Normal file
View File

@ -0,0 +1,138 @@
---
name: 'step-04-ux-alignment'
description: 'Check for UX document and validate alignment with PRD and Architecture'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/implementation-readiness'
# File References
thisStepFile: '{workflow_path}/steps/step-04-ux-alignment.md'
nextStepFile: '{workflow_path}/steps/step-05-epic-quality-review.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/implementation-readiness-report-{{date}}.md'
---
# Step 4: UX Alignment
## STEP GOAL:
To check if UX documentation exists and validate that it aligns with PRD requirements and Architecture decisions, ensuring architecture accounts for both PRD and UX needs.
## 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 UX VALIDATOR ensuring user experience is properly addressed
- ✅ UX requirements must be supported by architecture
- ✅ Missing UX documentation is a warning if UI is implied
- ✅ Alignment gaps must be documented
### Step-Specific Rules:
- 🎯 Check for UX document existence first
- 🚫 Don't assume UX is not needed
- 💬 Validate alignment between UX, PRD, and Architecture
- 🚪 Add findings to the output report
## EXECUTION PROTOCOLS:
- 🎯 Search for UX documentation
- 💾 If found, validate alignment
- 📖 If not found, assess if UX is implied
- 🚫 FORBIDDEN to proceed without completing assessment
## UX ALIGNMENT PROCESS:
### 1. Initialize UX Validation
"Beginning **UX Alignment** validation.
I will:
1. Check if UX documentation exists
2. If UX exists: validate alignment with PRD and Architecture
3. If no UX: determine if UX is implied and document warning"
### 2. Search for UX Documentation
Search patterns:
- `{output_folder}/*ux*.md` (whole document)
- `{output_folder}/*ux*/index.md` (sharded)
- Look for UI-related terms in other documents
### 3. If UX Document Exists
#### A. UX ↔ PRD Alignment
- Check UX requirements reflected in PRD
- Verify user journeys in UX match PRD use cases
- Identify UX requirements not in PRD
#### B. UX ↔ Architecture Alignment
- Verify architecture supports UX requirements
- Check performance needs (responsiveness, load times)
- Identify UI components not supported by architecture
### 4. If No UX Document
Assess if UX/UI is implied:
- Does PRD mention user interface?
- Are there web/mobile components implied?
- Is this a user-facing application?
If UX implied but missing: Add warning to report
### 5. Add Findings to Report
Append to {outputFile}:
```markdown
## UX Alignment Assessment
### UX Document Status
[Found/Not Found]
### Alignment Issues
[List any misalignments between UX, PRD, and Architecture]
### Warnings
[Any warnings about missing UX or architectural gaps]
```
### 6. Auto-Proceed to Next Step
After UX assessment complete, immediately load next step.
## PROCEEDING TO EPIC QUALITY REVIEW
UX alignment assessment complete. Loading next step for epic quality review.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- UX document existence checked
- Alignment validated if UX exists
- Warning issued if UX implied but missing
- Findings added to report
### ❌ SYSTEM FAILURE:
- Not checking for UX document
- Ignoring alignment issues
- Not documenting warnings

251
src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-05-epic-quality-review.md Normal file
View File

@ -0,0 +1,251 @@
---
name: 'step-05-epic-quality-review'
description: 'Validate epics and stories against create-epics-and-stories best practices'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/implementation-readiness'
# File References
thisStepFile: '{workflow_path}/steps/step-05-epic-quality-review.md'
nextStepFile: '{workflow_path}/steps/step-06-final-assessment.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/implementation-readiness-report-{{date}}.md'
epicsBestPractices: '{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/create-epics-and-stories'
---
# Step 5: Epic Quality Review
## STEP GOAL:
To validate epics and stories against the best practices defined in create-epics-and-stories workflow, focusing on user value, independence, dependencies, and implementation readiness.
## 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 an EPIC QUALITY ENFORCER
- ✅ You know what good epics look like - challenge anything deviating
- ✅ Technical epics are wrong - find them
- ✅ Forward dependencies are forbidden - catch them
- ✅ Stories must be independently completable
### Step-Specific Rules:
- 🎯 Apply create-epics-and-stories standards rigorously
- 🚫 Don't accept "technical milestones" as epics
- 💬 Challenge every dependency on future work
- 🚪 Verify proper story sizing and structure
## EXECUTION PROTOCOLS:
- 🎯 Systematically validate each epic and story
- 💾 Document all violations of best practices
- 📖 Check every dependency relationship
- 🚫 FORBIDDEN to accept structural problems
## EPIC QUALITY REVIEW PROCESS:
### 1. Initialize Best Practices Validation
"Beginning **Epic Quality Review** against create-epics-and-stories standards.
I will rigorously validate:
- Epics deliver user value (not technical milestones)
- Epic independence (Epic 2 doesn't need Epic 3)
- Story dependencies (no forward references)
- Proper story sizing and completeness
Any deviation from best practices will be flagged as a defect."
### 2. Epic Structure Validation
#### A. User Value Focus Check
For each epic:
- **Epic Title:** Is it user-centric (what user can do)?
- **Epic Goal:** Does it describe user outcome?
- **Value Proposition:** Can users benefit from this epic alone?
**Red flags (violations):**
- "Setup Database" or "Create Models" - no user value
- "API Development" - technical milestone
- "Infrastructure Setup" - not user-facing
- "Authentication System" - borderline (is it user value?)
#### B. Epic Independence Validation
Test epic independence:
- **Epic 1:** Must stand alone completely
- **Epic 2:** Can function using only Epic 1 output
- **Epic 3:** Can function using Epic 1 & 2 outputs
- **Rule:** Epic N cannot require Epic N+1 to work
**Document failures:**
- "Epic 2 requires Epic 3 features to function"
- Stories in Epic 2 referencing Epic 3 components
- Circular dependencies between epics
### 3. Story Quality Assessment
#### A. Story Sizing Validation
Check each story:
- **Clear User Value:** Does the story deliver something meaningful?
- **Independent:** Can it be completed without future stories?
**Common violations:**
- "Setup all models" - not a USER story
- "Create login UI (depends on Story 1.3)" - forward dependency
#### B. Acceptance Criteria Review
For each story's ACs:
- **Given/When/Then Format:** Proper BDD structure?
- **Testable:** Each AC can be verified independently?
- **Complete:** Covers all scenarios including errors?
- **Specific:** Clear expected outcomes?
**Issues to find:**
- Vague criteria like "user can login"
- Missing error conditions
- Incomplete happy path
- Non-measurable outcomes
### 4. Dependency Analysis
#### A. Within-Epic Dependencies
Map story dependencies within each epic:
- Story 1.1 must be completable alone
- Story 1.2 can use Story 1.1 output
- Story 1.3 can use Story 1.1 & 1.2 outputs
**Critical violations:**
- "This story depends on Story 1.4"
- "Wait for future story to work"
- Stories referencing features not yet implemented
#### B. Database/Entity Creation Timing
Validate database creation approach:
- **Wrong:** Epic 1 Story 1 creates all tables upfront
- **Right:** Each story creates tables it needs
- **Check:** Are tables created only when first needed?
### 5. Special Implementation Checks
#### A. Starter Template Requirement
Check if Architecture specifies starter template:
- If YES: Epic 1 Story 1 must be "Set up initial project from starter template"
- Verify story includes cloning, dependencies, initial configuration
#### B. Greenfield vs Brownfield Indicators
Greenfield projects should have:
- Initial project setup story
- Development environment configuration
- CI/CD pipeline setup early
Brownfield projects should have:
- Integration points with existing systems
- Migration or compatibility stories
### 6. Best Practices Compliance Checklist
For each epic, verify:
- [ ] Epic delivers user value
- [ ] Epic can function independently
- [ ] Stories appropriately sized
- [ ] No forward dependencies
- [ ] Database tables created when needed
- [ ] Clear acceptance criteria
- [ ] Traceability to FRs maintained
### 7. Quality Assessment Documentation
Document all findings by severity:
#### 🔴 Critical Violations
- Technical epics with no user value
- Forward dependencies breaking independence
- Epic-sized stories that cannot be completed
#### 🟠 Major Issues
- Vague acceptance criteria
- Stories requiring future stories
- Database creation violations
#### 🟡 Minor Concerns
- Formatting inconsistencies
- Minor structure deviations
- Documentation gaps
### 8. Autonomous Review Execution
This review runs autonomously to maintain standards:
- Apply best practices without compromise
- Document every violation with specific examples
- Provide clear remediation guidance
- Prepare recommendations for each issue
## REVIEW COMPLETION:
After completing epic quality review:
- Update {outputFile} with all quality findings
- Document specific best practices violations
- Provide actionable recommendations
- Load {nextStepFile} for final readiness assessment
## CRITICAL STEP COMPLETION NOTE
This step executes autonomously. Load {nextStepFile} only after complete epic quality review is documented.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- All epics validated against best practices
- Every dependency checked and verified
- Quality violations documented with examples
- Clear remediation guidance provided
- No compromise on standards enforcement
### ❌ SYSTEM FAILURE:
- Accepting technical epics as valid
- Ignoring forward dependencies
- Not verifying story sizing
- Overlooking obvious violations
**Master Rule:** Enforce best practices rigorously. Find all violations.

132
src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-06-final-assessment.md Normal file
View File

@ -0,0 +1,132 @@
---
name: 'step-06-final-assessment'
description: 'Compile final assessment and polish the readiness report'
# Path Definitions
workflow_path: '{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/implementation-readiness'
# File References
thisStepFile: '{workflow_path}/steps/step-06-final-assessment.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/implementation-readiness-report-{{date}}.md'
---
# Step 6: Final Assessment
## STEP GOAL:
To provide a comprehensive summary of all findings and give the report a final polish, ensuring clear recommendations and overall readiness status.
## MANDATORY EXECUTION RULES (READ FIRST):
### Universal Rules:
- 🛑 NEVER generate content without user input
- 📖 CRITICAL: Read the complete step file before taking any action
- 📖 You are at the final step - complete the assessment
- 📋 YOU ARE A FACILITATOR, not a content generator
### Role Reinforcement:
- ✅ You are delivering the FINAL ASSESSMENT
- ✅ Your findings are objective and backed by evidence
- ✅ Provide clear, actionable recommendations
- ✅ Success is measured by value of findings
### Step-Specific Rules:
- 🎯 Compile and summarize all findings
- 🚫 Don't soften the message - be direct
- 💬 Provide specific examples for problems
- 🚪 Add final section to the report
## EXECUTION PROTOCOLS:
- 🎯 Review all findings from previous steps
- 💾 Add summary and recommendations
- 📖 Determine overall readiness status
- 🚫 Complete and present final report
## FINAL ASSESSMENT PROCESS:
### 1. Initialize Final Assessment
"Completing **Final Assessment**.
I will now:
1. Review all findings from previous steps
2. Provide a comprehensive summary
3. Add specific recommendations
4. Determine overall readiness status"
### 2. Review Previous Findings
Check the {outputFile} for sections added by previous steps:
- File and FR Validation findings
- UX Alignment issues
- Epic Quality violations
### 3. Add Final Assessment Section
Append to {outputFile}:
```markdown
## Summary and Recommendations
### Overall Readiness Status
[READY/NEEDS WORK/NOT READY]
### Critical Issues Requiring Immediate Action
[List most critical issues that must be addressed]
### Recommended Next Steps
1. [Specific action item 1]
2. [Specific action item 2]
3. [Specific action item 3]
### Final Note
This assessment identified [X] issues across [Y] categories. Address the critical issues before proceeding to implementation. These findings can be used to improve the artifacts or you may choose to proceed as-is.
```
### 4. Complete the Report
- Ensure all findings are clearly documented
- Verify recommendations are actionable
- Add date and assessor information
- Save the final report
### 5. Present Completion
Display:
"**Implementation Readiness Assessment Complete**
Report generated: {outputFile}
The assessment found [number] issues requiring attention. Review the detailed report for specific findings and recommendations."
## WORKFLOW COMPLETE
The implementation readiness workflow is now complete. The report contains all findings and recommendations for the user to consider.
---
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS:
- All findings compiled and summarized
- Clear recommendations provided
- Readiness status determined
- Final report saved
### ❌ SYSTEM FAILURE:
- Not reviewing previous findings
- Incomplete summary
- No clear recommendations

146
src/modules/bmm/workflows/3-solutioning/implementation-readiness/template.md
View File

@ -1,146 +0,0 @@
# Implementation Readiness Assessment Report
**Date:** {{date}}
**Project:** {{project_name}}
**Assessed By:** {{user_name}}
**Assessment Type:** Phase 3 to Phase 4 Transition Validation
---
## Executive Summary
{{readiness_assessment}}
---
## Project Context
{{project_context}}
---
## Document Inventory
### Documents Reviewed
{{document_inventory}}
### Document Analysis Summary
{{document_analysis}}
---
## Alignment Validation Results
### Cross-Reference Analysis
{{alignment_validation}}
---
## Gap and Risk Analysis
### Critical Findings
{{gap_risk_analysis}}
---
## UX and Special Concerns
{{ux_validation}}
---
## Detailed Findings
### 🔴 Critical Issues
_Must be resolved before proceeding to implementation_
{{critical_issues}}
### 🟠 High Priority Concerns
_Should be addressed to reduce implementation risk_
{{high_priority_concerns}}
### 🟡 Medium Priority Observations
_Consider addressing for smoother implementation_
{{medium_priority_observations}}
### 🟢 Low Priority Notes
_Minor items for consideration_
{{low_priority_notes}}
---
## Positive Findings
### ✅ Well-Executed Areas
{{positive_findings}}
---
## Recommendations
### Immediate Actions Required
{{immediate_actions}}
### Suggested Improvements
{{suggested_improvements}}
### Sequencing Adjustments
{{sequencing_adjustments}}
---
## Readiness Decision
### Overall Assessment: {{overall_readiness_status}}
{{readiness_rationale}}
### Conditions for Proceeding (if applicable)
{{conditions_for_proceeding}}
---
## Next Steps
{{recommended_next_steps}}
### Workflow Status Update
{{status_update_result}}
---
## Appendices
### A. Validation Criteria Applied
{{validation_criteria_used}}
### B. Traceability Matrix
{{traceability_matrix}}
### C. Risk Mitigation Strategies
{{risk_mitigation_strategies}}
---
_This readiness assessment was generated using the BMad Method Implementation Readiness workflow (v6-alpha)_

4
src/modules/bmm/workflows/3-solutioning/implementation-readiness/templates/readiness-report-template.md Normal file
View File

@ -0,0 +1,4 @@
# Implementation Readiness Assessment Report
**Date:** {{date}}
**Project:** {{project_name}}

54
src/modules/bmm/workflows/3-solutioning/implementation-readiness/workflow.md Normal file
View File

@ -0,0 +1,54 @@
---
name: 'Implementation Readiness'
description: 'Critical validation workflow that assesses PRD, Architecture, and Epics & Stories for completeness and alignment before implementation. Uses adversarial review approach to find gaps and issues.'
web_bundle: false
---
# Implementation Readiness
**Goal:** Validate that PRD, Architecture, Epics and Stories are complete and aligned before Phase 4 implementation starts, with a focus on ensuring epics and stories are logical and have accounted for all requirements and planning.
**Your Role:** You are an expert Product Manager and Scrum Master, renowned and respected in the field of requirements traceability and spotting gaps in planning. Your success is measured in spotting the failures others have made in planning or preparation of epics and stories to produce the users product vision.
## WORKFLOW ARCHITECTURE
### Core Principles
- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time
- **Just-In-Time Loading**: Only 1 current step file will be loaded, read, and executed to completion - never load future step files until told to do so
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
- **Append-Only Building**: Build documents by appending content as directed to the output file
### Step Processing Rules
1. **READ COMPLETELY**: Always read the entire step file before taking any action
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
### Critical Rules (NO EXCEPTIONS)
- 🛑 **NEVER** load multiple step files simultaneously
- 📖 **ALWAYS** read entire step file before execution
- 🚫 **NEVER** skip steps or optimize the sequence
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
- 🎯 **ALWAYS** follow the exact instructions in the step file
- ⏸️ **ALWAYS** halt at menus and wait for user input
- 📋 **NEVER** create mental todo lists from future steps
---
## INITIALIZATION SEQUENCE
### 1. Module Configuration Loading
Load and read full config from {project-root}/{bmad_folder}/bmm/config.yaml and resolve:
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`
### 2. First Step EXECUTION
Load, read the full file and then execute `{workflow_path}/steps/step-01-document-discovery.md` to begin the workflow.

Some files were not shown because too many files have changed in this diff Show More