workflow builder understands how to build continuable workflows

This commit is contained in:
Brian Madison 2025-12-01 21:51:00 -06:00
parent fe0817f590
commit 6365a63dff
49 changed files with 811 additions and 347 deletions

View File

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

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 - **[Workflow Index](./docs/workflows/index.md)** - Core workflow system overview
- **[Architecture Guide](./docs/workflows/architecture.md)** - Step-file design and JIT loading - **[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 - **[Intent vs Prescriptive](./docs/workflows/intent-vs-prescriptive-spectrum.md)** - Design philosophy
## Reference Materials ## Reference Materials

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.

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

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. 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]' name: 'step-[N]-[short-name]'
description: '[Brief description of what this step accomplishes]' description: '[Brief description of what this step accomplishes]'
# Path Definitions <!-- Path Definitions -->
workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/[workflow-name]'
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) # File References (all use {variable} format in file)
thisStepFile: '{workflow_path}/steps/step-[N]-[short-name].md' 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' workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/[output-file-name]-{project_name}.md' outputFile: '{output_folder}/[output-file-name]-{project_name}.md'
# Task References # 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' advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md' partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Template References (if this step uses templates) # Template References (if this step uses a specific templates)
profileTemplate: '{workflow_path}/templates/profile-section.md' profileTemplate: '{workflow_path}/templates/profile-section.md'
assessmentTemplate: '{workflow_path}/templates/assessment-section.md' assessmentTemplate: '{workflow_path}/templates/assessment-section.md'
strategyTemplate: '{workflow_path}/templates/strategy-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] # 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"] - ✅ 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 - ✅ 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 - ✅ 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 - ✅ Maintain collaborative [adjective] tone throughout
### Step-Specific Rules: ### 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] [Specific instructions for second part of the work]
#### Content to Append (if applicable): ### N. Title (as many as needed)
```markdown <!-- not ever step will include advanced elicitation or party mode, in which case generally will just have the C option -->
## [Section Title] <!-- 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 -->
[Content template or instructions for what to append]
```
### N. (Continue as needed)
### N. Present MENU OPTIONS ### N. Present MENU OPTIONS
@ -105,7 +110,7 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont
#### Menu Handling Logic: #### Menu Handling Logic:
- IF A: Execute {advancedElicitationTask} # Or custom action - 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 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) - 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 - ALWAYS halt and wait for user input after presenting menu
- ONLY proceed to next step when user selects 'C' - ONLY proceed to next step when user selects 'C'
- After other menu items execution, return to this menu - After other menu items execution completes, redisplay the menu
- User can chat or ask questions - always respond and then end with display again of the menu options - User can chat or ask questions - always respond when conversation ends, redisplay the menu
## CRITICAL STEP COMPLETION NOTE ## 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]. 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 ## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS: ### ✅ SUCCESS:
@ -140,15 +143,19 @@ ONLY WHEN [C continue option] is selected and [completion requirements], will yo
- [Step-specific failure mode 2] - [Step-specific failure mode 2]
- Proceeding without user input/selection - Proceeding without user input/selection
- Not updating required documents/frontmatter - 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. **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 ```markdown
### N. Present MENU OPTIONS ### 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 - 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 ```markdown
### N. Present MENU OPTIONS ### N. Present MENU OPTIONS
@ -196,8 +203,8 @@ Display: "**Select an Option:** [A] [Custom Action 1] [B] [Custom Action 2] [C]
#### Menu Handling Logic: #### Menu Handling Logic:
- IF A: [Custom handler for option A] - IF A: [Custom handler route for option A]
- IF B: [Custom handler for option B] - 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 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) - 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 ```markdown
### N. Present MENU OPTIONS ### 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: #### Menu Handling Logic:

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`

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.

View File

@ -157,7 +157,8 @@ Display: **Proceeding to user profile collection...**
### ✅ SUCCESS: ### ✅ SUCCESS:
- Document created from template - 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 - User welcomed to the process
- Ready to proceed to step 2 - 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 - Skipping welcome message
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. **Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
---

View File

@ -7,10 +7,7 @@ workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-n
# File References # File References
thisStepFile: '{workflow_path}/steps/step-01b-continue.md' thisStepFile: '{workflow_path}/steps/step-01b-continue.md'
workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/nutrition-plan-{project_name}.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 # 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: ### Step-Specific Rules:
- 🎯 Focus ONLY on analyzing and resuming workflow state - 🎯 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 - 💬 Maintain continuity with previous sessions
- 🚪 DETECT exact continuation point from frontmatter - 🚪 DETECT exact continuation point from frontmatter of incomplete file {outputFile}
## EXECUTION PROTOCOLS: ## EXECUTION PROTOCOLS:
@ -60,39 +57,19 @@ To resume the nutrition planning workflow from where it was left off, ensuring s
### 1. Analyze Current State ### 1. Analyze Current State
Review the frontmatter to understand: Review the frontmatter of {outputFile} to understand:
- `stepsCompleted`: Which steps are already done - `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.
- `lastStep`: The most recently completed step number
- `userProfile`: User information already collected
- `nutritionGoals`: Goals already established
- All other frontmatter variables
Examine the nutrition-plan.md template to understand: ### 2. Read the full step of every completed step
- What sections are already completed - read each step file that corresponds to the stepsCompleted > 1.
- What recommendations have been made
- Current progress through the plan
- Any notes or adjustments documented
### 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 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.
- 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]
```
### 4. Welcome Back Dialog ### 4. Welcome Back Dialog
@ -103,7 +80,6 @@ continuationDate: [current date]
- Briefly summarize progress made - Briefly summarize progress made
- Confirm any changes since last session - Confirm any changes since last session
- Validate that user is still aligned with goals - Validate that user is still aligned with goals
- Proceed to next appropriate step
### 6. Present MENU OPTIONS ### 6. Present MENU OPTIONS
@ -118,19 +94,13 @@ Display: **Resuming workflow - Select an Option:** [C] Continue
#### Menu Handling Logic: #### Menu Handling Logic:
- IF C: Update frontmatter with continuation info, then load, read entire file, then execute appropriate next step based on `lastStep` - IF C: follow the suggestion of the last completed step reviewed to continue as it suggested
- 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 Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options)
## CRITICAL STEP COMPLETION NOTE ## 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. 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 ## 🚨 SYSTEM SUCCESS/FAILURE METRICS
### ✅ SUCCESS: ### ✅ SUCCESS:

View File

@ -53,7 +53,7 @@ To gather comprehensive user profile information through collaborative conversat
- 🎯 Engage in natural conversation to gather profile information - 🎯 Engage in natural conversation to gather profile information
- 💾 After collecting all information, append to {outputFile} - 💾 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 - 🚫 FORBIDDEN to load next step until user selects 'C' and content is saved
## CONTEXT BOUNDARIES: ## CONTEXT BOUNDARIES:

View File

@ -57,6 +57,7 @@ To analyze nutritional requirements, identify restrictions, and calculate target
- 🎯 Use data from CSV files for comprehensive analysis - 🎯 Use data from CSV files for comprehensive analysis
- 💾 Calculate macros based on profile and goals - 💾 Calculate macros based on profile and goals
- 📖 Document all findings in nutrition-plan.md - 📖 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 - 🚫 FORBIDDEN to prescribe medical nutrition therapy
## CONTEXT BOUNDARIES: ## CONTEXT BOUNDARIES:

View File

@ -168,8 +168,8 @@ Display: **Select an Option:** [A] Meal Variety Optimization [P] Chef & Dietitia
- HALT and AWAIT ANSWER - HALT and AWAIT ANSWER
- IF A: Execute `{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml` - 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 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, check cooking frequency: - 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-05-shopping.md`
- IF cooking frequency ≤ 2x/week: load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.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) - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options)

View File

@ -159,7 +159,7 @@ Display: **Select an Option:** [A] Budget Optimization Strategies [P] Shopping P
- HALT and AWAIT ANSWER - HALT and AWAIT ANSWER
- IF A: Execute `{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml` - 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 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) - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options)
## CRITICAL STEP COMPLETION NOTE ## CRITICAL STEP COMPLETION NOTE

View File

@ -180,14 +180,14 @@ Display: **Select an Option:** [A] Advanced Prep Techniques [P] Coach Perspectiv
- HALT and AWAIT ANSWER - HALT and AWAIT ANSWER
- IF A: Execute `{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml` - 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 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) - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options)
## CRITICAL STEP COMPLETION NOTE ## CRITICAL STEP COMPLETION NOTE
ONLY WHEN C is selected and content is saved to document: 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 2. Display final completion message
3. End workflow session 3. End workflow session

View File

@ -49,9 +49,9 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading ### 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 ### 2. First Step EXECUTION

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
### 1. Configuration Loading ### 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` - `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 # Technical documentation for agent building
agent_compilation: "{project-root}/.bmad/bmb/docs/agents/agent-compilation.md" agent_compilation: "{project-root}/{bmad_folder}/bmb/docs/agents/agent-compilation.md"
understanding_agent_types: "{project-root}/.bmad/bmb/docs/agents/understanding-agent-types.md" understanding_agent_types: "{project-root}/{bmad_folder}/bmb/docs/agents/understanding-agent-types.md"
simple_agent_architecture: "{project-root}/.bmad/bmb/docs/agents/simple-agent-architecture.md" simple_agent_architecture: "{project-root}/{bmad_folder}/bmb/docs/agents/simple-agent-architecture.md"
expert_agent_architecture: "{project-root}/.bmad/bmb/docs/agents/expert-agent-architecture.md" expert_agent_architecture: "{project-root}/{bmad_folder}/bmb/docs/agents/expert-agent-architecture.md"
module_agent_architecture: "{project-root}/.bmad/bmb/docs/agents/module-agent-architecture.md" module_agent_architecture: "{project-root}/{bmad_folder}/bmb/docs/agents/module-agent-architecture.md"
agent_menu_patterns: "{project-root}/.bmad/bmb/docs/agents/agent-menu-patterns.md" agent_menu_patterns: "{project-root}/{bmad_folder}/bmb/docs/agents/agent-menu-patterns.md"
# Data and templates # Data and templates
@ -83,9 +83,9 @@ module_agent_examples: "{project-root}/src/modules/bmb/reference/agents/module-e
# Output configuration # Output configuration
custom_agent_location: "{project-root}/.bmad/custom/src/agents" custom_agent_location: "{project-root}/{bmad_folder}/custom/src/agents"
module_output_file: "{project-root}/.bmad/{target_module}/agents/{agent_filename}.agent.yaml" module_output_file: "{project-root}/{bmad_folder}/{target_module}/agents/{agent_filename}.agent.yaml"
standalone_output_folder: "{custom_agent_location}/{agent_filename}" standalone_output_folder: "{custom_agent_location}/{agent_filename}"
standalone_output_file: "{standalone_output_folder}/{agent_filename}.agent.yaml" standalone_output_file: "{standalone_output_folder}/{agent_filename}.agent.yaml"
standalone_info_guide: "{standalone_output_folder}/info-and-installation-guide.md" 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"

View File

@ -70,8 +70,10 @@ To collaboratively design the workflow structure, step sequence, and interaction
When designing, you may load these documents as needed: 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/templates/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/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/docs/workflows/architecture.md` - Architecture principles - `{project-root}/{bmad_folder}/bmb/docs/workflows/architecture.md` - Architecture principles
- `{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition/workflow.md` - Complete example - `{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition/workflow.md` - Complete example
@ -84,10 +86,18 @@ Let's reference our step creation documentation for best practices:
Load and reference step-file architecture guide: 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 requirements, collaboratively design:
- How many major steps does this workflow need? (Recommend 3-7) - How many major steps does this workflow need? (Recommend 3-7)
- What is the goal of each step? - What is the goal of each step?
@ -95,6 +105,25 @@ This shows the standard structure for step files. Based on the requirements, col
- Should any steps repeat or loop? - Should any steps repeat or loop?
- What are the decision points within steps? - 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 ### 2. Interaction Pattern Design
Design how users will interact with the workflow: Design how users will interact with the workflow:

View File

@ -18,8 +18,10 @@ advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elici
partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md' partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
# Template References # Template References
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md' workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-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'
contentTemplate: '{workflow_path}/templates/content-template.md' contentTemplate: '{workflow_path}/templates/content-template.md'
buildSummaryTemplate: '{workflow_path}/templates/build-summary.md' buildSummaryTemplate: '{workflow_path}/templates/build-summary.md'
--- ---
@ -70,8 +72,10 @@ To generate all the workflow files (workflow.md, step files, templates, and supp
## BUILD REFERENCE MATERIALS: ## BUILD REFERENCE MATERIALS:
- When building each step file, you must follow template `{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md` - When building each step file, you must follow template `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/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 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 - Example step files from {project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition/workflow.md for patterns
## FILE GENERATION SEQUENCE: ## FILE GENERATION SEQUENCE:
@ -99,6 +103,7 @@ Create the workflow folder structure in the target location:
├── workflow.md ├── workflow.md
├── steps/ ├── steps/
│ ├── step-01-init.md │ ├── step-01-init.md
│ ├── step-01b-continue.md (if continuation support needed)
│ ├── step-02-[name].md │ ├── step-02-[name].md
│ └── ... │ └── ...
├── templates/ ├── templates/
@ -123,7 +128,47 @@ Load and follow {workflowTemplate}:
### 4. Generate Step Files ### 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} - Load and follow {stepTemplate}
- Create step file using template structure - Create step file using template structure
@ -131,6 +176,7 @@ For each step in the design:
- Ensure proper frontmatter with path references - Ensure proper frontmatter with path references
- Include appropriate menu handling and universal rules - Include appropriate menu handling and universal rules
- Follow all mandatory rules and protocols from template - Follow all mandatory rules and protocols from template
- **Critical**: Ensure each step updates `stepsCompleted` array when completing
### 5. Generate Templates (If Needed) ### 5. Generate Templates (If Needed)

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -11,10 +11,6 @@ nextStepFile: '{workflow_path}/steps/step-02-discover.md'
workflowFile: '{workflow_path}/workflow.md' workflowFile: '{workflow_path}/workflow.md'
outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.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 # Template References
analysisTemplate: '{workflow_path}/templates/workflow-analysis.md' analysisTemplate: '{workflow_path}/templates/workflow-analysis.md'
--- ---
@ -134,8 +130,8 @@ Based on what the user wants to edit:
Load reference documentation as needed: Load reference documentation as needed:
- `{project-root}/{bmad_folder}/bmb/docs/workflows/architecture.md` - `{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/templates/step-template.md`
- `{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md` - `{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md`
Check against best practices: Check against best practices:

View File

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

View File

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

View File

@ -16,8 +16,8 @@ targetWorkflowFile: '{target_workflow_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References # Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md' stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md' workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
--- ---
# Step 2: Workflow.md Validation # Step 2: Workflow.md Validation

View File

@ -16,8 +16,8 @@ targetWorkflowStepsPath: '{target_workflow_steps_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References # Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md' stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-template.md' workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/workflow-template.md'
--- ---
# Step 3: Step-by-Step Validation # Step 3: Step-by-Step Validation

View File

@ -16,8 +16,8 @@ targetWorkflowPath: '{target_workflow_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References # Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md' stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-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' csvStandards: '{project-root}/{bmad_folder}/bmb/docs/workflows/csv-data-file-standards.md'
--- ---

View File

@ -16,8 +16,8 @@ targetWorkflowPath: '{target_workflow_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References # Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md' stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-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' intentSpectrum: '{project-root}/{bmad_folder}/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md'
--- ---

View File

@ -16,8 +16,8 @@ targetWorkflowStepsPath: '{target_workflow_steps_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References # Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md' stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-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' intentSpectrum: '{project-root}/{bmad_folder}/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md'
--- ---

View File

@ -16,8 +16,8 @@ targetWorkflowFile: '{target_workflow_path}'
complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
# Documentation References # Documentation References
stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/step-template.md' stepTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/templates/step-template.md'
workflowTemplate: '{project-root}/{bmad_folder}/bmb/docs/workflows/workflow-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' intentSpectrum: '{project-root}/{bmad_folder}/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md'
--- ---

View File

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

View File

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

View File

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

View File

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

View File

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