mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
The install directory is now configurable, with a few minute issues
This commit is contained in:
Brian Madison
@@ -10,18 +10,20 @@ prompt: "Happy Building - Build the Modules, Workflows and Agents of your dreams
|
||||
## communication_language
|
||||
## output_folder
|
||||
## bmad_folder
|
||||
## install_user_docs
|
||||
## kb_install
|
||||
|
||||
custom_agent_location:
|
||||
prompt: "Where do custom agents get created?"
|
||||
default: "bmad/agents"
|
||||
default: "{bmad_folder}/custom/agents"
|
||||
result: "{project-root}/{value}"
|
||||
|
||||
custom_workflow_location:
|
||||
prompt: "Where do custom workflows get stored?"
|
||||
default: "bmad/workflows"
|
||||
default: "{bmad_folder}/custom/workflows"
|
||||
result: "{project-root}/{value}"
|
||||
|
||||
custom_module_location:
|
||||
prompt: "Where do custom modules get stored?"
|
||||
default: "bmad"
|
||||
default: "{bmad_folder}/custom/modules"
|
||||
result: "{project-root}/{value}"
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmb/agents/bmad-builder.md
|
||||
id: "{bmad_folder}/bmb/agents/bmad-builder.md"
|
||||
name: BMad Builder
|
||||
title: BMad Builder
|
||||
icon: 🧙
|
||||
@@ -22,37 +22,37 @@ agent:
|
||||
# help and exit are auto-injected, don't define them here
|
||||
menu:
|
||||
- trigger: audit-workflow
|
||||
workflow: "{project-root}/bmad/bmb/workflows/audit-workflow/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmb/workflows/audit-workflow/workflow.yaml"
|
||||
description: Audit existing workflows for BMAD Core compliance and best practices
|
||||
|
||||
- trigger: convert
|
||||
workflow: "{project-root}/bmad/bmb/workflows/convert-legacy/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmb/workflows/convert-legacy/workflow.yaml"
|
||||
description: Convert v4 or any other style task agent or template to a workflow
|
||||
|
||||
- trigger: create-agent
|
||||
workflow: "{project-root}/bmad/bmb/workflows/create-agent/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/workflow.yaml"
|
||||
description: Create a new BMAD Core compliant agent
|
||||
|
||||
- trigger: create-module
|
||||
workflow: "{project-root}/bmad/bmb/workflows/create-module/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmb/workflows/create-module/workflow.yaml"
|
||||
description: Create a complete BMAD compatible module (custom agents and workflows)
|
||||
|
||||
- trigger: create-workflow
|
||||
workflow: "{project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmb/workflows/create-workflow/workflow.yaml"
|
||||
description: Create a new BMAD Core workflow with proper structure
|
||||
|
||||
- trigger: edit-agent
|
||||
workflow: "{project-root}/bmad/bmb/workflows/edit-agent/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmb/workflows/edit-agent/workflow.yaml"
|
||||
description: Edit existing agents while following best practices
|
||||
|
||||
- trigger: edit-module
|
||||
workflow: "{project-root}/bmad/bmb/workflows/edit-module/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmb/workflows/edit-module/workflow.yaml"
|
||||
description: Edit existing modules (structure, agents, workflows, documentation)
|
||||
|
||||
- trigger: edit-workflow
|
||||
workflow: "{project-root}/bmad/bmb/workflows/edit-workflow/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmb/workflows/edit-workflow/workflow.yaml"
|
||||
description: Edit existing workflows while following best practices
|
||||
|
||||
- trigger: redoc
|
||||
workflow: "{project-root}/bmad/bmb/workflows/redoc/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmb/workflows/redoc/workflow.yaml"
|
||||
description: Create or update module documentation
|
||||
|
||||
@@ -45,7 +45,7 @@
|
||||
## Web Bundle Validation (if applicable)
|
||||
|
||||
- [ ] web_bundle section present if workflow needs deployment
|
||||
- [ ] All paths in web_bundle use bmad/-relative format (NOT {project-root})
|
||||
- [ ] All paths in web_bundle use {bmad_folder}/-relative format (NOT {project-root})
|
||||
- [ ] No {config_source} variables in web_bundle section
|
||||
- [ ] instructions file listed in web_bundle_files array
|
||||
- [ ] template file listed in web_bundle_files (if document workflow)
|
||||
@@ -53,7 +53,7 @@
|
||||
- [ ] All data files (CSV, JSON, YAML) listed in web_bundle_files
|
||||
- [ ] All <invoke-workflow> called workflows have their .yaml files in web_bundle_files
|
||||
- [ ] **CRITICAL**: If workflow invokes other workflows, existing_workflows field is present
|
||||
- [ ] existing_workflows maps workflow variables to bmad/-relative paths correctly
|
||||
- [ ] existing_workflows maps workflow variables to {bmad_folder}/-relative paths correctly
|
||||
- [ ] All files referenced in instructions <action> tags listed in web_bundle_files
|
||||
- [ ] No files listed in web_bundle_files that don't exist
|
||||
- [ ] Web bundle metadata (name, description, author) matches top-level metadata
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Audit Workflow - Workflow Quality Audit Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/audit-workflow/workflow.yaml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmb/workflows/audit-workflow/workflow.yaml</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
@@ -33,7 +33,7 @@
|
||||
|
||||
**Required variables:**
|
||||
|
||||
- `config_source: "{project-root}/bmad/[module]/config.yaml"`
|
||||
- `config_source: "{project-root}/{bmad_folder}/[module]/config.yaml"`
|
||||
- `output_folder: "{config_source}:output_folder"`
|
||||
- `user_name: "{config_source}:user_name"`
|
||||
- `communication_language: "{config_source}:communication_language"`
|
||||
@@ -182,7 +182,7 @@
|
||||
|
||||
**Path Validation:**
|
||||
|
||||
- [ ] All paths use bmad/-relative format (NOT {project-root})
|
||||
- [ ] All paths use {bmad_folder}/-relative format (NOT {project-root})
|
||||
- [ ] No {config_source} variables in web_bundle section
|
||||
- [ ] Paths match actual file locations
|
||||
|
||||
@@ -200,7 +200,7 @@
|
||||
<action>Verify each called workflow.yaml is in web_bundle_files</action>
|
||||
<action>**CRITICAL**: Check if existing_workflows field is present when workflows are invoked</action>
|
||||
<action>If invoke-workflow calls exist, existing_workflows MUST map workflow variables to paths</action>
|
||||
<action>Example: If instructions use {core_brainstorming}, web_bundle needs: existing_workflows: - core_brainstorming: "bmad/core/workflows/brainstorming/workflow.yaml"</action>
|
||||
<action>Example: If instructions use {core_brainstorming}, web_bundle needs: existing_workflows: - core_brainstorming: "{bmad_folder}/core/workflows/brainstorming/workflow.yaml"</action>
|
||||
|
||||
**File Reference Scan:**
|
||||
<action>Scan instructions.md for file references in action tags</action>
|
||||
|
||||
@@ -4,14 +4,14 @@ description: "Comprehensive workflow quality audit - validates structure, config
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/bmad/bmb/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
date: system-generated
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmb/workflows/audit-workflow"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmb/workflows/audit-workflow"
|
||||
template: "{installed_path}/template.md"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
@@ -84,7 +84,7 @@ convert-legacy/
|
||||
- Prompts for target module (bmm, bmb, cis, custom)
|
||||
- Determines proper installation paths using v6 conventions
|
||||
- Shows target location for user confirmation
|
||||
- Ensures all paths use `{project-root}/bmad/` format
|
||||
- Ensures all paths use `{project-root}/{bmad_folder}/` format
|
||||
|
||||
### Phase 2: Conversion Strategy (Step 4)
|
||||
|
||||
@@ -126,7 +126,7 @@ convert-legacy/
|
||||
**Template-to-Workflow Conversion (5c)**
|
||||
|
||||
- Converts YAML template sections to workflow steps
|
||||
- Maps `elicit: true` flags to `<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>` tags
|
||||
- Maps `elicit: true` flags to `<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>` tags
|
||||
- Transforms conditional sections to flow control
|
||||
- Creates proper template.md from content structure
|
||||
- Integrates v4 create-doc.md task patterns
|
||||
@@ -218,7 +218,7 @@ Converted items follow v6 conventions:
|
||||
|
||||
**Issue**: Path conversion errors
|
||||
|
||||
- **Solution**: Ensure all references use `{project-root}/bmad/` format
|
||||
- **Solution**: Ensure all references use `{project-root}/{bmad_folder}/` format
|
||||
- **Check**: Review conversion mappings for proper path patterns
|
||||
|
||||
**Issue**: Sub-workflow invocation fails
|
||||
@@ -252,8 +252,8 @@ To customize this workflow:
|
||||
|
||||
For issues or questions:
|
||||
|
||||
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||
- Check conversion mappings at `/bmad/bmb/data/v4-to-v6-mappings.yaml`
|
||||
- Review the workflow creation guide at `/{bmad_folder}/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||
- Check conversion mappings at `/{bmad_folder}/bmb/data/v4-to-v6-mappings.yaml`
|
||||
- Validate output using `checklist.md`
|
||||
- Consult BMAD v6 documentation for proper conventions
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@
|
||||
- [ ] File paths use {project-root} variables
|
||||
- [ ] Config values use {config_source}: pattern
|
||||
- [ ] Agent follows naming conventions (kebab-case for files)
|
||||
- [ ] ALL paths reference {project-root}/bmad/{{module}}/ locations, NOT src/
|
||||
- [ ] ALL paths reference {project-root}/{bmad_folder}/{{module}}/ locations, NOT src/
|
||||
- [ ] exec, data, run-workflow commands point to final BMAD installation paths
|
||||
|
||||
### For Template/Workflow Conversions
|
||||
@@ -48,7 +48,7 @@
|
||||
- [ ] All sections converted to workflow steps
|
||||
- [ ] Section hierarchy maintained in instructions
|
||||
- [ ] Variables ({{var}}) preserved in template.md
|
||||
- [ ] Elicitation points (elicit: true) converted to <invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
- [ ] Elicitation points (elicit: true) converted to <invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
- [ ] Conditional sections preserved with if="" attributes
|
||||
- [ ] Repeatable sections converted to repeat="" attributes
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Convert Legacy - v4 to v6 Conversion Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<parameter name="You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/convert-legacy/workflow.yaml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<parameter name="You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmb/workflows/convert-legacy/workflow.yaml</critical>
|
||||
<critical>Communicate in {communication_language} throughout the conversion process</critical>
|
||||
|
||||
<workflow>
|
||||
@@ -70,8 +70,8 @@ For Modules:
|
||||
<action if="custom module"><ask>Enter custom module code (kebab-case):</ask></action>
|
||||
<action>Determine installation path based on type and module</action>
|
||||
<critical>IMPORTANT: All paths must use final BMAD installation locations, not src paths!</critical>
|
||||
<action>Show user the target location: {project-root}/bmad/{{target_module}}/{{item_type}}/{{item_name}}</action>
|
||||
<action>Note: Files will be created in bmad/ but all internal paths will reference {project-root}/bmad/ locations</action>
|
||||
<action>Show user the target location: {project-root}/{bmad_folder}/{{target_module}}/{{item_type}}/{{item_name}}</action>
|
||||
<action>Note: Files will be created in {bmad_folder}/ but all internal paths will reference {project-root}/{bmad_folder}/ locations</action>
|
||||
<ask>Proceed with this location? (y/n)</ask>
|
||||
</step>
|
||||
|
||||
@@ -150,16 +150,16 @@ For Modules:
|
||||
- Convert task dependencies to workflow references
|
||||
- Map template dependencies to v6 workflows
|
||||
- Preserve checklist and data file references
|
||||
- CRITICAL: All paths must use {project-root}/bmad/{{module}}/ NOT src/
|
||||
- CRITICAL: All paths must use {project-root}/{bmad_folder}/{{module}}/ NOT src/
|
||||
|
||||
<action>Generate the converted v6 agent YAML file (.agent.yaml)</action>
|
||||
<action>Example path conversions:
|
||||
|
||||
- exec="{project-root}/bmad/{{target_module}}/tasks/task-name.md"
|
||||
- run-workflow="{project-root}/bmad/{{target_module}}/workflows/workflow-name/workflow.yaml"
|
||||
- data="{project-root}/bmad/{{target_module}}/data/data-file.yaml"
|
||||
- exec="{project-root}/{bmad_folder}/{{target_module}}/tasks/task-name.md"
|
||||
- run-workflow="{project-root}/{bmad_folder}/{{target_module}}/workflows/workflow-name/workflow.yaml"
|
||||
- data="{project-root}/{bmad_folder}/{{target_module}}/data/data-file.yaml"
|
||||
</action>
|
||||
<action>Save to: bmad/{{target_module}}/agents/{{agent_name}}.agent.yaml (physical location)</action>
|
||||
<action>Save to: {bmad_folder}/{{target_module}}/agents/{{agent_name}}.agent.yaml (physical location)</action>
|
||||
<action>Note: The build process will later compile this to .md with XML format</action>
|
||||
<goto step="6">Continue to Validation</goto>
|
||||
</step>
|
||||
@@ -172,7 +172,7 @@ For Modules:
|
||||
- Any special behaviors
|
||||
|
||||
<invoke-workflow>
|
||||
workflow: {project-root}/bmad/bmb/workflows/create-agent/workflow.yaml
|
||||
workflow: {project-root}/{bmad_folder}/bmb/workflows/create-agent/workflow.yaml
|
||||
inputs:
|
||||
- agent_name: {{extracted_name}}
|
||||
- agent_purpose: {{extracted_purpose}}
|
||||
@@ -193,7 +193,7 @@ For Modules:
|
||||
|
||||
2. Convert template sections to instructions.md:
|
||||
- Each YAML section → workflow step
|
||||
- `elicit: true` → `<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>` tag
|
||||
- `elicit: true` → `<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>` tag
|
||||
- Conditional sections → `if="condition"` attribute
|
||||
- Repeatable sections → `repeat="for-each"` attribute
|
||||
- Section instructions → step content
|
||||
@@ -212,7 +212,7 @@ For Modules:
|
||||
|
||||
```yaml
|
||||
# Critical variables from config
|
||||
config_source: '{project-root}/bmad/{{target_module}}/config.yaml'
|
||||
config_source: '{project-root}/{bmad_folder}/{{target_module}}/config.yaml'
|
||||
output_folder: '{config_source}:output_folder'
|
||||
user_name: '{config_source}:user_name'
|
||||
communication_language: '{config_source}:communication_language'
|
||||
@@ -220,7 +220,7 @@ date: system-generated
|
||||
```
|
||||
|
||||
<invoke-workflow>
|
||||
workflow: {project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml
|
||||
workflow: {project-root}/{bmad_folder}/bmb/workflows/create-workflow/workflow.yaml
|
||||
inputs:
|
||||
- workflow_name: {{template_name}}
|
||||
- workflow_type: document
|
||||
@@ -239,7 +239,7 @@ date: system-generated
|
||||
<action>Create module blueprint with all components</action>
|
||||
|
||||
<invoke-workflow>
|
||||
workflow: {project-root}/bmad/bmb/workflows/create-module/workflow.yaml
|
||||
workflow: {project-root}/{bmad_folder}/bmb/workflows/create-module/workflow.yaml
|
||||
inputs:
|
||||
- module_name: {{module_name}}
|
||||
- components: {{component_list}}
|
||||
@@ -277,7 +277,7 @@ date: system-generated
|
||||
</check>
|
||||
|
||||
4. Handle special v4 patterns:
|
||||
- 1-9 elicitation menus → v6 <invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
- 1-9 elicitation menus → v6 <invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
- Agent permissions → note in instructions
|
||||
- YOLO mode → autonomous flag or optional steps
|
||||
- Critical notices → workflow.yaml comments
|
||||
@@ -286,7 +286,7 @@ date: system-generated
|
||||
|
||||
```yaml
|
||||
# Critical variables from config
|
||||
config_source: '{project-root}/bmad/{{target_module}}/config.yaml'
|
||||
config_source: '{project-root}/{bmad_folder}/{{target_module}}/config.yaml'
|
||||
output_folder: '{config_source}:output_folder'
|
||||
user_name: '{config_source}:user_name'
|
||||
communication_language: '{config_source}:communication_language'
|
||||
@@ -294,7 +294,7 @@ date: system-generated
|
||||
```
|
||||
|
||||
<invoke-workflow>
|
||||
workflow: {project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml
|
||||
workflow: {project-root}/{bmad_folder}/bmb/workflows/create-workflow/workflow.yaml
|
||||
inputs:
|
||||
- workflow_name: {{task_name}}
|
||||
- workflow_type: {{confirmed_workflow_type}}
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Converts legacy BMAD v4 or similar items (agents, workflows, modul
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/bmad/bmb/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -15,19 +15,19 @@ recommended_inputs:
|
||||
- legacy_file: "Path to v4 agent, workflow, or module to convert"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmb/workflows/convert-legacy"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmb/workflows/convert-legacy"
|
||||
template: false # This is an action/meta workflow - no template needed
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
# Output configuration - Creates converted items in appropriate module locations
|
||||
default_output_folder: "{project-root}/bmad/{{target_module}}/{{item_type}}/{{item_name}}"
|
||||
default_output_folder: "{project-root}/{bmad_folder}/{{target_module}}/{{item_type}}/{{item_name}}"
|
||||
|
||||
# Sub-workflows that may be invoked for conversion
|
||||
sub_workflows:
|
||||
- create_agent: "{project-root}/bmad/bmb/workflows/create-agent/workflow.yaml"
|
||||
- create_workflow: "{project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml"
|
||||
- create_module: "{project-root}/bmad/bmb/workflows/create-module/workflow.yaml"
|
||||
- create_agent: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/workflow.yaml"
|
||||
- create_workflow: "{project-root}/{bmad_folder}/bmb/workflows/create-workflow/workflow.yaml"
|
||||
- create_module: "{project-root}/{bmad_folder}/bmb/workflows/create-module/workflow.yaml"
|
||||
|
||||
standalone: true
|
||||
|
||||
|
||||
@@ -86,20 +86,20 @@ workflow create-agent
|
||||
|
||||
**Standalone Agents:**
|
||||
|
||||
- Source: `bmad/agents/{filename}.agent.yaml`
|
||||
- Compiled: `bmad/agents/{filename}.md`
|
||||
- Source: `{bmad_folder}/agents/{filename}.agent.yaml`
|
||||
- Compiled: `{bmad_folder}/agents/{filename}.md`
|
||||
|
||||
**Module Agents:**
|
||||
|
||||
- Source: `src/modules/{module}/agents/{filename}.agent.yaml`
|
||||
- Compiled: `bmad/{module}/agents/{filename}.md`
|
||||
- Compiled: `{bmad_folder}/{module}/agents/{filename}.md`
|
||||
|
||||
### YAML Structure
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/{module}/agents/{filename}.md
|
||||
id: {bmad_folder}/{module}/agents/{filename}.md
|
||||
name: Agent Name
|
||||
title: Agent Title
|
||||
icon: 🤖
|
||||
@@ -117,7 +117,7 @@ agent:
|
||||
|
||||
### Optional Customize File
|
||||
|
||||
Location: `bmad/_cfg/agents/{module}-{filename}.customize.yaml`
|
||||
Location: `{bmad_folder}/_cfg/agents/{module}-{filename}.customize.yaml`
|
||||
|
||||
Allows persona and menu overrides that persist through updates.
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ _LLM-Optimized Technical Documentation for Agent Building_
|
||||
|
||||
**Required Attributes:**
|
||||
|
||||
- `id` - Unique path identifier (e.g., "bmad/bmm/agents/analyst.md")
|
||||
- `id` - Unique path identifier (e.g., "{bmad_folder}/bmm/agents/analyst.md")
|
||||
- `name` - Agent's name (e.g., "Mary", "John", "Helper")
|
||||
- `title` - Professional title (e.g., "Business Analyst", "Security Engineer")
|
||||
- `icon` - Single emoji representing the agent
|
||||
@@ -60,7 +60,7 @@ _LLM-Optimized Technical Documentation for Agent Building_
|
||||
|
||||
```xml
|
||||
<critical-actions>
|
||||
<i>Load into memory {project-root}/bmad/{module}/config.yaml and set variables</i>
|
||||
<i>Load into memory {project-root}/{bmad_folder}/{module}/config.yaml and set variables</i>
|
||||
<i>Remember the users name is {user_name}</i>
|
||||
<i>ALWAYS communicate in {communication_language}</i>
|
||||
<!-- Custom initialization actions -->
|
||||
@@ -77,7 +77,7 @@ _LLM-Optimized Technical Documentation for Agent Building_
|
||||
<i critical="MANDATORY">You MUST follow all rules in instructions.md on EVERY interaction</i>
|
||||
|
||||
<!-- Standard initialization -->
|
||||
<i>Load into memory {project-root}/bmad/{module}/config.yaml and set variables</i>
|
||||
<i>Load into memory {project-root}/{bmad_folder}/{module}/config.yaml and set variables</i>
|
||||
<i>Remember the users name is {user_name}</i>
|
||||
<i>ALWAYS communicate in {communication_language}</i>
|
||||
|
||||
@@ -162,9 +162,9 @@ _LLM-Optimized Technical Documentation for Agent Building_
|
||||
|
||||
```xml
|
||||
<module-integration>
|
||||
<module-path>{project-root}/bmad/{module-code}</module-path>
|
||||
<module-path>{project-root}/{bmad_folder}/{module-code}</module-path>
|
||||
<config-source>{module-path}/config.yaml</config-source>
|
||||
<workflows-path>{project-root}/bmad/{module-code}/workflows</workflows-path>
|
||||
<workflows-path>{project-root}/{bmad_folder}/{module-code}/workflows</workflows-path>
|
||||
</module-integration>
|
||||
```
|
||||
|
||||
@@ -186,7 +186,7 @@ Example: `{config_source}:output_folder`
|
||||
### Path Construction
|
||||
|
||||
```
|
||||
Good: {project-root}/bmad/{module}/agents/
|
||||
Good: {project-root}/{bmad_folder}/{module}/agents/
|
||||
Bad: /absolute/path/to/agents/
|
||||
Bad: ../../../relative/paths/
|
||||
```
|
||||
@@ -197,7 +197,7 @@ Bad: ../../../relative/paths/
|
||||
|
||||
```xml
|
||||
<!-- Full path -->
|
||||
<item cmd="*create-prd" run-workflow="{project-root}/bmad/bmm/workflows/prd/workflow.yaml">
|
||||
<item cmd="*create-prd" run-workflow="{project-root}/{bmad_folder}/bmm/workflows/prd/workflow.yaml">
|
||||
Create Product Requirements Document
|
||||
</item>
|
||||
|
||||
@@ -210,7 +210,7 @@ Bad: ../../../relative/paths/
|
||||
### Task Commands
|
||||
|
||||
```xml
|
||||
<item cmd="*validate" exec="{project-root}/bmad/core/tasks/validate-workflow.xml">
|
||||
<item cmd="*validate" exec="{project-root}/{bmad_folder}/core/tasks/validate-workflow.xml">
|
||||
Validate document
|
||||
</item>
|
||||
```
|
||||
@@ -219,8 +219,8 @@ Bad: ../../../relative/paths/
|
||||
|
||||
```xml
|
||||
<item cmd="*brief"
|
||||
exec="{project-root}/bmad/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/bmad/bmm/templates/brief.md">
|
||||
exec="{project-root}/{bmad_folder}/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/{bmad_folder}/bmm/templates/brief.md">
|
||||
Create project brief
|
||||
</item>
|
||||
```
|
||||
@@ -229,8 +229,8 @@ Bad: ../../../relative/paths/
|
||||
|
||||
```xml
|
||||
<item cmd="*standup"
|
||||
exec="{project-root}/bmad/bmm/tasks/daily-standup.xml"
|
||||
data="{project-root}/bmad/_cfg/agent-manifest.csv">
|
||||
exec="{project-root}/{bmad_folder}/bmm/tasks/daily-standup.xml"
|
||||
data="{project-root}/{bmad_folder}/_cfg/agent-manifest.csv">
|
||||
Run daily standup
|
||||
</item>
|
||||
```
|
||||
@@ -295,7 +295,7 @@ Bad: ../../../relative/paths/
|
||||
</persona>
|
||||
|
||||
<!-- Variable-based paths -->
|
||||
<item cmd="*run" exec="{project-root}/bmad/module/task.md">
|
||||
<item cmd="*run" exec="{project-root}/{bmad_folder}/module/task.md">
|
||||
|
||||
<!-- Required commands present -->
|
||||
<menu>
|
||||
@@ -395,7 +395,7 @@ When building agents:
|
||||
|
||||
```xml
|
||||
<critical-actions>
|
||||
<i>Load into memory {project-root}/bmad/{module}/config.yaml</i>
|
||||
<i>Load into memory {project-root}/{bmad_folder}/{module}/config.yaml</i>
|
||||
<i>Remember the users name is {user_name}</i>
|
||||
<i>ALWAYS communicate in {communication_language}</i>
|
||||
</critical-actions>
|
||||
@@ -404,7 +404,7 @@ When building agents:
|
||||
### Module Agent Pattern
|
||||
|
||||
```xml
|
||||
<agent id="bmad/{module}/agents/{name}.md"
|
||||
<agent id="{bmad_folder}/{module}/agents/{name}.md"
|
||||
name="{Name}"
|
||||
title="{Title}"
|
||||
icon="{emoji}">
|
||||
|
||||
@@ -67,14 +67,14 @@ Execute complete multi-step processes
|
||||
```xml
|
||||
<!-- Standard workflow -->
|
||||
<item cmd="*create-prd"
|
||||
run-workflow="{project-root}/bmad/bmm/workflows/prd/workflow.yaml">
|
||||
run-workflow="{project-root}/{bmad_folder}/bmm/workflows/prd/workflow.yaml">
|
||||
Create Product Requirements Document
|
||||
</item>
|
||||
|
||||
<!-- Workflow with validation -->
|
||||
<item cmd="*validate-prd"
|
||||
validate-workflow="{output_folder}/prd-draft.md"
|
||||
workflow="{project-root}/bmad/bmm/workflows/prd/workflow.yaml">
|
||||
workflow="{project-root}/{bmad_folder}/bmm/workflows/prd/workflow.yaml">
|
||||
Validate PRD Against Checklist
|
||||
</item>
|
||||
|
||||
@@ -112,14 +112,14 @@ Execute single operations
|
||||
```xml
|
||||
<!-- Simple task -->
|
||||
<item cmd="*validate"
|
||||
exec="{project-root}/bmad/core/tasks/validate-workflow.xml">
|
||||
exec="{project-root}/{bmad_folder}/core/tasks/validate-workflow.xml">
|
||||
Validate document against checklist
|
||||
</item>
|
||||
|
||||
<!-- Task with data -->
|
||||
<item cmd="*standup"
|
||||
exec="{project-root}/bmad/mmm/tasks/daily-standup.xml"
|
||||
data="{project-root}/bmad/_cfg/agent-manifest.csv">
|
||||
exec="{project-root}/{bmad_folder}/mmm/tasks/daily-standup.xml"
|
||||
data="{project-root}/{bmad_folder}/_cfg/agent-manifest.csv">
|
||||
Run agile team standup
|
||||
</item>
|
||||
```
|
||||
@@ -137,15 +137,15 @@ Generate documents from templates
|
||||
|
||||
```xml
|
||||
<item cmd="*brief"
|
||||
exec="{project-root}/bmad/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/bmad/bmm/templates/brief.md">
|
||||
exec="{project-root}/{bmad_folder}/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/{bmad_folder}/bmm/templates/brief.md">
|
||||
Produce Project Brief
|
||||
</item>
|
||||
|
||||
<item cmd="*competitor-analysis"
|
||||
exec="{project-root}/bmad/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/bmad/bmm/templates/competitor.md"
|
||||
data="{project-root}/bmad/_data/market-research.csv">
|
||||
exec="{project-root}/{bmad_folder}/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/{bmad_folder}/bmm/templates/competitor.md"
|
||||
data="{project-root}/{bmad_folder}/_data/market-research.csv">
|
||||
Produce Competitor Analysis
|
||||
</item>
|
||||
```
|
||||
@@ -174,7 +174,7 @@ Direct prompts embedded in commands (Simple agents)
|
||||
```xml
|
||||
<!-- Short action attribute with embedded prompt -->
|
||||
<item cmd="*list-tasks"
|
||||
action="list all tasks from {project-root}/bmad/_cfg/task-manifest.csv">
|
||||
action="list all tasks from {project-root}/{bmad_folder}/_cfg/task-manifest.csv">
|
||||
List Available Tasks
|
||||
</item>
|
||||
|
||||
@@ -227,7 +227,7 @@ For multiline/complex prompts, define them separately and reference by id:
|
||||
|
||||
<item cmd="*review-literature"
|
||||
action="#literature-review"
|
||||
data="{project-root}/bmad/_data/sources.csv">
|
||||
data="{project-root}/{bmad_folder}/_data/sources.csv">
|
||||
Conduct Literature Review
|
||||
</item>
|
||||
|
||||
@@ -407,23 +407,23 @@ The `data` attribute can be added to ANY command type to provide supplementary i
|
||||
```xml
|
||||
<!-- Workflow with data -->
|
||||
<item cmd="*brainstorm"
|
||||
run-workflow="{project-root}/bmad/core/workflows/brainstorming/workflow.yaml"
|
||||
data="{project-root}/bmad/core/workflows/brainstorming/brain-methods.csv">
|
||||
run-workflow="{project-root}/{bmad_folder}/core/workflows/brainstorming/workflow.yaml"
|
||||
data="{project-root}/{bmad_folder}/core/workflows/brainstorming/brain-methods.csv">
|
||||
Creative Brainstorming Session
|
||||
</item>
|
||||
|
||||
<!-- Action with data -->
|
||||
<item cmd="*analyze-metrics"
|
||||
action="analyze these metrics and identify trends"
|
||||
data="{project-root}/bmad/_data/performance-metrics.json">
|
||||
data="{project-root}/{bmad_folder}/_data/performance-metrics.json">
|
||||
Analyze Performance Metrics
|
||||
</item>
|
||||
|
||||
<!-- Template with data -->
|
||||
<item cmd="*report"
|
||||
exec="{project-root}/bmad/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/bmad/bmm/templates/report.md"
|
||||
data="{project-root}/bmad/_data/quarterly-results.csv">
|
||||
exec="{project-root}/{bmad_folder}/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/{bmad_folder}/bmm/templates/report.md"
|
||||
data="{project-root}/{bmad_folder}/_data/quarterly-results.csv">
|
||||
Generate Quarterly Report
|
||||
</item>
|
||||
```
|
||||
@@ -572,14 +572,14 @@ The `data` attribute can be added to ANY command type to provide supplementary i
|
||||
```xml
|
||||
<!-- Create document -->
|
||||
<item cmd="*{action}-{object}"
|
||||
run-workflow="{project-root}/bmad/{module}/workflows/{workflow}/workflow.yaml">
|
||||
run-workflow="{project-root}/{bmad_folder}/{module}/workflows/{workflow}/workflow.yaml">
|
||||
{Action} {Object Description}
|
||||
</item>
|
||||
|
||||
<!-- Validate document -->
|
||||
<item cmd="*validate-{object}"
|
||||
validate-workflow="{output_folder}/{document}.md"
|
||||
workflow="{project-root}/bmad/{module}/workflows/{workflow}/workflow.yaml">
|
||||
workflow="{project-root}/{bmad_folder}/{module}/workflows/{workflow}/workflow.yaml">
|
||||
Validate {Object Description}
|
||||
</item>
|
||||
```
|
||||
@@ -588,7 +588,7 @@ The `data` attribute can be added to ANY command type to provide supplementary i
|
||||
|
||||
```xml
|
||||
<item cmd="*{action}"
|
||||
exec="{project-root}/bmad/{module}/tasks/{task}.md">
|
||||
exec="{project-root}/{bmad_folder}/{module}/tasks/{task}.md">
|
||||
{Action Description}
|
||||
</item>
|
||||
```
|
||||
@@ -597,8 +597,8 @@ The `data` attribute can be added to ANY command type to provide supplementary i
|
||||
|
||||
```xml
|
||||
<item cmd="*{document}"
|
||||
exec="{project-root}/bmad/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/bmad/{module}/templates/{template}.md">
|
||||
exec="{project-root}/{bmad_folder}/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/{bmad_folder}/{module}/templates/{template}.md">
|
||||
Create {Document Name}
|
||||
</item>
|
||||
```
|
||||
@@ -631,7 +631,7 @@ The `data` attribute can be added to ANY command type to provide supplementary i
|
||||
### Complete Self-Contained Agent
|
||||
|
||||
```xml
|
||||
<agent id="bmad/research/agents/analyst.md" name="Research Analyst" icon="🔬">
|
||||
<agent id="{bmad_folder}/research/agents/analyst.md" name="Research Analyst" icon="🔬">
|
||||
<!-- Embedded prompt library -->
|
||||
<prompts>
|
||||
<prompt id="swot-analysis">
|
||||
@@ -688,14 +688,14 @@ The `data` attribute can be added to ANY command type to provide supplementary i
|
||||
|
||||
<item cmd="*compete"
|
||||
action="#competitive-intel"
|
||||
data="{project-root}/bmad/_data/market-data.csv">
|
||||
data="{project-root}/{bmad_folder}/_data/market-data.csv">
|
||||
Analyze Competition
|
||||
</item>
|
||||
|
||||
<!-- Hybrid: external task with internal data -->
|
||||
<item cmd="*report"
|
||||
exec="{project-root}/bmad/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/bmad/research/templates/report.md">
|
||||
exec="{project-root}/{bmad_folder}/core/tasks/create-doc.md"
|
||||
tmpl="{project-root}/{bmad_folder}/research/templates/report.md">
|
||||
Generate Research Report
|
||||
</item>
|
||||
|
||||
@@ -721,7 +721,7 @@ For agents that primarily use embedded logic:
|
||||
|
||||
<item cmd="*analyze"
|
||||
action="perform statistical analysis on the provided data"
|
||||
data="{project-root}/bmad/_data/dataset.csv">
|
||||
data="{project-root}/{bmad_folder}/_data/dataset.csv">
|
||||
Analyze Dataset
|
||||
</item>
|
||||
|
||||
|
||||
@@ -8,10 +8,10 @@ BMAD agents come in three distinct types, each designed for different use cases
|
||||
|
||||
### Standalone Agents (Simple & Expert)
|
||||
|
||||
Live in their own dedicated directories under `bmad/agents/`:
|
||||
Live in their own dedicated directories under `{bmad_folder}/agents/`:
|
||||
|
||||
```
|
||||
bmad/agents/
|
||||
{bmad_folder}/agents/
|
||||
├── my-helper/ # Simple agent
|
||||
│ ├── my-helper.agent.yaml # Agent definition
|
||||
│ └── my-helper.md # Built XML (generated)
|
||||
@@ -28,10 +28,10 @@ bmad/agents/
|
||||
|
||||
### Module Agents
|
||||
|
||||
Part of a module system under `bmad/{module}/agents/`:
|
||||
Part of a module system under `{bmad_folder}/{module}/agents/`:
|
||||
|
||||
```
|
||||
bmad/bmm/agents/
|
||||
{bmad_folder}/bmm/agents/
|
||||
├── product-manager.agent.yaml
|
||||
├── product-manager.md # Built XML
|
||||
├── business-analyst.agent.yaml
|
||||
@@ -44,7 +44,7 @@ bmad/bmm/agents/
|
||||
|
||||
**Purpose:** Self-contained, standalone agents with embedded capabilities
|
||||
|
||||
**Location:** `bmad/agents/{agent-name}/`
|
||||
**Location:** `{bmad_folder}/agents/{agent-name}/`
|
||||
|
||||
**Characteristics:**
|
||||
|
||||
@@ -105,7 +105,7 @@ agent:
|
||||
|
||||
**Purpose:** Specialized agents with domain expertise and sidecar resources
|
||||
|
||||
**Location:** `bmad/agents/{agent-name}/` with sidecar directory
|
||||
**Location:** `{bmad_folder}/agents/{agent-name}/` with sidecar directory
|
||||
|
||||
**Characteristics:**
|
||||
|
||||
@@ -168,7 +168,7 @@ agent:
|
||||
**Complete Directory Structure:**
|
||||
|
||||
```
|
||||
bmad/agents/expert-agent/
|
||||
{bmad_folder}/agents/expert-agent/
|
||||
├── expert-agent.agent.yaml # Agent YAML source
|
||||
├── expert-agent.md # Built XML (generated)
|
||||
└── expert-agent-sidecar/ # Sidecar resources
|
||||
@@ -183,7 +183,7 @@ bmad/agents/expert-agent/
|
||||
|
||||
**Purpose:** Full-featured agents belonging to a module with access to workflows and resources
|
||||
|
||||
**Location:** `bmad/{module}/agents/`
|
||||
**Location:** `{bmad_folder}/{module}/agents/`
|
||||
|
||||
**Characteristics:**
|
||||
|
||||
@@ -216,20 +216,20 @@ agent:
|
||||
communication_style: '...'
|
||||
principles: ['...']
|
||||
critical_actions:
|
||||
- 'Load config from {project-root}/bmad/{module}/config.yaml'
|
||||
- 'Load config from {project-root}/{bmad_folder}/{module}/config.yaml'
|
||||
menu:
|
||||
- trigger: create-prd
|
||||
workflow: '{project-root}/bmad/bmm/workflows/prd/workflow.yaml'
|
||||
workflow: '{project-root}/{bmad_folder}/bmm/workflows/prd/workflow.yaml'
|
||||
description: 'Create PRD'
|
||||
- trigger: validate
|
||||
exec: '{project-root}/bmad/core/tasks/validate-workflow.xml'
|
||||
exec: '{project-root}/{bmad_folder}/core/tasks/validate-workflow.xml'
|
||||
description: 'Validate document'
|
||||
```
|
||||
|
||||
**XML Structure (built):**
|
||||
|
||||
```xml
|
||||
<agent id="bmad/bmm/agents/pm.md" name="John" title="Product Manager" icon="📋">
|
||||
<agent id="{bmad_folder}/bmm/agents/pm.md" name="John" title="Product Manager" icon="📋">
|
||||
<persona>
|
||||
<role>Product Management Expert</role>
|
||||
<identity>...</identity>
|
||||
@@ -237,12 +237,12 @@ agent:
|
||||
<principles>...</principles>
|
||||
</persona>
|
||||
<critical-actions>
|
||||
<i>Load config from {project-root}/bmad/{module}/config.yaml</i>
|
||||
<i>Load config from {project-root}/{bmad_folder}/{module}/config.yaml</i>
|
||||
</critical-actions>
|
||||
<menu>
|
||||
<item cmd="*help">Show numbered menu</item>
|
||||
<item cmd="*create-prd" run-workflow="{project-root}/bmad/bmm/workflows/prd/workflow.yaml">Create PRD</item>
|
||||
<item cmd="*validate" exec="{project-root}/bmad/core/tasks/validate-workflow.xml">Validate document</item>
|
||||
<item cmd="*create-prd" run-workflow="{project-root}/{bmad_folder}/bmm/workflows/prd/workflow.yaml">Create PRD</item>
|
||||
<item cmd="*validate" exec="{project-root}/{bmad_folder}/core/tasks/validate-workflow.xml">Validate document</item>
|
||||
<item cmd="*exit">Exit</item>
|
||||
</menu>
|
||||
</agent>
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
### Core Components
|
||||
|
||||
- [ ] `metadata.id` points to final compiled path: `bmad/{{module}}/agents/{{agent}}.md`
|
||||
- [ ] `metadata.id` points to final compiled path: `{bmad_folder}/{{module}}/agents/{{agent}}.md`
|
||||
- [ ] `metadata.module` matches the module folder (e.g., `bmm`, `bmb`, `cis`)
|
||||
- [ ] Principles are an array (preferred) or string with clear values
|
||||
|
||||
@@ -34,12 +34,12 @@
|
||||
|
||||
- [ ] `prompts` defined when using `action: "#id"`
|
||||
- [ ] `critical_actions` present if custom activation steps are needed
|
||||
- [ ] Customize file (if created) located at `{project-root}/bmad/_cfg/agents/{{module}}-{{agent}}.customize.yaml`
|
||||
- [ ] Customize file (if created) located at `{project-root}/{bmad_folder}/_cfg/agents/{{module}}-{{agent}}.customize.yaml`
|
||||
|
||||
## Build Verification
|
||||
|
||||
- [ ] Run compile to build `.md`: `npm run install:bmad` → "Compile Agents" (or `bmad install` → Compile)
|
||||
- [ ] Confirm compiled file exists at `{project-root}/bmad/{{module}}/agents/{{agent}}.md`
|
||||
- [ ] Confirm compiled file exists at `{project-root}/{bmad_folder}/{{module}}/agents/{{agent}}.md`
|
||||
|
||||
## Final Quality
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# Build Agent - Interactive Agent Builder Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/create-agent/workflow.yaml</critical>
|
||||
<critical>Study YAML agent examples in: {project-root}/bmad/bmm/agents/ for patterns</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmb/workflows/create-agent/workflow.yaml</critical>
|
||||
<critical>Study YAML agent examples in: {project-root}/{bmad_folder}/bmm/agents/ for patterns</critical>
|
||||
<critical>Communicate in {communication_language} throughout the agent creation process</critical>
|
||||
|
||||
<workflow>
|
||||
@@ -11,7 +11,7 @@
|
||||
<ask>Do you want to brainstorm agent ideas first? [y/n]</ask>
|
||||
|
||||
<check if="user answered yes">
|
||||
<action>Invoke brainstorming workflow: {project-root}/bmad/core/workflows/brainstorming/workflow.yaml</action>
|
||||
<action>Invoke brainstorming workflow: {project-root}/{bmad_folder}/core/workflows/brainstorming/workflow.yaml</action>
|
||||
<action>Pass context data: {installed_path}/brainstorm-context.md</action>
|
||||
<action>Wait for brainstorming session completion</action>
|
||||
<action>Use brainstorming output to inform agent identity and persona development in following steps</action>
|
||||
@@ -51,19 +51,19 @@
|
||||
<check if="module agent selected">
|
||||
<action>Discover which module system fits best (bmm, bmb, cis, or custom)</action>
|
||||
<action>Store as {{target_module}} for path determination</action>
|
||||
<note>Agent will be saved to: bmad/{{target_module}}/agents/</note>
|
||||
<note>Agent will be saved to: {bmad_folder}/{{target_module}}/agents/</note>
|
||||
</check>
|
||||
|
||||
<check if="standalone agent selected">
|
||||
<action>Explain this will be their personal agent, not tied to a module</action>
|
||||
<note>Agent will be saved to: bmad/agents/{{agent-name}}/</note>
|
||||
<note>Agent will be saved to: {bmad_folder}/agents/{{agent-name}}/</note>
|
||||
<note>All sidecar files will be in the same folder</note>
|
||||
</check>
|
||||
|
||||
<critical>Determine agent location:</critical>
|
||||
|
||||
- Module Agent → bmad/{{module}}/agents/{{agent-name}}.agent.yaml
|
||||
- Standalone Agent → bmad/agents/{{agent-name}}/{{agent-name}}.agent.yaml
|
||||
- Module Agent → {bmad_folder}/{{module}}/agents/{{agent-name}}.agent.yaml
|
||||
- Standalone Agent → {bmad_folder}/agents/{{agent-name}}/{{agent-name}}.agent.yaml
|
||||
|
||||
<note>Keep agent naming/identity details for later - let them emerge naturally through the creation process</note>
|
||||
|
||||
@@ -197,8 +197,8 @@ menu:
|
||||
# For cross-module workflow references (advanced):
|
||||
|
||||
- trigger: [another capability]
|
||||
workflow: "{project-root}/bmad/SOURCE_MODULE/workflows/path/to/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/THIS_MODULE/workflows/vendored/path/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/SOURCE_MODULE/workflows/path/to/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/THIS_MODULE/workflows/vendored/path/workflow.yaml"
|
||||
description: [description]
|
||||
|
||||
`````
|
||||
@@ -238,7 +238,7 @@ This is typically used when creating specialized modules that reuse common workf
|
||||
<example type="yaml">
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/{{target_module}}/agents/{{agent_filename}}.md
|
||||
id: {bmad_folder}/{{target_module}}/agents/{{agent_filename}}.md
|
||||
name: {{agent_name}} # The name chosen together
|
||||
title: {{agent_title}} # From the role that emerged
|
||||
icon: {{agent_icon}} # The perfect emoji
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Interactive workflow to build BMAD Core compliant agents (YAML sou
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/bmad/bmb/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
|
||||
custom_agent_location: "{config_source}:custom_agent_location"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -17,22 +17,22 @@ communication_styles: "{installed_path}/communication-styles.md"
|
||||
|
||||
# Optional docs that help understand agent patterns
|
||||
recommended_inputs:
|
||||
- example_agents: "{project-root}/bmad/bmm/agents/"
|
||||
- example_agents: "{project-root}/{bmad_folder}/bmm/agents/"
|
||||
- agent_activation_rules: "{project-root}/src/utility/models/agent-activation-ide.xml"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmb/workflows/create-agent"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmb/workflows/create-agent"
|
||||
template: false # This is an interactive workflow - no template needed
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
# Output configuration - YAML agents compiled to .md at install time
|
||||
# Module agents: Save to bmad/{{target_module}}/agents/
|
||||
# Module agents: Save to {bmad_folder}/{{target_module}}/agents/
|
||||
# Standalone agents: Save to custom_agent_location/
|
||||
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_file: "{custom_agent_location}/{{agent_filename}}.agent.yaml"
|
||||
# Optional user override file (auto-created by installer if missing)
|
||||
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"
|
||||
|
||||
standalone: true
|
||||
|
||||
@@ -41,9 +41,9 @@ web_bundle:
|
||||
description: "Interactive workflow to build BMAD Core compliant agents (simple, expert, or module types) with optional brainstorming for agent ideas, proper persona development, activation rules, and command structure"
|
||||
author: "BMad"
|
||||
web_bundle_files:
|
||||
- "bmad/bmb/workflows/create-agent/instructions.md"
|
||||
- "bmad/bmb/workflows/create-agent/checklist.md"
|
||||
- "bmad/bmb/workflows/create-agent/agent-types.md"
|
||||
- "bmad/bmb/workflows/create-agent/agent-architecture.md"
|
||||
- "bmad/bmb/workflows/create-agent/agent-command-patterns.md"
|
||||
- "bmad/bmb/workflows/create-agent/communication-styles.md"
|
||||
- "{bmad_folder}/bmb/workflows/create-agent/instructions.md"
|
||||
- "{bmad_folder}/bmb/workflows/create-agent/checklist.md"
|
||||
- "{bmad_folder}/bmb/workflows/create-agent/agent-types.md"
|
||||
- "{bmad_folder}/bmb/workflows/create-agent/agent-architecture.md"
|
||||
- "{bmad_folder}/bmb/workflows/create-agent/agent-command-patterns.md"
|
||||
- "{bmad_folder}/bmb/workflows/create-agent/communication-styles.md"
|
||||
|
||||
@@ -71,7 +71,7 @@ workflow create-module --input module-brief-{name}-{date}.md
|
||||
### Generated Directory
|
||||
|
||||
```
|
||||
bmad/{module-code}/
|
||||
{bmad_folder}/{module-code}/
|
||||
├── agents/ # Agent definitions
|
||||
├── workflows/ # Workflow processes
|
||||
├── tasks/ # Reusable tasks
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
|
||||
## Directory Structure
|
||||
|
||||
### Source Directories (bmad/{module-code}/)
|
||||
### Source Directories ({bmad_folder}/{module-code}/)
|
||||
|
||||
- [ ] `/agents` directory created (even if empty)
|
||||
- [ ] `/workflows` directory created (even if empty)
|
||||
|
||||
@@ -80,7 +80,7 @@ prompt:
|
||||
|
||||
# EXAMPLE: Static path
|
||||
# module_data_path:
|
||||
# result: "{project-root}/bmad/{{MODULE_CODE}}/data"
|
||||
# result: "{project-root}/{bmad_folder}/{{MODULE_CODE}}/data"
|
||||
|
||||
# ============================================================================
|
||||
# YOUR MODULE CONFIGURATION FIELDS
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# Build Module - Interactive Module Builder Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/create-module/workflow.yaml</critical>
|
||||
<critical>Study existing modules in: {project-root}/bmad/ for patterns</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmb/workflows/create-module/workflow.yaml</critical>
|
||||
<critical>Study existing modules in: {project-root}/{bmad_folder}/ for patterns</critical>
|
||||
<critical>Communicate in {communication_language} throughout the module creation process</critical>
|
||||
|
||||
<workflow>
|
||||
@@ -28,7 +28,7 @@
|
||||
<ask>Do you have a module brief or should we create one? [have/create/skip]</ask>
|
||||
|
||||
<check if="create">
|
||||
<action>Invoke module-brief workflow: {project-root}/bmad/bmb/workflows/module-brief/workflow.yaml</action>
|
||||
<action>Invoke module-brief workflow: {project-root}/{bmad_folder}/bmb/workflows/module-brief/workflow.yaml</action>
|
||||
<action>Wait for module brief completion</action>
|
||||
<action>Load the module brief to use as blueprint</action>
|
||||
</check>
|
||||
@@ -64,7 +64,7 @@
|
||||
2. **Module code** - Generate kebab-case from name following patterns:
|
||||
- Multi-word descriptive names → shortened kebab-case
|
||||
- Domain-specific terms → recognizable abbreviations
|
||||
- Present suggested code and confirm it works for paths like bmad/{{code}}/agents/
|
||||
- Present suggested code and confirm it works for paths like {bmad_folder}/{{code}}/agents/
|
||||
3. **Module purpose** - Refine their description into 1-2 clear sentences
|
||||
4. **Target audience** - Infer from context or ask if unclear
|
||||
|
||||
@@ -322,7 +322,7 @@ prompt:
|
||||
|
||||
# EXAMPLE Static path:
|
||||
# data_path:
|
||||
# result: "{project-root}/bmad/{{module_code}}/data"
|
||||
# result: "{project-root}/{bmad_folder}/{{module_code}}/data"
|
||||
|
||||
{{generated_config_fields_from_step_4}}
|
||||
```
|
||||
@@ -446,7 +446,7 @@ bmad install {{module_code}}
|
||||
|
||||
## Configuration
|
||||
|
||||
The module can be configured in `bmad/{{module_code}}/config.yaml`
|
||||
The module can be configured in `{bmad_folder}/{{module_code}}/config.yaml`
|
||||
|
||||
Key settings:
|
||||
{{configuration_options}}
|
||||
|
||||
@@ -24,7 +24,7 @@ src/modules/{module-code}/
|
||||
└── README.md # Module documentation
|
||||
|
||||
# INSTALLED MODULE (in target project)
|
||||
{project-root}/bmad/{module-code}/
|
||||
{project-root}/{bmad_folder}/{module-code}/
|
||||
├── agents/ # Compiled agent files (.md)
|
||||
├── workflows/ # Workflow instances
|
||||
├── tasks/ # Task files
|
||||
@@ -145,8 +145,8 @@ For modules that need workflows from other modules but want to remain standalone
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: command-name
|
||||
workflow: '{project-root}/bmad/SOURCE_MODULE/workflows/path/workflow.yaml'
|
||||
workflow-install: '{project-root}/bmad/THIS_MODULE/workflows/vendored/workflow.yaml'
|
||||
workflow: '{project-root}/{bmad_folder}/SOURCE_MODULE/workflows/path/workflow.yaml'
|
||||
workflow-install: '{project-root}/{bmad_folder}/THIS_MODULE/workflows/vendored/workflow.yaml'
|
||||
description: 'Command description'
|
||||
```
|
||||
|
||||
@@ -216,7 +216,7 @@ module_version:
|
||||
result: '1.0.0'
|
||||
|
||||
data_path:
|
||||
result: '{project-root}/bmad/module-code/data'
|
||||
result: '{project-root}/{bmad_folder}/module-code/data'
|
||||
```
|
||||
|
||||
**Key Points:**
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Interactive workflow to build complete BMAD modules with agents, w
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/bmad/bmb/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
|
||||
custom_module_location: "{config_source}:custom_module_location"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
user_name: "{config_source}:user_name"
|
||||
@@ -14,22 +14,22 @@ module_structure_guide: "{installed_path}/module-structure.md"
|
||||
installer_templates: "{installed_path}/installer-templates/"
|
||||
|
||||
# Use existing build workflows
|
||||
agent_builder: "{project-root}/bmad/bmb/workflows/create-agent/workflow.yaml"
|
||||
workflow_builder: "{project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml"
|
||||
brainstorming_workflow: "{project-root}/bmad/core/workflows/brainstorming/workflow.yaml"
|
||||
agent_builder: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/workflow.yaml"
|
||||
workflow_builder: "{project-root}/{bmad_folder}/bmb/workflows/create-workflow/workflow.yaml"
|
||||
brainstorming_workflow: "{project-root}/{bmad_folder}/core/workflows/brainstorming/workflow.yaml"
|
||||
brainstorming_context: "{installed_path}/brainstorm-context.md"
|
||||
|
||||
# Optional docs that help understand module patterns
|
||||
recommended_inputs:
|
||||
- module_brief: "{output_folder}/module-brief-*.md"
|
||||
- brainstorming_results: "{output_folder}/brainstorming-*.md"
|
||||
- bmm_module: "{project-root}/bmad/bmm/"
|
||||
- cis_module: "{project-root}/bmad/cis/"
|
||||
- existing_agents: "{project-root}/bmad/*/agents/"
|
||||
- existing_workflows: "{project-root}/bmad/*/workflows/"
|
||||
- bmm_module: "{project-root}/{bmad_folder}/bmm/"
|
||||
- cis_module: "{project-root}/{bmad_folder}/cis/"
|
||||
- existing_agents: "{project-root}/{bmad_folder}/*/agents/"
|
||||
- existing_workflows: "{project-root}/{bmad_folder}/*/workflows/"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmb/workflows/create-module"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmb/workflows/create-module"
|
||||
template: false # This is an interactive scaffolding workflow
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
@@ -159,7 +159,7 @@ The brainstorming phase invokes the CIS brainstorming workflow to:
|
||||
### Generated Workflow Folder
|
||||
|
||||
Creates a complete workflow folder at:
|
||||
`{project-root}/bmad/{{target_module}}/workflows/{{workflow_name}}/`
|
||||
`{project-root}/{bmad_folder}/{{target_module}}/workflows/{{workflow_name}}/`
|
||||
|
||||
### Files Created
|
||||
|
||||
@@ -267,9 +267,9 @@ To modify this workflow:
|
||||
|
||||
For issues or questions:
|
||||
|
||||
- Review `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||
- Check existing workflows in `/bmad/bmm/workflows/` for examples
|
||||
- Validate against `/bmad/bmb/workflows/create-workflow/checklist.md`
|
||||
- Review `/{bmad_folder}/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||
- Check existing workflows in `/{bmad_folder}/bmm/workflows/` for examples
|
||||
- Validate against `/{bmad_folder}/bmb/workflows/create-workflow/checklist.md`
|
||||
- Consult BMAD Method v6 documentation
|
||||
|
||||
---
|
||||
|
||||
@@ -61,7 +61,7 @@
|
||||
|
||||
- [ ] web_bundle section present if needed
|
||||
- [ ] Name, description, author copied from main config
|
||||
- [ ] All file paths converted to bmad/-relative format
|
||||
- [ ] All file paths converted to {bmad_folder}/-relative format
|
||||
- [ ] NO {config_source} variables in web bundle
|
||||
- [ ] NO {project-root} prefixes in paths
|
||||
- [ ] Instructions path listed correctly
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Build Workflow - Workflow Builder Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmb/workflows/create-workflow/workflow.yaml</critical>
|
||||
<critical>You MUST fully understand the workflow creation guide at: {workflow_creation_guide}</critical>
|
||||
<critical>Study the guide thoroughly to follow ALL conventions for optimal human-AI collaboration</critical>
|
||||
<critical>Communicate in {communication_language} throughout the workflow creation process</critical>
|
||||
@@ -13,7 +13,7 @@
|
||||
|
||||
<action if="user_response == 'y' or user_response == 'yes'">
|
||||
Invoke brainstorming workflow to explore ideas and design concepts:
|
||||
- Workflow: {project-root}/bmad/core/workflows/brainstorming/workflow.yaml
|
||||
- Workflow: {project-root}/{bmad_folder}/core/workflows/brainstorming/workflow.yaml
|
||||
- Context data: {installed_path}/brainstorm-context.md
|
||||
- Purpose: Generate creative workflow ideas, explore different approaches, and clarify requirements
|
||||
|
||||
@@ -255,7 +255,7 @@ Include:
|
||||
|
||||
```yaml
|
||||
# Critical variables from config
|
||||
config_source: '{project-root}/bmad/{{target_module}}/config.yaml'
|
||||
config_source: '{project-root}/{bmad_folder}/{{target_module}}/config.yaml'
|
||||
output_folder: '{config_source}:output_folder'
|
||||
user_name: '{config_source}:user_name'
|
||||
communication_language: '{config_source}:communication_language'
|
||||
@@ -277,13 +277,13 @@ name: 'workflow-name'
|
||||
description: 'Clear purpose statement'
|
||||
|
||||
# Paths
|
||||
installed_path: '{project-root}/bmad/module/workflows/name'
|
||||
installed_path: '{project-root}/{bmad_folder}/module/workflows/name'
|
||||
template: '{installed_path}/template.md'
|
||||
instructions: '{installed_path}/instructions.md'
|
||||
validation: '{installed_path}/checklist.md'
|
||||
|
||||
# Critical variables from config
|
||||
config_source: '{project-root}/bmad/module/config.yaml'
|
||||
config_source: '{project-root}/{bmad_folder}/module/config.yaml'
|
||||
output_folder: '{config_source}:output_folder'
|
||||
user_name: '{config_source}:user_name'
|
||||
communication_language: '{config_source}:communication_language'
|
||||
@@ -314,7 +314,7 @@ Load and use the template at: {template_instructions}
|
||||
Generate the instructions.md file following the workflow creation guide:
|
||||
|
||||
1. ALWAYS include critical headers:
|
||||
- Workflow engine reference: {project-root}/bmad/core/tasks/workflow.xml
|
||||
- Workflow engine reference: {project-root}/{bmad_folder}/core/tasks/workflow.xml
|
||||
- workflow.yaml reference: must be loaded and processed
|
||||
|
||||
2. Structure with <workflow> tags containing all steps
|
||||
@@ -328,7 +328,7 @@ Generate the instructions.md file following the workflow creation guide:
|
||||
|
||||
4. Use proper XML tags from guide:
|
||||
- Execution: <action>, <check>, <ask>, <goto>, <invoke-workflow>
|
||||
- Output: <template-output>, <invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>, <critical>, <example>
|
||||
- Output: <template-output>, <invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>, <critical>, <example>
|
||||
- Flow: <loop>, <break>, <continue>
|
||||
|
||||
5. Best practices from guide:
|
||||
@@ -616,15 +616,15 @@ If yes:
|
||||
|
||||
- Web bundles are self-contained and cannot use config_source variables
|
||||
- All files must be explicitly listed in web_bundle_files
|
||||
- File paths use bmad/ root (not {project-root})
|
||||
- File paths use {bmad_folder}/ root (not {project-root})
|
||||
|
||||
<action>Configure web_bundle section in workflow.yaml:</action>
|
||||
|
||||
1. Copy core workflow metadata (name, description, author)
|
||||
2. Convert all file paths to bmad/-relative paths:
|
||||
2. Convert all file paths to {bmad_folder}/-relative paths:
|
||||
- Remove {project-root}/ prefix
|
||||
- Remove {config_source} references (use hardcoded values)
|
||||
- Example: "{project-root}/bmad/bmm/workflows/x" → "bmad/bmm/workflows/x"
|
||||
- Example: "{project-root}/{bmad_folder}/bmm/workflows/x" → "{bmad_folder}/bmm/workflows/x"
|
||||
|
||||
3. List ALL referenced files by scanning:
|
||||
|
||||
@@ -642,8 +642,8 @@ If yes:
|
||||
|
||||
**Critical: Workflow Dependencies**
|
||||
- If instructions call another workflow, that workflow's yaml MUST be in web_bundle_files
|
||||
- Example: `<invoke-workflow>{project-root}/bmad/core/workflows/x/workflow.yaml</invoke-workflow>`
|
||||
→ Add "bmad/core/workflows/x/workflow.yaml" to web_bundle_files
|
||||
- Example: `<invoke-workflow>{project-root}/{bmad_folder}/core/workflows/x/workflow.yaml</invoke-workflow>`
|
||||
→ Add "{bmad_folder}/core/workflows/x/workflow.yaml" to web_bundle_files
|
||||
|
||||
4. Create web_bundle_files array with complete list
|
||||
|
||||
@@ -654,24 +654,24 @@ web_bundle:
|
||||
name: '{workflow_name}'
|
||||
description: '{workflow_description}'
|
||||
author: '{author}'
|
||||
instructions: 'bmad/{module}/workflows/{workflow}/instructions.md'
|
||||
validation: 'bmad/{module}/workflows/{workflow}/checklist.md'
|
||||
template: 'bmad/{module}/workflows/{workflow}/template.md'
|
||||
instructions: '{bmad_folder}/{module}/workflows/{workflow}/instructions.md'
|
||||
validation: '{bmad_folder}/{module}/workflows/{workflow}/checklist.md'
|
||||
template: '{bmad_folder}/{module}/workflows/{workflow}/template.md'
|
||||
|
||||
# Any data files (no config_source)
|
||||
data_file: 'bmad/{module}/workflows/{workflow}/data.csv'
|
||||
data_file: '{bmad_folder}/{module}/workflows/{workflow}/data.csv'
|
||||
|
||||
web_bundle_files:
|
||||
- 'bmad/{module}/workflows/{workflow}/instructions.md'
|
||||
- 'bmad/{module}/workflows/{workflow}/checklist.md'
|
||||
- 'bmad/{module}/workflows/{workflow}/template.md'
|
||||
- 'bmad/{module}/workflows/{workflow}/data.csv'
|
||||
- '{bmad_folder}/{module}/workflows/{workflow}/instructions.md'
|
||||
- '{bmad_folder}/{module}/workflows/{workflow}/checklist.md'
|
||||
- '{bmad_folder}/{module}/workflows/{workflow}/template.md'
|
||||
- '{bmad_folder}/{module}/workflows/{workflow}/data.csv'
|
||||
# Add every single file referenced anywhere
|
||||
|
||||
# CRITICAL: If this workflow invokes other workflows, use existing_workflows
|
||||
# This signals the bundler to recursively include those workflows' web_bundles
|
||||
existing_workflows:
|
||||
- workflow_variable_name: 'bmad/path/to/workflow.yaml'
|
||||
- workflow_variable_name: '{bmad_folder}/path/to/workflow.yaml'
|
||||
```
|
||||
|
||||
**Example with existing_workflows:**
|
||||
@@ -681,14 +681,14 @@ web_bundle:
|
||||
name: 'brainstorm-game'
|
||||
description: 'Game brainstorming with CIS workflow'
|
||||
author: 'BMad'
|
||||
instructions: 'bmad/bmm/workflows/brainstorm-game/instructions.md'
|
||||
instructions: '{bmad_folder}/bmm/workflows/brainstorm-game/instructions.md'
|
||||
template: false
|
||||
web_bundle_files:
|
||||
- 'bmad/bmm/workflows/brainstorm-game/instructions.md'
|
||||
- 'bmad/mmm/workflows/brainstorm-game/game-context.md'
|
||||
- 'bmad/core/workflows/brainstorming/workflow.yaml'
|
||||
- '{bmad_folder}/bmm/workflows/brainstorm-game/instructions.md'
|
||||
- '{bmad_folder}/mmm/workflows/brainstorm-game/game-context.md'
|
||||
- '{bmad_folder}/core/workflows/brainstorming/workflow.yaml'
|
||||
existing_workflows:
|
||||
- core_brainstorming: 'bmad/core/workflows/brainstorming/workflow.yaml'
|
||||
- core_brainstorming: '{bmad_folder}/core/workflows/brainstorming/workflow.yaml'
|
||||
```
|
||||
|
||||
**What existing_workflows does:**
|
||||
@@ -696,13 +696,13 @@ web_bundle:
|
||||
- Tells the bundler this workflow invokes another workflow
|
||||
- Bundler recursively includes the invoked workflow's entire web_bundle
|
||||
- Essential for meta-workflows that orchestrate other workflows
|
||||
- Maps workflow variable names to their bmad/-relative paths
|
||||
- Maps workflow variable names to their {bmad_folder}/-relative paths
|
||||
|
||||
<action>Validate web bundle completeness:</action>
|
||||
|
||||
- Ensure no {config_source} variables remain
|
||||
- Verify all file paths are listed
|
||||
- Check that paths are bmad/-relative
|
||||
- Check that paths are {bmad_folder}/-relative
|
||||
- If workflow uses <invoke-workflow>, add to existing_workflows
|
||||
|
||||
<template-output>web_bundle_config</template-output>
|
||||
|
||||
@@ -25,7 +25,7 @@ Create a folder with these files:
|
||||
# workflow.yaml (REQUIRED)
|
||||
name: 'my-workflow'
|
||||
description: 'What this workflow does'
|
||||
installed_path: '{project-root}/bmad/module/workflows/my-workflow'
|
||||
installed_path: '{project-root}/{bmad_folder}/module/workflows/my-workflow'
|
||||
template: '{installed_path}/template.md'
|
||||
instructions: '{installed_path}/instructions.md'
|
||||
default_output_file: '{output_folder}/output.md'
|
||||
@@ -44,7 +44,7 @@ standalone: true
|
||||
```markdown
|
||||
# instructions.md
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project_root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: workflow.yaml</critical>
|
||||
|
||||
<workflow>
|
||||
@@ -61,13 +61,13 @@ That's it! To execute, tell the BMAD agent: `workflow path/to/my-workflow/`
|
||||
|
||||
### Tasks vs Workflows
|
||||
|
||||
| Aspect | Task | Workflow |
|
||||
| -------------- | ------------------ | ----------------------- |
|
||||
| **Purpose** | Single operation | Multi-step process |
|
||||
| **Format** | XML | Folder with YAML config |
|
||||
| **Location** | `/src/core/tasks/` | `/bmad/*/workflows/` |
|
||||
| **User Input** | Minimal | Extensive |
|
||||
| **Output** | Variable | Usually documents |
|
||||
| Aspect | Task | Workflow |
|
||||
| -------------- | ------------------ | ----------------------------- |
|
||||
| **Purpose** | Single operation | Multi-step process |
|
||||
| **Format** | XML | Folder with YAML config |
|
||||
| **Location** | `/src/core/tasks/` | `/{bmad_folder}/*/workflows/` |
|
||||
| **User Input** | Minimal | Extensive |
|
||||
| **Output** | Variable | Usually documents |
|
||||
|
||||
### Workflow Types
|
||||
|
||||
@@ -104,7 +104,7 @@ name: 'workflow-name'
|
||||
description: 'Clear purpose statement'
|
||||
|
||||
# Paths
|
||||
installed_path: '{project-root}/bmad/module/workflows/name'
|
||||
installed_path: '{project-root}/{bmad_folder}/module/workflows/name'
|
||||
template: '{installed_path}/template.md' # or false
|
||||
instructions: '{installed_path}/instructions.md' # or false
|
||||
validation: '{installed_path}/checklist.md' # optional
|
||||
@@ -641,7 +641,7 @@ the technology stack recommendations. Please choose: web, mobile, or desktop.</a
|
||||
```markdown
|
||||
# instructions.md
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project_root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: workflow.yaml</critical>
|
||||
|
||||
<workflow>
|
||||
@@ -855,7 +855,7 @@ _Generated on {{date}}_
|
||||
**Output:**
|
||||
|
||||
- `<template-output>` - Save checkpoint
|
||||
- `<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>` - Trigger AI enhancement
|
||||
- `<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>` - Trigger AI enhancement
|
||||
- `<critical>` - Important info
|
||||
- `<example>` - Show example
|
||||
|
||||
@@ -904,7 +904,7 @@ _Generated on {{date}}_
|
||||
<step n="2" goal="Define requirements">
|
||||
Create functional and non-functional requirements.
|
||||
<template-output>requirements</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Validate">
|
||||
@@ -1194,7 +1194,7 @@ Web bundles allow workflows to be deployed as self-contained packages for web en
|
||||
1. **Self-Contained**: No external dependencies
|
||||
2. **No Config Variables**: Cannot use `{config_source}` references
|
||||
3. **Complete File List**: Every referenced file must be listed
|
||||
4. **Relative Paths**: Use `bmad/` root paths (no `{project-root}`)
|
||||
4. **Relative Paths**: Use `{bmad_folder}/` root paths (no `{project-root}`)
|
||||
|
||||
### Creating a Web Bundle
|
||||
|
||||
@@ -1206,20 +1206,20 @@ web_bundle:
|
||||
description: 'Workflow description'
|
||||
author: 'Your Name'
|
||||
|
||||
# Core files (bmad/-relative paths)
|
||||
instructions: 'bmad/module/workflows/workflow/instructions.md'
|
||||
validation: 'bmad/module/workflows/workflow/checklist.md'
|
||||
template: 'bmad/module/workflows/workflow/template.md'
|
||||
# Core files ({bmad_folder}/-relative paths)
|
||||
instructions: '{bmad_folder}/module/workflows/workflow/instructions.md'
|
||||
validation: '{bmad_folder}/module/workflows/workflow/checklist.md'
|
||||
template: '{bmad_folder}/module/workflows/workflow/template.md'
|
||||
|
||||
# Data files (no config_source allowed)
|
||||
data_file: 'bmad/module/workflows/workflow/data.csv'
|
||||
data_file: '{bmad_folder}/module/workflows/workflow/data.csv'
|
||||
|
||||
# Complete file list - CRITICAL!
|
||||
web_bundle_files:
|
||||
- 'bmad/module/workflows/workflow/instructions.md'
|
||||
- 'bmad/module/workflows/workflow/checklist.md'
|
||||
- 'bmad/module/workflows/workflow/template.md'
|
||||
- 'bmad/module/workflows/workflow/data.csv'
|
||||
- '{bmad_folder}/module/workflows/workflow/instructions.md'
|
||||
- '{bmad_folder}/module/workflows/workflow/checklist.md'
|
||||
- '{bmad_folder}/module/workflows/workflow/template.md'
|
||||
- '{bmad_folder}/module/workflows/workflow/data.csv'
|
||||
# Include ALL referenced files
|
||||
```
|
||||
|
||||
@@ -1227,7 +1227,7 @@ web_bundle:
|
||||
|
||||
1. **Remove Config Dependencies**:
|
||||
- Replace `{config_source}:variable` with hardcoded values
|
||||
- Convert `{project-root}/bmad/` to `bmad/`
|
||||
- Convert `{project-root}/{bmad_folder}/` to `{bmad_folder}/`
|
||||
|
||||
2. **Inventory All Files**:
|
||||
- Scan instructions.md for file references
|
||||
@@ -1236,7 +1236,7 @@ web_bundle:
|
||||
|
||||
3. **Test Completeness**:
|
||||
- Ensure no missing file references
|
||||
- Verify all paths are relative to bmad/
|
||||
- Verify all paths are relative to {bmad_folder}/
|
||||
|
||||
### Example: Complete Web Bundle
|
||||
|
||||
@@ -1246,37 +1246,37 @@ web_bundle:
|
||||
description: 'Requirements analysis workflow'
|
||||
author: 'BMad Team'
|
||||
|
||||
instructions: 'bmad/bmm/workflows/analyze-requirements/instructions.md'
|
||||
validation: 'bmad/bmm/workflows/analyze-requirements/checklist.md'
|
||||
template: 'bmad/bmm/workflows/analyze-requirements/template.md'
|
||||
instructions: '{bmad_folder}/bmm/workflows/analyze-requirements/instructions.md'
|
||||
validation: '{bmad_folder}/bmm/workflows/analyze-requirements/checklist.md'
|
||||
template: '{bmad_folder}/bmm/workflows/analyze-requirements/template.md'
|
||||
|
||||
# Data files
|
||||
techniques_data: 'bmad/bmm/workflows/analyze-requirements/techniques.csv'
|
||||
patterns_data: 'bmad/bmm/workflows/analyze-requirements/patterns.json'
|
||||
techniques_data: '{bmad_folder}/bmm/workflows/analyze-requirements/techniques.csv'
|
||||
patterns_data: '{bmad_folder}/bmm/workflows/analyze-requirements/patterns.json'
|
||||
|
||||
# Sub-workflow reference
|
||||
validation_workflow: 'bmad/bmm/workflows/validate-requirements/workflow.yaml'
|
||||
validation_workflow: '{bmad_folder}/bmm/workflows/validate-requirements/workflow.yaml'
|
||||
|
||||
standalone: true
|
||||
|
||||
web_bundle_files:
|
||||
# Core workflow files
|
||||
- 'bmad/bmm/workflows/analyze-requirements/instructions.md'
|
||||
- 'bmad/bmm/workflows/analyze-requirements/checklist.md'
|
||||
- 'bmad/bmm/workflows/analyze-requirements/template.md'
|
||||
- '{bmad_folder}/bmm/workflows/analyze-requirements/instructions.md'
|
||||
- '{bmad_folder}/bmm/workflows/analyze-requirements/checklist.md'
|
||||
- '{bmad_folder}/bmm/workflows/analyze-requirements/template.md'
|
||||
|
||||
# Data files
|
||||
- 'bmad/bmm/workflows/analyze-requirements/techniques.csv'
|
||||
- 'bmad/bmm/workflows/analyze-requirements/patterns.json'
|
||||
- '{bmad_folder}/bmm/workflows/analyze-requirements/techniques.csv'
|
||||
- '{bmad_folder}/bmm/workflows/analyze-requirements/patterns.json'
|
||||
|
||||
# Sub-workflow and its files
|
||||
- 'bmad/bmm/workflows/validate-requirements/workflow.yaml'
|
||||
- 'bmad/bmm/workflows/validate-requirements/instructions.md'
|
||||
- 'bmad/bmm/workflows/validate-requirements/checklist.md'
|
||||
- '{bmad_folder}/bmm/workflows/validate-requirements/workflow.yaml'
|
||||
- '{bmad_folder}/bmm/workflows/validate-requirements/instructions.md'
|
||||
- '{bmad_folder}/bmm/workflows/validate-requirements/checklist.md'
|
||||
|
||||
# Shared templates referenced in instructions
|
||||
- 'bmad/bmm/templates/requirement-item.md'
|
||||
- 'bmad/bmm/templates/validation-criteria.md'
|
||||
- '{bmad_folder}/bmm/templates/requirement-item.md'
|
||||
- '{bmad_folder}/bmm/templates/validation-criteria.md'
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
@@ -1305,4 +1305,4 @@ web_bundle:
|
||||
_For implementation details, see:_
|
||||
|
||||
- `/src/core/tasks/workflow.xml` - Execution engine
|
||||
- `/bmad/bmm/workflows/` - Production examples
|
||||
- `/{bmad_folder}/bmm/workflows/` - Production examples
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# PRD Workflow Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-related}/bmad/{module-code}/workflows/{workflow}/workflow.yaml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-related}/{bmad_folder}/{module-code}/workflows/{workflow}/workflow.yaml</critical>
|
||||
<critical>Communicate in {communication_language} throughout the workflow process</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
@@ -20,7 +20,7 @@ recommended_inputs: # optional, can be omitted
|
||||
- example_input: "{project-root}/{path/to/file.md}"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/{module-code}/workflows/{workflow-code}"
|
||||
installed_path: "{project-root}/{bmad_folder}/{module-code}/workflows/{workflow-code}"
|
||||
template: "{installed_path}/template.md" # optional, can be omitted
|
||||
instructions: "{installed_path}/instructions.md" # optional, can be omitted
|
||||
validation: "{installed_path}/checklist.md" # optional, can be omitted
|
||||
@@ -43,23 +43,23 @@ web_bundle: #optional, can be omitted
|
||||
description: "{WORKFLOW_DESCRIPTION}"
|
||||
author: "BMad"
|
||||
|
||||
# Core workflow files (paths relative to bmad/ root)
|
||||
instructions: "bmad/{module-code}/workflows/{workflow-code}/instructions.md"
|
||||
validation: "bmad/{module-code}/workflows/{workflow-code}/checklist.md"
|
||||
template: "bmad/{module-code}/workflows/{workflow-code}/template.md" # if document workflow
|
||||
# Core workflow files (paths relative to {bmad_folder}/ root)
|
||||
instructions: "{bmad_folder}/{module-code}/workflows/{workflow-code}/instructions.md"
|
||||
validation: "{bmad_folder}/{module-code}/workflows/{workflow-code}/checklist.md"
|
||||
template: "{bmad_folder}/{module-code}/workflows/{workflow-code}/template.md" # if document workflow
|
||||
|
||||
# Reference any data files or additional workflows (no config_source allowed)
|
||||
# brain_techniques: "bmad/{module-code}/workflows/{workflow-code}/data-file.csv"
|
||||
# sub_workflow: "bmad/{module-code}/workflows/other-workflow/workflow.yaml"
|
||||
# brain_techniques: "{bmad_folder}/{module-code}/workflows/{workflow-code}/data-file.csv"
|
||||
# sub_workflow: "{bmad_folder}/{module-code}/workflows/other-workflow/workflow.yaml"
|
||||
|
||||
# CRITICAL: List ALL files used by this workflow
|
||||
# This includes instructions, validation, templates, data files,
|
||||
# and any files referenced within those files
|
||||
web_bundle_files:
|
||||
- "bmad/{module-code}/workflows/{workflow-code}/instructions.md"
|
||||
- "bmad/{module-code}/workflows/{workflow-code}/checklist.md"
|
||||
- "bmad/{module-code}/workflows/{workflow-code}/template.md"
|
||||
- "{bmad_folder}/{module-code}/workflows/{workflow-code}/instructions.md"
|
||||
- "{bmad_folder}/{module-code}/workflows/{workflow-code}/checklist.md"
|
||||
- "{bmad_folder}/{module-code}/workflows/{workflow-code}/template.md"
|
||||
# Add ALL referenced files here - examine instructions.md and template.md
|
||||
# for any file paths and include them all
|
||||
# - "bmad/{module-code}/workflows/{workflow-code}/data/example.csv"
|
||||
# - "bmad/{module-code}/templates/shared-template.md"
|
||||
# - "{bmad_folder}/{module-code}/workflows/{workflow-code}/data/example.csv"
|
||||
# - "{bmad_folder}/{module-code}/templates/shared-template.md"
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Interactive workflow builder that guides creation of new BMAD work
|
||||
author: "BMad Builder"
|
||||
|
||||
# Critical variables
|
||||
config_source: "{project-root}/bmad/bmb/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
|
||||
custom_workflow_location: "{config_source}:custom_workflow_location"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -17,11 +17,11 @@ template_checklist: "{workflow_template_path}/checklist.md"
|
||||
|
||||
# Optional input docs
|
||||
recommended_inputs:
|
||||
- existing_workflows: "{project-root}/bmad/*/workflows/"
|
||||
- bmm_workflows: "{project-root}/bmad/bmm/workflows/"
|
||||
- existing_workflows: "{project-root}/{bmad_folder}/*/workflows/"
|
||||
- bmm_workflows: "{project-root}/{bmad_folder}/bmm/workflows/"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmb/workflows/create-workflow"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmb/workflows/create-workflow"
|
||||
template: false # This is an action workflow - no template needed
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
@@ -33,7 +33,7 @@ workflow_template_path: "{installed_path}/workflow-template"
|
||||
# Output configuration - Creates the new workflow folder with all files
|
||||
# If workflow belongs to a module: Save to module's workflows folder
|
||||
# If standalone workflow: Save to custom_workflow_location/{{workflow_name}}
|
||||
module_output_folder: "{project-root}/bmad/{{target_module}}/workflows/{{workflow_name}}"
|
||||
module_output_folder: "{project-root}/{bmad_folder}/{{target_module}}/workflows/{{workflow_name}}"
|
||||
standalone_output_folder: "{custom_workflow_location}/{{workflow_name}}"
|
||||
|
||||
standalone: true
|
||||
|
||||
@@ -46,7 +46,7 @@ Use this checklist to validate agent edits meet BMAD Core standards.
|
||||
## Menu Handler Validation
|
||||
|
||||
- [ ] menu-handlers section is present
|
||||
- [ ] Workflow handler loads {project-root}/bmad/core/tasks/workflow.xml
|
||||
- [ ] Workflow handler loads {project-root}/{bmad_folder}/core/tasks/workflow.xml
|
||||
- [ ] Workflow handler passes yaml path as 'workflow-config' parameter
|
||||
- [ ] Handlers check for attributes (workflow, exec, tmpl, data, action)
|
||||
- [ ] Handler logic is complete and follows patterns
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Edit Agent - Agent Editor Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/edit-agent/workflow.yaml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmb/workflows/edit-agent/workflow.yaml</critical>
|
||||
<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs</critical>
|
||||
<critical>The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them</critical>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
|
||||
@@ -4,27 +4,27 @@ description: "Edit existing BMAD agents while following all best practices and c
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/bmad/bmb/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
user_name: "{config_source}:user_name"
|
||||
|
||||
# Required Data Files - Critical for understanding agent conventions
|
||||
agent_types: "{project-root}/bmad/bmb/workflows/create-agent/agent-types.md"
|
||||
agent_architecture: "{project-root}/bmad/bmb/workflows/create-agent/agent-architecture.md"
|
||||
agent_commands: "{project-root}/bmad/bmb/workflows/create-agent/agent-command-patterns.md"
|
||||
communication_styles: "{project-root}/bmad/bmb/workflows/create-agent/communication-styles.md"
|
||||
agent_types: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/agent-types.md"
|
||||
agent_architecture: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/agent-architecture.md"
|
||||
agent_commands: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/agent-command-patterns.md"
|
||||
communication_styles: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/communication-styles.md"
|
||||
|
||||
# Workflow execution engine reference
|
||||
workflow_execution_engine: "{project-root}/bmad/core/tasks/workflow.xml"
|
||||
workflow_execution_engine: "{project-root}/{bmad_folder}/core/tasks/workflow.xml"
|
||||
|
||||
# Optional docs that can be used to understand the target agent
|
||||
recommended_inputs:
|
||||
- target_agent: "Path to the agent.yaml or agent.md file to edit"
|
||||
- example_agents: "{project-root}/bmad/bmm/agents/"
|
||||
- example_agents: "{project-root}/{bmad_folder}/bmm/agents/"
|
||||
- agent_activation_rules: "{project-root}/src/utility/models/agent-activation-ide.xml"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmb/workflows/edit-agent"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmb/workflows/edit-agent"
|
||||
template: false # This is an action workflow - no template needed
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
@@ -106,7 +106,7 @@ Modules can share workflows:
|
||||
|
||||
```yaml
|
||||
# In agent menu item:
|
||||
workflow: '{project-root}/bmad/other-module/workflows/shared-workflow/workflow.yaml'
|
||||
workflow: '{project-root}/{bmad_folder}/other-module/workflows/shared-workflow/workflow.yaml'
|
||||
```
|
||||
|
||||
Common patterns:
|
||||
@@ -151,7 +151,7 @@ Changes are reviewed and approved by you before being applied.
|
||||
- Can configure web bundles
|
||||
- Are the development source of truth
|
||||
|
||||
**Installed modules** (in bmad/):
|
||||
**Installed modules** (in {bmad_folder}/):
|
||||
|
||||
- Are deployed to target projects
|
||||
- Use config.yaml for user customization
|
||||
|
||||
@@ -5,7 +5,7 @@ Use this checklist to validate module edits meet BMAD Core standards.
|
||||
## Module Structure Validation
|
||||
|
||||
- [ ] Module has clear 3-letter code (bmm, bmb, cis, etc.)
|
||||
- [ ] Module is in correct location (src/modules/ for source, bmad/ for installed)
|
||||
- [ ] Module is in correct location (src/modules/ for source, {bmad_folder}/ for installed)
|
||||
- [ ] agents/ directory exists
|
||||
- [ ] workflows/ directory exists
|
||||
- [ ] config.yaml exists in module root
|
||||
@@ -128,7 +128,7 @@ Use this checklist to validate module edits meet BMAD Core standards.
|
||||
|
||||
- [ ] Web bundles configured in workflow.yaml files
|
||||
- [ ] All referenced files included in web_bundle_files
|
||||
- [ ] Paths are bmad/-relative (not project-root)
|
||||
- [ ] Paths are {bmad_folder}/-relative (not project-root)
|
||||
- [ ] No config_source references in web bundles
|
||||
- [ ] Invoked workflows included in dependencies
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Edit Module - Module Editor Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/edit-module/workflow.yaml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmb/workflows/edit-module/workflow.yaml</critical>
|
||||
<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs</critical>
|
||||
<critical>The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them</critical>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
@@ -9,7 +9,7 @@
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Load and deeply understand the target module">
|
||||
<ask>What is the path to the module you want to edit? (provide path to module directory like bmad/bmm/ or src/modules/bmm/)</ask>
|
||||
<ask>What is the path to the module you want to edit? (provide path to module directory like {bmad_folder}/bmm/ or src/modules/bmm/)</ask>
|
||||
|
||||
<action>Load the module directory structure completely:
|
||||
|
||||
@@ -185,7 +185,7 @@ Let the conversation flow naturally. Build a shared vision of what "better" look
|
||||
**If setting up cross-module integration:**
|
||||
|
||||
- Identify which workflows from other modules are needed
|
||||
- Show how to reference workflows properly: {project-root}/bmad/{{module}}/workflows/{{workflow}}/workflow.yaml
|
||||
- Show how to reference workflows properly: {project-root}/{bmad_folder}/{{module}}/workflows/{{workflow}}/workflow.yaml
|
||||
- Document the integration in README
|
||||
- Ensure dependencies are clear
|
||||
- Consider adding example usage
|
||||
|
||||
@@ -4,28 +4,28 @@ description: "Edit existing BMAD modules (structure, agents, workflows, document
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/bmad/bmb/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
user_name: "{config_source}:user_name"
|
||||
|
||||
# Required Data Files - Critical for understanding module conventions
|
||||
module_structure_guide: "{project-root}/bmad/bmb/workflows/create-module/module-structure.md"
|
||||
module_structure_guide: "{project-root}/{bmad_folder}/bmb/workflows/create-module/module-structure.md"
|
||||
|
||||
# Related workflow editors
|
||||
agent_editor: "{project-root}/bmad/bmb/workflows/edit-agent/workflow.yaml"
|
||||
workflow_editor: "{project-root}/bmad/bmb/workflows/edit-workflow/workflow.yaml"
|
||||
agent_editor: "{project-root}/{bmad_folder}/bmb/workflows/edit-agent/workflow.yaml"
|
||||
workflow_editor: "{project-root}/{bmad_folder}/bmb/workflows/edit-workflow/workflow.yaml"
|
||||
|
||||
# Optional docs that can be used to understand the target module
|
||||
recommended_inputs:
|
||||
- target_module: "Path to the module directory to edit"
|
||||
- bmm_module: "{project-root}/bmad/bmm/"
|
||||
- bmb_module: "{project-root}/bmad/bmb/"
|
||||
- cis_module: "{project-root}/bmad/cis/"
|
||||
- existing_agents: "{project-root}/bmad/*/agents/"
|
||||
- existing_workflows: "{project-root}/bmad/*/workflows/"
|
||||
- bmm_module: "{project-root}/{bmad_folder}/bmm/"
|
||||
- bmb_module: "{project-root}/{bmad_folder}/bmb/"
|
||||
- cis_module: "{project-root}/{bmad_folder}/cis/"
|
||||
- existing_agents: "{project-root}/{bmad_folder}/*/agents/"
|
||||
- existing_workflows: "{project-root}/{bmad_folder}/*/workflows/"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmb/workflows/edit-module"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmb/workflows/edit-module"
|
||||
template: false # This is an action workflow - no template needed
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Edit Workflow - Workflow Editor Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/edit-workflow/workflow.yaml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmb/workflows/edit-workflow/workflow.yaml</critical>
|
||||
<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs</critical>
|
||||
<critical>The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them</critical>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
- Workflow creation guide: {workflow_creation_guide}
|
||||
- Workflow execution engine: {workflow_execution_engine}
|
||||
- Study example workflows from: {project-root}/bmad/bmm/workflows/
|
||||
- Study example workflows from: {project-root}/{bmad_folder}/bmm/workflows/
|
||||
</action>
|
||||
|
||||
<action>Analyze the workflow deeply:
|
||||
@@ -205,7 +205,7 @@ Let the conversation flow naturally. Build a shared vision of what "better" look
|
||||
|
||||
- Identify all files the workflow depends on
|
||||
- Check for invoked workflows (must be included)
|
||||
- Verify paths are bmad/-relative
|
||||
- Verify paths are {bmad_folder}/-relative
|
||||
- Remove config_source dependencies
|
||||
- Build complete file list
|
||||
|
||||
|
||||
@@ -4,21 +4,21 @@ description: "Edit existing BMAD workflows while following all best practices an
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/bmad/bmb/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
user_name: "{config_source}:user_name"
|
||||
|
||||
# Required Data Files - Critical for understanding workflow conventions
|
||||
workflow_creation_guide: "{project-root}/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md"
|
||||
workflow_execution_engine: "{project-root}/bmad/core/tasks/workflow.xml"
|
||||
workflow_creation_guide: "{project-root}/{bmad_folder}/bmb/workflows/create-workflow/workflow-creation-guide.md"
|
||||
workflow_execution_engine: "{project-root}/{bmad_folder}/core/tasks/workflow.xml"
|
||||
|
||||
# Optional docs that can be used to understand the target workflow
|
||||
recommended_inputs:
|
||||
- target_workflow: "Path to the workflow.yaml file to edit"
|
||||
- workflow_examples: "{project-root}/bmad/bmm/workflows/"
|
||||
- workflow_examples: "{project-root}/{bmad_folder}/bmm/workflows/"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmb/workflows/edit-workflow"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmb/workflows/edit-workflow"
|
||||
template: false # This is an action workflow - no template needed
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
@@ -254,8 +254,8 @@ To customize this workflow:
|
||||
|
||||
For issues or questions:
|
||||
|
||||
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||
- Study existing module examples in `/bmad/` for patterns and inspiration
|
||||
- Review the workflow creation guide at `/{bmad_folder}/bmb/workflows/create-workflow/workflow-creation-guide.md`
|
||||
- Study existing module examples in `/{bmad_folder}/` for patterns and inspiration
|
||||
- Validate output using `checklist.md`
|
||||
- Consult module structure guide at `create-module/module-structure.md`
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Module Brief Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/module-brief/workflow.yaml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmb/workflows/module-brief/workflow.yaml</critical>
|
||||
<critical>Communicate in {communication_language} throughout the module brief creation process</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Create a comprehensive Module Brief that serves as the blueprint f
|
||||
author: "BMad Builder"
|
||||
|
||||
# Critical variables
|
||||
config_source: "{project-root}/bmad/bmb/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -13,11 +13,11 @@ date: system-generated
|
||||
# Optional input docs that enhance module planning
|
||||
recommended_inputs:
|
||||
- brainstorming_results: "{output_folder}/brainstorming-*.md"
|
||||
- existing_modules: "{project-root}/bmad/"
|
||||
- module_examples: "{project-root}/bmad/bmb/workflows/create-module/module-structure.md"
|
||||
- existing_modules: "{project-root}/{bmad_folder}/"
|
||||
- module_examples: "{project-root}/{bmad_folder}/bmb/workflows/create-module/module-structure.md"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmb/workflows/module-brief"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmb/workflows/module-brief"
|
||||
template: "{installed_path}/template.md"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
@@ -28,11 +28,11 @@ workflow redoc
|
||||
|
||||
When prompted, provide one of:
|
||||
|
||||
- **Module path**: `bmad/bmm` (documents entire module: root, workflows, agents)
|
||||
- **Workflows folder**: `bmad/bmm/workflows` (documents all workflows)
|
||||
- **Agents folder**: `bmad/bmm/agents` (documents all agents)
|
||||
- **Single workflow**: `bmad/bmm/workflows/product-brief` (documents one workflow)
|
||||
- **Single agent**: `bmad/bmm/agents/prd-agent.md` (documents one agent)
|
||||
- **Module path**: `{bmad_folder}/bmm` (documents entire module: root, workflows, agents)
|
||||
- **Workflows folder**: `{bmad_folder}/bmm/workflows` (documents all workflows)
|
||||
- **Agents folder**: `{bmad_folder}/bmm/agents` (documents all agents)
|
||||
- **Single workflow**: `{bmad_folder}/bmm/workflows/product-brief` (documents one workflow)
|
||||
- **Single agent**: `{bmad_folder}/bmm/agents/prd-agent.md` (documents one agent)
|
||||
|
||||
## Inputs
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# ReDoc Workflow Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/src/modules/bmb/workflows/redoc/workflow.yaml</critical>
|
||||
<critical>Communicate in {communication_language} throughout the documentation process</critical>
|
||||
<critical>This is an AUTONOMOUS workflow - minimize user interaction unless clarification is absolutely required</critical>
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Autonomous documentation system that maintains module, workflow, a
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables
|
||||
config_source: "{project-root}/bmad/bmb/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
|
||||
|
||||
@@ -135,7 +135,7 @@ bmgd/
|
||||
|
||||
## Configuration
|
||||
|
||||
After installation, configure the module in `bmad/bmgd/config.yaml`
|
||||
After installation, configure the module in `{bmad_folder}/bmgd/config.yaml`
|
||||
|
||||
Key settings:
|
||||
|
||||
|
||||
@@ -16,6 +16,8 @@ prompt:
|
||||
## document_output_language
|
||||
## output_folder
|
||||
## bmad_folder
|
||||
## install_user_docs
|
||||
## kb_install
|
||||
|
||||
game_project_name:
|
||||
prompt: "What is the name of your game project?"
|
||||
@@ -23,18 +25,18 @@ game_project_name:
|
||||
result: "{value}"
|
||||
|
||||
game_design_docs:
|
||||
prompt: "Where should game design documents (GDD, narrative, etc.) be stored?"
|
||||
default: "docs/design"
|
||||
prompt: "Where should game design and planning documents (GDD, narrative, etc.) be stored?"
|
||||
default: "{output_folder}/design"
|
||||
result: "{project-root}/{value}"
|
||||
|
||||
game_tech_docs:
|
||||
prompt: "Where should game technical documentation be stored?"
|
||||
default: "docs/technical"
|
||||
tech_docs:
|
||||
prompt: "Where should technical reference documents be stored?"
|
||||
default: "{output_folder}/technical"
|
||||
result: "{project-root}/{value}"
|
||||
|
||||
game_story_location:
|
||||
prompt: "Where should game development stories be stored?"
|
||||
default: "docs/stories"
|
||||
dev_ephemeral_location:
|
||||
prompt: "Where should ephemeral development artifacts be stored (stories, epics, temp context, etc...)?"
|
||||
default: "{bmad_folder}-ephemeral"
|
||||
result: "{project-root}/{value}"
|
||||
|
||||
game_dev_experience:
|
||||
@@ -51,7 +53,8 @@ game_dev_experience:
|
||||
|
||||
specified_framework:
|
||||
prompt: "Which game development framework or engine do you want to install support for?"
|
||||
default: "unity"
|
||||
default: ["unity", "unreal", "godot", "other"]
|
||||
required: true
|
||||
result: "{value}"
|
||||
multi-select:
|
||||
- value: "unity"
|
||||
@@ -60,8 +63,8 @@ specified_framework:
|
||||
label: "Unreal Engine"
|
||||
- value: "godot"
|
||||
label: "Godot"
|
||||
- value: "custom"
|
||||
- value: "other"
|
||||
label: "Custom / Other"
|
||||
|
||||
data_path:
|
||||
result: "{project-root}/bmad/bmgd/data"
|
||||
result: "{project-root}/{bmad_folder}/bmgd/data"
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmgd/agents/game-architect.md
|
||||
id: "{bmad_folder}/bmgd/agents/game-architect.md"
|
||||
name: Cloud Dragonborn
|
||||
title: Game Architect
|
||||
icon: 🏛️
|
||||
@@ -19,10 +19,10 @@ agent:
|
||||
|
||||
menu:
|
||||
- trigger: correct-course
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/bmgd/workflows/4-production/correct-course/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/correct-course/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/correct-course/workflow.yaml"
|
||||
description: Course Correction Analysis
|
||||
|
||||
- trigger: create-architecture
|
||||
workflow: "{project-root}/bmad/bmgd/workflows/3-technical/game-architecture/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmgd/workflows/3-technical/game-architecture/workflow.yaml"
|
||||
description: Produce a Scale Adaptive Game Architecture
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmgd/agents/game-designer.md
|
||||
id: "{bmad_folder}/bmgd/agents/game-designer.md"
|
||||
name: Samus Shepard
|
||||
title: Game Designer
|
||||
icon: 🎲
|
||||
@@ -19,17 +19,17 @@ agent:
|
||||
|
||||
menu:
|
||||
- trigger: brainstorm-game
|
||||
workflow: "{project-root}/bmad/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml"
|
||||
description: 1. Guide me through Game Brainstorming
|
||||
|
||||
- trigger: create-game-brief
|
||||
workflow: "{project-root}/bmad/bmgd/workflows/1-preproduction/game-brief/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmgd/workflows/1-preproduction/game-brief/workflow.yaml"
|
||||
description: 3. Create Game Brief
|
||||
|
||||
- trigger: create-gdd
|
||||
workflow: "{project-root}/bmad/bmgd/workflows/2-design/gdd/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmgd/workflows/2-design/gdd/workflow.yaml"
|
||||
description: 4. Create Game Design Document (GDD)
|
||||
|
||||
- trigger: narrative
|
||||
workflow: "{project-root}/bmad/bmgd/workflows/2-design/narrative/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmgd/workflows/2-design/narrative/workflow.yaml"
|
||||
description: 5. Create Narrative Design Document (story-driven games)
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmgd/agents/game-dev.md
|
||||
id: "{bmad_folder}/bmgd/agents/game-dev.md"
|
||||
name: Link Freeman
|
||||
title: Game Developer
|
||||
icon: 🕹️
|
||||
@@ -19,16 +19,16 @@ agent:
|
||||
|
||||
menu:
|
||||
- trigger: develop-story
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/bmgd/workflows/4-production/dev-story/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/dev-story/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/dev-story/workflow.yaml"
|
||||
description: "Execute Dev Story workflow, implementing tasks and tests, or performing updates to the story"
|
||||
|
||||
- trigger: code-review
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/bmgd/workflows/4-production/code-review/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/code-review/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/code-review/workflow.yaml"
|
||||
description: "Perform a thorough clean context QA code review on a story flagged Ready for Review"
|
||||
|
||||
- trigger: story-done
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/story-done/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/bmgd/workflows/4-production/story-done/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/story-done/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/story-done/workflow.yaml"
|
||||
description: "Mark story done after DoD complete"
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmgd/agents/game-scrum-master.md
|
||||
id: "{bmad_folder}/bmgd/agents/game-scrum-master.md"
|
||||
name: Max
|
||||
title: Game Dev Scrum Master
|
||||
icon: 🎯
|
||||
@@ -22,49 +22,49 @@ agent:
|
||||
|
||||
menu:
|
||||
- trigger: sprint-planning
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/bmgd/workflows/4-production/sprint-planning/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/sprint-planning/workflow.yaml"
|
||||
description: Generate or update sprint-status.yaml from epic files
|
||||
|
||||
- trigger: epic-tech-context
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/bmgd/workflows/4-production/epic-tech-context/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/epic-tech-context/workflow.yaml"
|
||||
description: (Optional) Use the GDD and Architecture to create an Epic-Tech-Spec for a specific epic
|
||||
|
||||
- trigger: validate-epic-tech-context
|
||||
validate-workflow: "{project-root}/bmad/bmgd/workflows/4-production/epic-tech-context/workflow.yaml"
|
||||
validate-workflow: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/epic-tech-context/workflow.yaml"
|
||||
description: (Optional) Validate latest Tech Spec against checklist
|
||||
|
||||
- trigger: create-story-draft
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/bmgd/workflows/4-production/create-story/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/create-story/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/create-story/workflow.yaml"
|
||||
description: Create a Story Draft for a game feature
|
||||
|
||||
- trigger: validate-create-story
|
||||
validate-workflow: "{project-root}/bmad/bmgd/workflows/4-production/create-story/workflow.yaml"
|
||||
validate-workflow: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/create-story/workflow.yaml"
|
||||
description: (Optional) Validate Story Draft with Independent Review
|
||||
|
||||
- trigger: story-context
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/story-context/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/bmgd/workflows/4-production/story-context/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/story-context/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/story-context/workflow.yaml"
|
||||
description: (Optional) Assemble dynamic Story Context (XML) from latest docs and code and mark story ready for dev
|
||||
|
||||
- trigger: validate-story-context
|
||||
validate-workflow: "{project-root}/bmad/bmgd/workflows/4-production/story-context/workflow.yaml"
|
||||
validate-workflow: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/story-context/workflow.yaml"
|
||||
description: (Optional) Validate latest Story Context XML against checklist
|
||||
|
||||
- trigger: story-ready-for-dev
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/story-ready/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/bmgd/workflows/4-production/story-ready/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/story-ready/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/story-ready/workflow.yaml"
|
||||
description: (Optional) Mark drafted story ready for dev without generating Story Context
|
||||
|
||||
- trigger: epic-retrospective
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/bmgd/workflows/4-production/retrospective/workflow.yaml"
|
||||
data: "{project-root}/bmad/_cfg/agent-manifest.csv"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/retrospective/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/retrospective/workflow.yaml"
|
||||
data: "{project-root}/{bmad_folder}/_cfg/agent-manifest.csv"
|
||||
description: (Optional) Facilitate team retrospective after a game development epic is completed
|
||||
|
||||
- trigger: correct-course
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml"
|
||||
workflow-install: "{project-root}/bmad/bmgd/workflows/4-production/correct-course/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/correct-course/workflow.yaml"
|
||||
workflow-install: "{project-root}/{bmad_folder}/bmgd/workflows/4-production/correct-course/workflow.yaml"
|
||||
description: (Optional) Navigate significant changes during game dev sprint
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project_root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
<critical>This is a meta-workflow that orchestrates the CIS brainstorming workflow with game-specific context and additional game design techniques</critical>
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Facilitate game brainstorming sessions by orchestrating the CIS br
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -13,7 +13,7 @@ game_dev_experience: "{config_source}:game_dev_experience"
|
||||
date: system-generated
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmgd/workflows/1-preproduction/brainstorm-game"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmgd/workflows/1-preproduction/brainstorm-game"
|
||||
template: false
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
|
||||
@@ -22,7 +22,7 @@ game_context: "{installed_path}/game-context.md"
|
||||
game_brain_methods: "{installed_path}/game-brain-methods.csv"
|
||||
|
||||
# CORE brainstorming workflow to invoke
|
||||
core_brainstorming: "{project-root}/bmad/core/workflows/brainstorming/workflow.yaml"
|
||||
core_brainstorming: "{project-root}/{bmad_folder}/core/workflows/brainstorming/workflow.yaml"
|
||||
|
||||
standalone: true
|
||||
|
||||
@@ -30,12 +30,12 @@ web_bundle:
|
||||
name: "brainstorm-game"
|
||||
description: "Facilitate game brainstorming sessions by orchestrating the CIS brainstorming workflow with game-specific context, guidance, and additional game design techniques."
|
||||
author: "BMad"
|
||||
instructions: "bmad/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md"
|
||||
instructions: "{bmad_folder}/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md"
|
||||
template: false
|
||||
web_bundle_files:
|
||||
- "bmad/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md"
|
||||
- "bmad/bmgd/workflows/1-preproduction/brainstorm-game/game-context.md"
|
||||
- "bmad/bmgd/workflows/1-preproduction/brainstorm-game/game-brain-methods.csv"
|
||||
- "bmad/core/workflows/brainstorming/workflow.yaml"
|
||||
- "{bmad_folder}/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md"
|
||||
- "{bmad_folder}/bmgd/workflows/1-preproduction/brainstorm-game/game-context.md"
|
||||
- "{bmad_folder}/bmgd/workflows/1-preproduction/brainstorm-game/game-brain-methods.csv"
|
||||
- "{bmad_folder}/core/workflows/brainstorming/workflow.yaml"
|
||||
existing_workflows:
|
||||
- core_brainstorming: "bmad/core/workflows/brainstorming/workflow.yaml"
|
||||
- core_brainstorming: "{bmad_folder}/core/workflows/brainstorming/workflow.yaml"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Game Brief - Interactive Workflow Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
|
||||
<critical>Generate all documents in {document_output_language}</critical>
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Interactive game brief creation workflow that guides users through
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -21,7 +21,7 @@ recommended_inputs:
|
||||
- reference_games: "List of inspiration games (optional)"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmgd/workflows/1-preproduction/game-brief"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmgd/workflows/1-preproduction/game-brief"
|
||||
template: "{installed_path}/template.md"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
@@ -35,10 +35,10 @@ web_bundle:
|
||||
name: "game-brief"
|
||||
description: "Interactive game brief creation workflow that guides users through defining their game vision with multiple input sources and conversational collaboration"
|
||||
author: "BMad"
|
||||
instructions: "bmad/bmgd/workflows/1-preproduction/game-brief/instructions.md"
|
||||
validation: "bmad/bmgd/workflows/1-preproduction/game-brief/checklist.md"
|
||||
template: "bmad/bmgd/workflows/1-preproduction/game-brief/template.md"
|
||||
instructions: "{bmad_folder}/bmgd/workflows/1-preproduction/game-brief/instructions.md"
|
||||
validation: "{bmad_folder}/bmgd/workflows/1-preproduction/game-brief/checklist.md"
|
||||
template: "{bmad_folder}/bmgd/workflows/1-preproduction/game-brief/template.md"
|
||||
web_bundle_files:
|
||||
- "bmad/bmgd/workflows/1-preproduction/game-brief/instructions.md"
|
||||
- "bmad/bmgd/workflows/1-preproduction/game-brief/checklist.md"
|
||||
- "bmad/bmgd/workflows/1-preproduction/game-brief/template.md"
|
||||
- "{bmad_folder}/bmgd/workflows/1-preproduction/game-brief/instructions.md"
|
||||
- "{bmad_folder}/bmgd/workflows/1-preproduction/game-brief/checklist.md"
|
||||
- "{bmad_folder}/bmgd/workflows/1-preproduction/game-brief/template.md"
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
<workflow>
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project_root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
|
||||
<critical>Generate all documents in {document_output_language}</critical>
|
||||
@@ -34,7 +34,7 @@ This workflow requires: game brief, and may reference market research or brownfi
|
||||
|
||||
<step n="0" goal="Validate workflow and extract project configuration">
|
||||
|
||||
<invoke-workflow path="{project-root}/bmad/bmm/workflows/workflow-status">
|
||||
<invoke-workflow path="{project-root}/{bmad_folder}/bmm/workflows/workflow-status">
|
||||
<param>mode: data</param>
|
||||
<param>data_request: project_config</param>
|
||||
</invoke-workflow>
|
||||
@@ -221,7 +221,7 @@ Get core game concept and vision.
|
||||
<action>Guide user to define the primary game mechanics that players will interact with throughout the game</action>
|
||||
|
||||
<template-output>primary_mechanics</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
|
||||
<action>Guide user to describe their control scheme and input method (keyboard/mouse, gamepad, touchscreen, etc.), including key bindings or button layouts if known</action>
|
||||
|
||||
@@ -239,7 +239,7 @@ For each {{placeholder}} in the fragment, elicit and capture that information.
|
||||
|
||||
<template-output file="GDD.md">GAME_TYPE_SPECIFIC_SECTIONS</template-output>
|
||||
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -304,7 +304,7 @@ For each {{placeholder}} in the fragment, elicit and capture that information.
|
||||
<action>Work with user to translate game features into development epics, following level-appropriate guidelines (Level 1: 1 epic/1-10 stories, Level 2: 1-2 epics/5-15 stories, Level 3: 2-5 epics/12-40 stories, Level 4: 5+ epics/40+ stories)</action>
|
||||
|
||||
<template-output>epics</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -325,7 +325,7 @@ For each {{placeholder}} in the fragment, elicit and capture that information.
|
||||
<for-each epic="epic_list">
|
||||
|
||||
<template-output file="epics.md">epic\_{{epic_number}}\_details</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
|
||||
</for-each>
|
||||
|
||||
@@ -403,7 +403,7 @@ Your choice:</ask>
|
||||
</check>
|
||||
|
||||
<check if="user selects option 1 or fuzzy indicates wanting to create the narrative design document">
|
||||
<invoke-workflow>{project-root}/bmad/bmm/workflows/2-plan-workflows/narrative/workflow.yaml</invoke-workflow>
|
||||
<invoke-workflow>{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/narrative/workflow.yaml</invoke-workflow>
|
||||
<action>Pass GDD context to narrative workflow</action>
|
||||
<action>Exit current workflow (narrative will hand off to solutioning when done)</action>
|
||||
|
||||
@@ -497,7 +497,7 @@ Which would you like to proceed with?</ask>
|
||||
</check>
|
||||
|
||||
<check if="user selects narrative option">
|
||||
<invoke-workflow>{project-root}/bmad/bmm/workflows/2-plan-workflows/narrative/workflow.yaml</invoke-workflow>
|
||||
<invoke-workflow>{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/narrative/workflow.yaml</invoke-workflow>
|
||||
<action>Pass GDD context to narrative workflow</action>
|
||||
</check>
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Game Design Document workflow for all game project levels - from s
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -13,7 +13,7 @@ game_dev_experience: "{config_source}:game_dev_experience"
|
||||
date: system-generated
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmgd/workflows/2-design/gdd"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmgd/workflows/2-design/gdd"
|
||||
instructions: "{installed_path}/instructions-gdd.md"
|
||||
template: "{installed_path}/gdd-template.md"
|
||||
game_types_csv: "{installed_path}/game-types.csv"
|
||||
@@ -50,32 +50,32 @@ web_bundle:
|
||||
name: "gdd"
|
||||
description: "Game Design Document workflow for all game project levels - from small prototypes to full AAA games. Generates comprehensive GDD with game mechanics, systems, progression, and implementation guidance."
|
||||
author: "BMad"
|
||||
instructions: "bmad/bmgd/workflows/2-design/gdd/instructions-gdd.md"
|
||||
instructions: "{bmad_folder}/bmgd/workflows/2-design/gdd/instructions-gdd.md"
|
||||
web_bundle_files:
|
||||
- "bmad/bmgd/workflows/2-design/gdd/instructions-gdd.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/gdd-template.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types.csv"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/action-platformer.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/adventure.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/card-game.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/fighting.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/horror.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/idle-incremental.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/metroidvania.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/moba.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/party-game.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/puzzle.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/racing.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/rhythm.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/roguelike.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/rpg.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/sandbox.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/shooter.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/simulation.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/sports.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/strategy.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/survival.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/text-based.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/tower-defense.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/turn-based-tactics.md"
|
||||
- "bmad/bmgd/workflows/2-design/gdd/game-types/visual-novel.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/instructions-gdd.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/gdd-template.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types.csv"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/action-platformer.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/adventure.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/card-game.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/fighting.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/horror.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/idle-incremental.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/metroidvania.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/moba.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/party-game.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/puzzle.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/racing.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/rhythm.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/roguelike.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/rpg.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/sandbox.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/shooter.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/simulation.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/sports.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/strategy.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/survival.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/text-based.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/tower-defense.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/turn-based-tactics.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/gdd/game-types/visual-novel.md"
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
<workflow>
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project_root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already completed the GDD workflow</critical>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
<critical>This workflow creates detailed narrative content for story-driven games</critical>
|
||||
@@ -143,7 +143,7 @@ For 3-Act:
|
||||
Describe each act/section for your game:</ask>
|
||||
|
||||
<template-output>act_breakdown</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -162,7 +162,7 @@ Format:
|
||||
Your story beats:</ask>
|
||||
|
||||
<template-output>story_beats</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
|
||||
<ask>Describe the pacing and flow of your narrative.
|
||||
|
||||
@@ -195,7 +195,7 @@ For each protagonist include:
|
||||
Your protagonist(s):</ask>
|
||||
|
||||
<template-output>protagonists</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -233,7 +233,7 @@ For each character include:
|
||||
Your supporting characters:</ask>
|
||||
|
||||
<template-output>supporting_characters</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
|
||||
</step>
|
||||
|
||||
@@ -281,7 +281,7 @@ Your world:</ask>
|
||||
Your history:</ask>
|
||||
|
||||
<template-output>history_backstory</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
|
||||
</step>
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Narrative design workflow for story-driven games and applications.
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -13,7 +13,7 @@ game_dev_experience: "{config_source}:game_dev_experience"
|
||||
date: system-generated
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmgd/workflows/2-design/narrative"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmgd/workflows/2-design/narrative"
|
||||
instructions: "{installed_path}/instructions-narrative.md"
|
||||
template: "{installed_path}/narrative-template.md"
|
||||
|
||||
@@ -32,7 +32,7 @@ web_bundle:
|
||||
name: "narrative"
|
||||
description: "Narrative design workflow for story-driven games and applications. Creates comprehensive narrative documentation including story structure, character arcs, dialogue systems, and narrative implementation guidance."
|
||||
author: "BMad"
|
||||
instructions: "bmad/bmgd/workflows/2-design/narrative/instructions-narrative.md"
|
||||
instructions: "{bmad_folder}/bmgd/workflows/2-design/narrative/instructions-narrative.md"
|
||||
web_bundle_files:
|
||||
- "bmad/bmgd/workflows/2-design/narrative/instructions-narrative.md"
|
||||
- "bmad/bmgd/workflows/2-design/narrative/narrative-template.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/narrative/instructions-narrative.md"
|
||||
- "{bmad_folder}/bmgd/workflows/2-design/narrative/narrative-template.md"
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
<workflow name="architecture">
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication style based on {user_skill_level}</critical>
|
||||
<critical>The goal is ARCHITECTURAL DECISIONS that prevent AI agent conflicts, not detailed implementation specs</critical>
|
||||
@@ -363,7 +363,7 @@ Provided by Starter: {{yes_if_from_starter}}
|
||||
</action>
|
||||
|
||||
<template-output>decision_record</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Address cross-cutting concerns">
|
||||
@@ -393,7 +393,7 @@ Provided by Starter: {{yes_if_from_starter}}
|
||||
</action>
|
||||
|
||||
<template-output>project_structure</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Design novel architectural patterns" optional="true">
|
||||
@@ -467,7 +467,7 @@ Provided by Starter: {{yes_if_from_starter}}
|
||||
</check>
|
||||
|
||||
<template-output>novel_pattern_designs</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Define implementation patterns to prevent agent conflicts">
|
||||
@@ -560,7 +560,7 @@ Enforcement: "All agents MUST follow this pattern"
|
||||
</action>
|
||||
|
||||
<template-output>implementation_patterns</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Validate architectural coherence">
|
||||
@@ -614,7 +614,7 @@ Enforcement: "All agents MUST follow this pattern"
|
||||
</action>
|
||||
|
||||
<template-output>architecture_document</template-output>
|
||||
<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
|
||||
<invoke-task halt="true">{project-root}/{bmad_folder}/core/tasks/adv-elicit.xml</invoke-task>
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Validate document completeness">
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Collaborative game architecture workflow for AI-agent consistency.
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -37,7 +37,7 @@ input_file_patterns:
|
||||
sharded: "{output_folder}/docs/index.md"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/bmad/bmgd/workflows/3-technical/game-architecture"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmgd/workflows/3-technical/game-architecture"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
template: "{installed_path}/architecture-template.md"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Senior Developer Review - Workflow Instructions
|
||||
|
||||
````xml
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
|
||||
<critical>Generate all documents in {document_output_language}</critical>
|
||||
@@ -376,7 +376,7 @@ Review was saved to story file, but sprint-status.yaml may be out of sync.
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Validation and completion">
|
||||
<invoke-task>Run validation checklist at {installed_path}/checklist.md using {project-root}/bmad/core/tasks/validate-workflow.xml</invoke-task>
|
||||
<invoke-task>Run validation checklist at {installed_path}/checklist.md using {project-root}/{bmad_folder}/core/tasks/validate-workflow.xml</invoke-task>
|
||||
<action>Report workflow completion.</action>
|
||||
|
||||
<check if="ad_hoc_review_mode == true">
|
||||
|
||||
@@ -4,7 +4,7 @@ description: "Perform a Senior Developer code review on a completed story flagge
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -13,7 +13,7 @@ document_output_language: "{config_source}:document_output_language"
|
||||
date: system-generated
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/4-implementation/code-review"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/code-review"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
@@ -23,7 +23,7 @@ template: false
|
||||
# Variables (can be provided by caller)
|
||||
variables:
|
||||
story_path: "" # Optional: Explicit path to story file. If not provided, finds first story with status "review"
|
||||
story_dir: "{config_source}:dev_story_location" # Directory containing story files
|
||||
story_dir: "{config_source}:dev_ephemeral_location" # Directory containing story files
|
||||
tech_spec_search_dir: "{project-root}/docs"
|
||||
tech_spec_glob_template: "tech-spec-epic-{{epic_num}}*.md"
|
||||
arch_docs_search_dirs: |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Change Navigation Checklist
|
||||
|
||||
<critical>This checklist is executed as part of: {project-root}/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml</critical>
|
||||
<critical>This checklist is executed as part of: {project-root}/{bmad_folder}/bmm/workflows/4-implementation/correct-course/workflow.yaml</critical>
|
||||
<critical>Work through each section systematically with the user, recording findings and impacts</critical>
|
||||
|
||||
<checklist>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Correct Course - Sprint Change Management Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmm/workflows/4-implementation/correct-course/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
|
||||
<critical>Generate all documents in {document_output_language}</critical>
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ name: "correct-course"
|
||||
description: "Navigate significant changes during sprint execution by analyzing impact, proposing solutions, and routing for implementation"
|
||||
author: "BMad Method"
|
||||
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -11,7 +11,7 @@ user_skill_level: "{config_source}:user_skill_level"
|
||||
document_output_language: "{config_source}:document_output_language"
|
||||
date: system-generated
|
||||
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/4-implementation/correct-course"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/correct-course"
|
||||
template: false
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Create Story - Workflow Instructions (Spec-compliant, non-interactive by default)
|
||||
|
||||
````xml
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project_root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Generate all documents in {document_output_language}</critical>
|
||||
<critical>This workflow creates or updates the next user story from epics/PRD and architecture context, saving to the configured stories directory and optionally invoking Story Context.</critical>
|
||||
@@ -39,7 +39,7 @@
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Load config and initialize">
|
||||
<action>Resolve variables from config_source: story_dir (dev_story_location), output_folder, user_name, communication_language. If story_dir missing and {{non_interactive}} == false → ASK user to provide a stories directory and update variable. If {{non_interactive}} == true and missing, HALT with a clear message.</action>
|
||||
<action>Resolve variables from config_source: story_dir (dev_ephemeral_location), output_folder, user_name, communication_language. If story_dir missing and {{non_interactive}} == false → ASK user to provide a stories directory and update variable. If {{non_interactive}} == true and missing, HALT with a clear message.</action>
|
||||
<action>Create {{story_dir}} if it does not exist</action>
|
||||
<action>Resolve installed component paths from workflow.yaml: template, instructions, validation</action>
|
||||
<action>Resolve recommended inputs if present: epics_file, prd_file, architecture_file</action>
|
||||
@@ -240,7 +240,7 @@ Will update existing story file rather than creating new one.
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Validate, save, and mark story drafted" tag="sprint-status">
|
||||
<invoke-task>Validate against checklist at {installed_path}/checklist.md using bmad/core/tasks/validate-workflow.xml</invoke-task>
|
||||
<invoke-task>Validate against checklist at {installed_path}/checklist.md using {bmad_folder}/core/tasks/validate-workflow.xml</invoke-task>
|
||||
<action>Save document unconditionally (non-interactive default). In interactive mode, allow user confirmation.</action>
|
||||
|
||||
<!-- Mark story as drafted in sprint status -->
|
||||
|
||||
@@ -3,21 +3,21 @@ description: "Create the next user story markdown from epics/PRD and architectur
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
date: system-generated
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/4-implementation/create-story"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/create-story"
|
||||
template: "{installed_path}/template.md"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
# Variables and inputs
|
||||
variables:
|
||||
story_dir: "{config_source}:dev_story_location" # Directory where stories are stored
|
||||
story_dir: "{config_source}:dev_ephemeral_location" # Directory where stories are stored
|
||||
epics_file: "{output_folder}/epics.md" # Preferred source for epic/story breakdown
|
||||
prd_file: "{output_folder}/PRD.md" # Fallback for requirements
|
||||
architecture_file: "{output_folder}/architecture.md" # Optional architecture context
|
||||
|
||||
@@ -26,7 +26,7 @@ The dev-story workflow is well-structured and follows most BMAD v6 standards. Th
|
||||
|
||||
The workflow.yaml contains all required standard config variables:
|
||||
|
||||
- ✓ `config_source: "{project-root}/bmad/bmm/config.yaml"` - Correctly defined
|
||||
- ✓ `config_source: "{project-root}/{bmad_folder}/bmm/config.yaml"` - Correctly defined
|
||||
- ✓ `output_folder: "{config_source}:output_folder"` - Pulls from config_source
|
||||
- ✓ `user_name: "{config_source}:user_name"` - Pulls from config_source
|
||||
- ✓ `communication_language: "{config_source}:communication_language"` - Pulls from config_source
|
||||
@@ -67,7 +67,7 @@ These variables appear to be pulling from config.yaml but are not explicitly def
|
||||
|
||||
### Unused Variables (Bloat)
|
||||
|
||||
1. **context_path** - Defined as `"{config_source}:dev_story_location"` but never used. This duplicates `story_dir` functionality.
|
||||
1. **context_path** - Defined as `"{config_source}:dev_ephemeral_location"` but never used. This duplicates `story_dir` functionality.
|
||||
|
||||
---
|
||||
|
||||
@@ -140,7 +140,7 @@ The workflow correctly sets `web_bundle: false`. This is the expected configurat
|
||||
### Unused YAML Fields
|
||||
|
||||
1. **context_path** (line 11 in workflow.yaml)
|
||||
- Defined as: `"{config_source}:dev_story_location"`
|
||||
- Defined as: `"{config_source}:dev_ephemeral_location"`
|
||||
- Never referenced in instructions.md
|
||||
- Duplicates functionality of `story_dir` variable
|
||||
- **Recommendation:** Remove this variable as `story_dir` serves the same purpose
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Develop Story - Workflow Instructions
|
||||
|
||||
```xml
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
|
||||
<critical>Generate all documents in {document_output_language}</critical>
|
||||
@@ -227,7 +227,7 @@ Story is marked Ready for Review in file, but sprint-status.yaml may be out of s
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Completion communication and user support">
|
||||
<action>Optionally run the workflow validation task against the story using {project-root}/bmad/core/tasks/validate-workflow.xml</action>
|
||||
<action>Optionally run the workflow validation task against the story using {project-root}/{bmad_folder}/core/tasks/validate-workflow.xml</action>
|
||||
<action>Prepare a concise summary in Dev Agent Record → Completion Notes</action>
|
||||
|
||||
<action>Communicate to {user_name} that story implementation is complete and ready for review</action>
|
||||
|
||||
@@ -3,13 +3,13 @@ description: "Execute a story by implementing tasks/subtasks, writing tests, val
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
user_skill_level: "{config_source}:user_skill_level"
|
||||
document_output_language: "{config_source}:document_output_language"
|
||||
story_dir: "{config_source}:dev_story_location"
|
||||
story_dir: "{config_source}:dev_ephemeral_location"
|
||||
run_until_complete: "{config_source}:run_until_complete"
|
||||
run_tests_command: "{config_source}:run_tests_command"
|
||||
date: system-generated
|
||||
@@ -19,7 +19,7 @@ story_file: "" # Explicit story path; auto-discovered if empty
|
||||
context_file: "{story_dir}/{{story_key}}.context.xml"
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/4-implementation/dev-story"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/dev-story"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Tech Spec Validation Checklist
|
||||
|
||||
```xml
|
||||
<checklist id="bmad/bmm/workflows/4-implementation/epic-tech-context/checklist">
|
||||
<checklist id="{bmad_folder}/bmm/workflows/4-implementation/epic-tech-context/checklist">
|
||||
<item>Overview clearly ties to PRD goals</item>
|
||||
<item>Scope explicitly lists in-scope and out-of-scope</item>
|
||||
<item>Design lists all services/modules with responsibilities</item>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!-- BMAD BMM Tech Spec Workflow Instructions (v6) -->
|
||||
|
||||
```xml
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project_root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
<critical>This workflow generates a comprehensive Technical Specification from PRD and Architecture, including detailed design, NFRs, acceptance criteria, and traceability mapping.</critical>
|
||||
@@ -157,7 +157,7 @@ Continuing to regenerate tech spec...
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Validate and mark epic contexted" tag="sprint-status">
|
||||
<invoke-task>Validate against checklist at {installed_path}/checklist.md using bmad/core/tasks/validate-workflow.xml</invoke-task>
|
||||
<invoke-task>Validate against checklist at {installed_path}/checklist.md using {bmad_folder}/core/tasks/validate-workflow.xml</invoke-task>
|
||||
|
||||
<!-- Mark epic as contexted -->
|
||||
<action>Load the FULL file: {{output_folder}}/sprint-status.yaml</action>
|
||||
|
||||
@@ -3,7 +3,7 @@ description: "Generate a comprehensive Technical Specification from PRD and Arch
|
||||
author: "BMAD BMM"
|
||||
|
||||
# Critical variables
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -47,7 +47,7 @@ input_file_patterns:
|
||||
sharded: "{output_folder}/docs/index.md"
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/4-implementation/epic-tech-context"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/epic-tech-context"
|
||||
template: "{installed_path}/template.md"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Retrospective - Epic Completion Review Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmm/workflows/4-implementation/retrospective/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
|
||||
<critical>Generate all documents in {document_output_language}</critical>
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ name: "retrospective"
|
||||
description: "Run after epic completion to review overall success, extract lessons learned, and explore if new information emerged that might impact the next epic"
|
||||
author: "BMad"
|
||||
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
@@ -11,7 +11,7 @@ user_skill_level: "{config_source}:user_skill_level"
|
||||
document_output_language: "{config_source}:document_output_language"
|
||||
date: system-generated
|
||||
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/4-implementation/retrospective"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/retrospective"
|
||||
template: false
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
|
||||
@@ -19,7 +19,7 @@ mode: interactive
|
||||
trigger: "Run AFTER completing an epic"
|
||||
|
||||
required_inputs:
|
||||
- agent_manifest: "{project-root}/bmad/_cfg/agent-manifest.csv"
|
||||
- agent_manifest: "{project-root}/{bmad_folder}/_cfg/agent-manifest.csv"
|
||||
|
||||
# Smart input file references - handles both whole docs and sharded docs
|
||||
# Priority: Whole document first, then sharded version
|
||||
@@ -46,7 +46,7 @@ input_file_patterns:
|
||||
|
||||
# Required files
|
||||
sprint_status_file: "{output_folder}/sprint-status.yaml"
|
||||
story_directory: "{config_source}:dev_story_location"
|
||||
story_directory: "{config_source}:dev_ephemeral_location"
|
||||
retrospectives_folder: "{output_folder}/retrospectives"
|
||||
|
||||
output_artifacts:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Sprint Planning - Sprint Status Generator
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/bmm/workflows/4-implementation/sprint-planning/workflow.yaml</critical>
|
||||
|
||||
## 📚 Document Discovery - Full Epic Loading
|
||||
|
||||
|
||||
@@ -3,14 +3,14 @@ description: "Generate and manage the sprint status tracking file for Phase 4 im
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
date: system-generated
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/4-implementation/sprint-planning"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/sprint-planning"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
template: "{installed_path}/sprint-status-template.yaml"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
@@ -24,7 +24,7 @@ variables:
|
||||
# Tracking system configuration
|
||||
tracking_system: "file-system" # Options: file-system, Future will support other options from config of mcp such as jira, linear, trello
|
||||
story_location: "{project-root}/docs/stories" # Relative path for file-system, Future will support URL for Jira/Linear/Trello
|
||||
story_location_absolute: "{config_source}:dev_story_location" # Absolute path for file operations
|
||||
story_location_absolute: "{config_source}:dev_ephemeral_location" # Absolute path for file operations
|
||||
|
||||
# Source files (file-system only)
|
||||
epics_location: "{output_folder}" # Directory containing epic*.md files
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Story Context Assembly Checklist
|
||||
|
||||
```xml
|
||||
<checklist id="bmad/bmm/workflows/4-implementation/story-context/checklist">
|
||||
<checklist id="{bmad_folder}/bmm/workflows/4-implementation/story-context/checklist">
|
||||
<item>Story fields (asA/iWant/soThat) captured</item>
|
||||
<item>Acceptance criteria list matches story draft exactly (no invention)</item>
|
||||
<item>Tasks/subtasks captured as task list</item>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
<story-context id="bmad/bmm/workflows/4-implementation/story-context/template" v="1.0">
|
||||
<story-context id="{bmad_folder}/bmm/workflows/4-implementation/story-context/template" v="1.0">
|
||||
<metadata>
|
||||
<epicId>{{epic_id}}</epicId>
|
||||
<storyId>{{story_id}}</storyId>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!-- BMAD BMM Story Context Assembly Instructions (v6) -->
|
||||
|
||||
```xml
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
<critical>Generate all documents in {document_output_language}</critical>
|
||||
@@ -181,7 +181,7 @@ All stories are either still in backlog or already marked ready/in-progress/done
|
||||
<step n="6" goal="Validate and save">
|
||||
<anchor id="validation_step" />
|
||||
<action>Validate output context file structure and content</action>
|
||||
<invoke-task>Validate against checklist at {installed_path}/checklist.md using bmad/core/tasks/validate-workflow.xml</invoke-task>
|
||||
<invoke-task>Validate against checklist at {installed_path}/checklist.md using {bmad_folder}/core/tasks/validate-workflow.xml</invoke-task>
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Update story file and mark ready for dev" tag="sprint-status">
|
||||
|
||||
@@ -4,16 +4,16 @@ description: "Assemble a dynamic Story Context XML by pulling latest documentati
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
document_output_language: "{config_source}:document_output_language"
|
||||
story_path: "{config_source}:dev_story_location"
|
||||
story_path: "{config_source}:dev_ephemeral_location"
|
||||
date: system-generated
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/4-implementation/story-context"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/story-context"
|
||||
template: "{installed_path}/context-template.xml"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
@@ -21,7 +21,7 @@ validation: "{installed_path}/checklist.md"
|
||||
# Variables and inputs
|
||||
variables:
|
||||
story_path: "" # Optional: Explicit story path. If not provided, finds first story with status "drafted"
|
||||
story_dir: "{config_source}:dev_story_location"
|
||||
story_dir: "{config_source}:dev_ephemeral_location"
|
||||
|
||||
# Smart input file references - handles both whole docs and sharded docs
|
||||
# Priority: Whole document first, then sharded version
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Story Approved Workflow Instructions (DEV Agent)
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
|
||||
|
||||
@@ -4,20 +4,20 @@ description: "Marks a story as done (DoD complete) and moves it from its current
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
date: system-generated
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/4-implementation/story-done"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/story-done"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
|
||||
# Variables and inputs
|
||||
variables:
|
||||
story_path: "" # Explicit path to story file
|
||||
story_dir: "{config_source}:dev_story_location" # Directory where stories are stored
|
||||
story_dir: "{config_source}:dev_ephemeral_location" # Directory where stories are stored
|
||||
|
||||
# Output configuration - no output file, just status updates
|
||||
default_output_file: ""
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Story Ready Workflow Instructions (SM Agent)
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>The workflow execution engine is governed by: {project_root}/{bmad_folder}/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
|
||||
<critical>Communicate all responses in {communication_language} and language MUST be tailored to {user_skill_level}</critical>
|
||||
<critical>Generate all documents in {document_output_language}</critical>
|
||||
|
||||
@@ -4,20 +4,20 @@ description: "Marks a drafted story as ready for development and moves it from T
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/bmad/bmgd/config.yaml"
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
date: system-generated
|
||||
|
||||
# Workflow components
|
||||
installed_path: "{project-root}/bmad/bmm/workflows/4-implementation/story-ready"
|
||||
installed_path: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/story-ready"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
|
||||
# Variables and inputs
|
||||
variables:
|
||||
story_path: "" # Explicit path to story file
|
||||
story_dir: "{config_source}:dev_story_location" # Directory where stories are stored
|
||||
story_dir: "{config_source}:dev_ephemeral_location" # Directory where stories are stored
|
||||
|
||||
# Output configuration - no output file, just status updates
|
||||
default_output_file: ""
|
||||
|
||||
@@ -14,17 +14,14 @@ prompt:
|
||||
## communication_language
|
||||
## output_folder
|
||||
## bmad_folder
|
||||
## install_user_docs
|
||||
## kb_install
|
||||
|
||||
project_name:
|
||||
prompt: "What is the title of your project you will be working on?"
|
||||
default: "{directory_name}"
|
||||
result: "{value}"
|
||||
|
||||
include_game_planning:
|
||||
prompt: "Include Game Planning Agents and Workflows?"
|
||||
default: false
|
||||
result: "{value}"
|
||||
|
||||
user_skill_level:
|
||||
prompt:
|
||||
- "What is your technical experience level?"
|
||||
@@ -42,29 +39,19 @@ user_skill_level:
|
||||
|
||||
tech_docs:
|
||||
prompt: "Where is Technical Documentation located within the project?"
|
||||
default: "docs"
|
||||
default: "{output_folder}/technical"
|
||||
result: "{project-root}/{value}"
|
||||
|
||||
dev_story_location:
|
||||
prompt: "Where should development stories be stored?"
|
||||
default: "docs/stories"
|
||||
dev_ephemeral_location:
|
||||
prompt: "Where should ephemeral development artifacts be stored (stories, epics, temp context, etc...)?"
|
||||
default: "{bmad_folder}-ephemeral"
|
||||
result: "{project-root}/{value}"
|
||||
|
||||
install_user_docs:
|
||||
prompt: "Install user documentation to project directory?"
|
||||
default: true
|
||||
result: "{value}"
|
||||
|
||||
# TEA Agent Configuration
|
||||
tea_use_mcp_enhancements:
|
||||
prompt: "Enable Playwright MCP capabilities (healing, exploratory, verification)?"
|
||||
prompt: "Enable Test Architect Playwright MCP capabilities (healing, exploratory, verification)?"
|
||||
default: false
|
||||
result: "{value}"
|
||||
# kb_location:
|
||||
# prompt: "Where should bmad knowledge base articles be stored?"
|
||||
# default: "~/bmad/bmm/kb.md"
|
||||
# result: "{value}"
|
||||
|
||||
# desired_mcp_tools:
|
||||
# prompt:
|
||||
# - "Which MCP Tools will you be using? (Select all that apply)"
|
||||
|
||||
@@ -63,9 +63,9 @@ async function install(options) {
|
||||
}
|
||||
|
||||
// Create dev story location if configured
|
||||
if (config['dev_story_location']) {
|
||||
if (config['dev_ephemeral_location']) {
|
||||
// Strip {project-root}/ prefix if present
|
||||
const storyConfig = config['dev_story_location'].replace('{project-root}/', '');
|
||||
const storyConfig = config['dev_ephemeral_location'].replace('{project-root}/', '');
|
||||
const storyPath = path.join(projectRoot, storyConfig);
|
||||
if (!(await fs.pathExists(storyPath))) {
|
||||
logger.log(chalk.yellow(`Creating story directory: ${storyConfig}`));
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmm/agents/analyst.md
|
||||
id: "{bmad_folder}/bmm/agents/analyst.md"
|
||||
name: Mary
|
||||
title: Business Analyst
|
||||
icon: 📊
|
||||
@@ -19,25 +19,25 @@ agent:
|
||||
|
||||
menu:
|
||||
- trigger: workflow-init
|
||||
workflow: "{project-root}/bmad/bmm/workflows/workflow-status/init/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/workflow-status/init/workflow.yaml"
|
||||
description: Start a new sequenced workflow path
|
||||
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: Check workflow status and get recommendations (START HERE!)
|
||||
|
||||
- trigger: brainstorm-project
|
||||
workflow: "{project-root}/bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml"
|
||||
description: Guide me through Brainstorming
|
||||
|
||||
- trigger: product-brief
|
||||
workflow: "{project-root}/bmad/bmm/workflows/1-analysis/product-brief/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/1-analysis/product-brief/workflow.yaml"
|
||||
description: Produce Project Brief
|
||||
|
||||
- trigger: document-project
|
||||
workflow: "{project-root}/bmad/bmm/workflows/document-project/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/document-project/workflow.yaml"
|
||||
description: Generate comprehensive documentation of an existing Project
|
||||
|
||||
- trigger: research
|
||||
workflow: "{project-root}/bmad/bmm/workflows/1-analysis/research/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/1-analysis/research/workflow.yaml"
|
||||
description: Guide me through Research
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmm/agents/architect.md
|
||||
id: "{bmad_folder}/bmm/agents/architect.md"
|
||||
name: Winston
|
||||
title: Architect
|
||||
icon: 🏗️
|
||||
@@ -19,19 +19,19 @@ agent:
|
||||
|
||||
menu:
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: Check workflow status and get recommendations
|
||||
|
||||
- trigger: create-architecture
|
||||
workflow: "{project-root}/bmad/bmm/workflows/3-solutioning/architecture/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/architecture/workflow.yaml"
|
||||
description: Produce a Scale Adaptive Architecture
|
||||
|
||||
- trigger: validate-architecture
|
||||
validate-workflow: "{project-root}/bmad/bmm/workflows/3-solutioning/architecture/workflow.yaml"
|
||||
checklist: "{project-root}/bmad/bmm/workflows/3-solutioning/architecture/checklist.md"
|
||||
validate-workflow: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/architecture/workflow.yaml"
|
||||
checklist: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/architecture/checklist.md"
|
||||
document: "{output_folder}/architecture.md"
|
||||
description: Validate Architecture Document
|
||||
|
||||
- trigger: solutioning-gate-check
|
||||
workflow: "{project-root}/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml"
|
||||
description: Validate solutioning complete, ready for Phase 4 (Level 2-4 only)
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmm/agents/dev.md
|
||||
id: "{bmad_folder}/bmm/agents/dev.md"
|
||||
name: Amelia
|
||||
title: Developer Agent
|
||||
icon: 💻
|
||||
@@ -27,17 +27,17 @@ agent:
|
||||
|
||||
menu:
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: "Check workflow status and get recommendations"
|
||||
|
||||
- trigger: develop-story
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/dev-story/workflow.yaml"
|
||||
description: "Execute Dev Story workflow, implementing tasks and tests, or performing updates to the story"
|
||||
|
||||
- trigger: story-done
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/story-done/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/story-done/workflow.yaml"
|
||||
description: "Mark story done after DoD complete"
|
||||
|
||||
- trigger: code-review
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/code-review/workflow.yaml"
|
||||
description: "Perform a thorough clean context QA code review on a story flagged Ready for Review"
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmm/agents/pm.md
|
||||
id: "{bmad_folder}/bmm/agents/pm.md"
|
||||
name: John
|
||||
title: Product Manager
|
||||
icon: 📋
|
||||
@@ -24,37 +24,37 @@ agent:
|
||||
# help and exit are auto-injected, don't define them here
|
||||
menu:
|
||||
- trigger: workflow-init
|
||||
workflow: "{project-root}/bmad/bmm/workflows/workflow-status/init/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/workflow-status/init/workflow.yaml"
|
||||
description: Start a new sequenced workflow path
|
||||
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: Check workflow status and get recommendations (START HERE!)
|
||||
|
||||
- trigger: create-prd
|
||||
workflow: "{project-root}/bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/workflow.yaml"
|
||||
description: Create Product Requirements Document (PRD) for Level 2-4 projects
|
||||
|
||||
- trigger: create-epics-and-stories
|
||||
workflow: "{project-root}/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml"
|
||||
description: Break PRD requirements into implementable epics and stories
|
||||
|
||||
- trigger: validate-prd
|
||||
validate-workflow: "{project-root}/bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml"
|
||||
checklist: "{project-root}/bmad/bmm/workflows/2-plan-workflows/prd/checklist.md"
|
||||
validate-workflow: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/workflow.yaml"
|
||||
checklist: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/prd/checklist.md"
|
||||
document: "{output_folder}/PRD.md"
|
||||
description: Validate PRD + Epics + Stories completeness and quality
|
||||
|
||||
- trigger: tech-spec
|
||||
workflow: "{project-root}/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml"
|
||||
description: Create Tech Spec for Level 0-1 (sometimes Level 2) projects
|
||||
|
||||
- trigger: validate-tech-spec
|
||||
validate-workflow: "{project-root}/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml"
|
||||
checklist: "{project-root}/bmad/bmm/workflows/2-plan-workflows/tech-spec/checklist.md"
|
||||
validate-workflow: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml"
|
||||
checklist: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/tech-spec/checklist.md"
|
||||
document: "{output_folder}/tech-spec.md"
|
||||
description: Validate Technical Specification Document
|
||||
|
||||
- trigger: correct-course
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/correct-course/workflow.yaml"
|
||||
description: Course Correction Analysis
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmm/agents/sm.md
|
||||
id: "{bmad_folder}/bmm/agents/sm.md"
|
||||
name: Bob
|
||||
title: Scrum Master
|
||||
icon: 🏃
|
||||
@@ -22,46 +22,46 @@ agent:
|
||||
|
||||
menu:
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: Check workflow status and get recommendations
|
||||
|
||||
- trigger: sprint-planning
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
|
||||
description: Generate or update sprint-status.yaml from epic files
|
||||
|
||||
- trigger: epic-tech-context
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml"
|
||||
description: (Optional) Use the PRD and Architecture to create a Epic-Tech-Spec for a specific epic
|
||||
|
||||
- trigger: validate-epic-tech-context
|
||||
validate-workflow: "{project-root}/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml"
|
||||
validate-workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml"
|
||||
description: (Optional) Validate latest Tech Spec against checklist
|
||||
|
||||
- trigger: create-story
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/create-story/workflow.yaml"
|
||||
description: Create a Draft Story
|
||||
|
||||
- trigger: validate-create-story
|
||||
validate-workflow: "{project-root}/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml"
|
||||
validate-workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/create-story/workflow.yaml"
|
||||
description: (Optional) Validate Story Draft with Independent Review
|
||||
|
||||
- trigger: story-context
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/story-context/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/story-context/workflow.yaml"
|
||||
description: (Optional) Assemble dynamic Story Context (XML) from latest docs and code and mark story ready for dev
|
||||
|
||||
- trigger: validate-story-context
|
||||
validate-workflow: "{project-root}/bmad/bmm/workflows/4-implementation/story-context/workflow.yaml"
|
||||
validate-workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/story-context/workflow.yaml"
|
||||
description: (Optional) Validate latest Story Context XML against checklist
|
||||
|
||||
- trigger: story-ready-for-dev
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/story-ready/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/story-ready/workflow.yaml"
|
||||
description: (Optional) Mark drafted story ready for dev without generating Story Context
|
||||
|
||||
- trigger: epic-retrospective
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml"
|
||||
data: "{project-root}/bmad/_cfg/agent-manifest.csv"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/retrospective/workflow.yaml"
|
||||
data: "{project-root}/{bmad_folder}/_cfg/agent-manifest.csv"
|
||||
description: (Optional) Facilitate team retrospective after an epic is completed
|
||||
|
||||
- trigger: correct-course
|
||||
workflow: "{project-root}/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/4-implementation/correct-course/workflow.yaml"
|
||||
description: (Optional) Execute correct-course task
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmm/agents/tea.md
|
||||
id: "{bmad_folder}/bmm/agents/tea.md"
|
||||
name: Murat
|
||||
title: Master Test Architect
|
||||
icon: 🧪
|
||||
@@ -17,43 +17,43 @@ agent:
|
||||
- Testing is feature work. Prioritize unit/integration over E2E. Flakiness is critical debt. ATDD tests first, AI implements, suite validates.
|
||||
|
||||
critical_actions:
|
||||
- "Consult {project-root}/bmad/bmm/testarch/tea-index.csv to select knowledge fragments under `knowledge/` and load only the files needed for the current task"
|
||||
- "Load the referenced fragment(s) from `{project-root}/bmad/bmm/testarch/knowledge/` before giving recommendations"
|
||||
- "Cross-check recommendations with the current official Playwright, Cypress, Pact, and CI platform documentation; fall back to {project-root}/bmad/bmm/testarch/test-resources-for-ai-flat.txt only when deeper sourcing is required"
|
||||
- "Consult {project-root}/{bmad_folder}/bmm/testarch/tea-index.csv to select knowledge fragments under `knowledge/` and load only the files needed for the current task"
|
||||
- "Load the referenced fragment(s) from `{project-root}/{bmad_folder}/bmm/testarch/knowledge/` before giving recommendations"
|
||||
- "Cross-check recommendations with the current official Playwright, Cypress, Pact, and CI platform documentation; fall back to {project-root}/{bmad_folder}/bmm/testarch/test-resources-for-ai-flat.txt only when deeper sourcing is required"
|
||||
|
||||
menu:
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: Check workflow status and get recommendations
|
||||
|
||||
- trigger: framework
|
||||
workflow: "{project-root}/bmad/bmm/workflows/testarch/framework/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/testarch/framework/workflow.yaml"
|
||||
description: Initialize production-ready test framework architecture
|
||||
|
||||
- trigger: atdd
|
||||
workflow: "{project-root}/bmad/bmm/workflows/testarch/atdd/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/testarch/atdd/workflow.yaml"
|
||||
description: Generate E2E tests first, before starting implementation
|
||||
|
||||
- trigger: automate
|
||||
workflow: "{project-root}/bmad/bmm/workflows/testarch/automate/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/testarch/automate/workflow.yaml"
|
||||
description: Generate comprehensive test automation
|
||||
|
||||
- trigger: test-design
|
||||
workflow: "{project-root}/bmad/bmm/workflows/testarch/test-design/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/testarch/test-design/workflow.yaml"
|
||||
description: Create comprehensive test scenarios
|
||||
|
||||
- trigger: trace
|
||||
workflow: "{project-root}/bmad/bmm/workflows/testarch/trace/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/testarch/trace/workflow.yaml"
|
||||
description: Map requirements to tests (Phase 1) and make quality gate decision (Phase 2)
|
||||
|
||||
- trigger: nfr-assess
|
||||
workflow: "{project-root}/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/testarch/nfr-assess/workflow.yaml"
|
||||
description: Validate non-functional requirements
|
||||
|
||||
- trigger: ci
|
||||
workflow: "{project-root}/bmad/bmm/workflows/testarch/ci/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/testarch/ci/workflow.yaml"
|
||||
description: Scaffold CI/CD quality pipeline
|
||||
|
||||
- trigger: test-review
|
||||
workflow: "{project-root}/bmad/bmm/workflows/testarch/test-review/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/testarch/test-review/workflow.yaml"
|
||||
description: Review test quality using comprehensive knowledge base and best practices
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmm/agents/tech-writer.md
|
||||
id: "{bmad_folder}/bmm/agents/tech-writer.md"
|
||||
name: paige
|
||||
title: Technical Writer
|
||||
icon: 📚
|
||||
@@ -20,7 +20,7 @@ agent:
|
||||
|
||||
critical_actions:
|
||||
- "CRITICAL: Load COMPLETE file {project-root}/src/modules/bmm/workflows/techdoc/documentation-standards.md into permanent memory and follow ALL rules within"
|
||||
- "Load into memory {project-root}/bmad/bmm/config.yaml and set variables"
|
||||
- "Load into memory {project-root}/{bmad_folder}/bmm/config.yaml and set variables"
|
||||
- "Remember the user's name is {user_name}"
|
||||
- "ALWAYS communicate in {communication_language}"
|
||||
- "ALWAYS write documentation in {document_output_language}"
|
||||
@@ -29,7 +29,7 @@ agent:
|
||||
|
||||
menu:
|
||||
- trigger: document-project
|
||||
workflow: "{project-root}/bmad/bmm/workflows/document-project/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/document-project/workflow.yaml"
|
||||
description: Comprehensive project documentation (brownfield analysis, architecture scanning)
|
||||
|
||||
- trigger: create-api-docs
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: bmad/bmm/agents/ux-designer.md
|
||||
id: "{bmad_folder}/bmm/agents/ux-designer.md"
|
||||
name: Sally
|
||||
title: UX Designer
|
||||
icon: 🎨
|
||||
@@ -19,15 +19,15 @@ agent:
|
||||
|
||||
menu:
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: Check workflow status and get recommendations (START HERE!)
|
||||
|
||||
- trigger: create-design
|
||||
workflow: "{project-root}/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml"
|
||||
workflow: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml"
|
||||
description: Conduct Design Thinking Workshop to Define the User Specification
|
||||
|
||||
- trigger: validate-design
|
||||
validate-workflow: "{project-root}/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml"
|
||||
checklist: "{project-root}/bmad/bmm/workflows/2-plan-workflows/create-ux-design/checklist.md"
|
||||
validate-workflow: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml"
|
||||
checklist: "{project-root}/{bmad_folder}/bmm/workflows/2-plan-workflows/create-ux-design/checklist.md"
|
||||
document: "{output_folder}/ux-spec.md"
|
||||
description: Validate UX Specification and Design Artifacts
|
||||
|
||||
@@ -629,14 +629,14 @@ You can customize any agent's personality without modifying core agent files.
|
||||
|
||||
### Location
|
||||
|
||||
**Customization Directory:** `{project-root}/bmad/_cfg/agents/`
|
||||
**Customization Directory:** `{project-root}/{bmad_folder}/_cfg/agents/`
|
||||
|
||||
**Naming Convention:** `{module}-{agent-name}.customize.yaml`
|
||||
|
||||
**Examples:**
|
||||
|
||||
```
|
||||
bmad/_cfg/agents/
|
||||
{bmad_folder}/_cfg/agents/
|
||||
├── bmm-pm.customize.yaml
|
||||
├── bmm-dev.customize.yaml
|
||||
├── cis-storyteller.customize.yaml
|
||||
@@ -736,9 +736,9 @@ Other agents collaborate with PM's specialized perspective.
|
||||
|
||||
```bash
|
||||
# Create customization file at:
|
||||
# {project-root}/bmad/_cfg/agents/{module}-{agent-name}.customize.yaml
|
||||
# {project-root}/{bmad_folder}/_cfg/agents/{module}-{agent-name}.customize.yaml
|
||||
|
||||
# Example: bmad/_cfg/agents/bmm-pm.customize.yaml
|
||||
# Example: {bmad_folder}/_cfg/agents/bmm-pm.customize.yaml
|
||||
```
|
||||
|
||||
**Step 2: Regenerate Agent Manifest**
|
||||
|
||||
@@ -137,7 +137,7 @@ If you have documentation but files are huge (>500 lines, 10+ level 2 sections):
|
||||
|
||||
```bash
|
||||
# Load BMad Master or any agent
|
||||
bmad/core/tools/shard-doc.xml --input docs/massive-doc.md
|
||||
{bmad_folder}/core/tools/shard-doc.xml --input docs/massive-doc.md
|
||||
```
|
||||
|
||||
- Splits on level 2 sections by default
|
||||
@@ -147,7 +147,7 @@ If you have documentation but files are huge (>500 lines, 10+ level 2 sections):
|
||||
2. **Then:** Run `index-docs` task to create navigation:
|
||||
|
||||
```bash
|
||||
bmad/core/tasks/index-docs.xml --directory ./docs
|
||||
{bmad_folder}/core/tasks/index-docs.xml --directory ./docs
|
||||
```
|
||||
|
||||
3. **Finally:** Validate quality - if sharded docs still seem incomplete/outdated → Run `document-project`
|
||||
@@ -210,7 +210,7 @@ If you have **good, current documentation** but it's in massive files:
|
||||
|
||||
```bash
|
||||
# For each massive doc (>500 lines or 10+ level 2 sections)
|
||||
bmad/core/tools/shard-doc.xml \
|
||||
{bmad_folder}/core/tools/shard-doc.xml \
|
||||
--input docs/api-documentation.md \
|
||||
--output docs/api/ \
|
||||
--level 2 # Split on ## headers (default)
|
||||
@@ -219,7 +219,7 @@ bmad/core/tools/shard-doc.xml \
|
||||
**Step 2: Generate index**
|
||||
|
||||
```bash
|
||||
bmad/core/tasks/index-docs.xml --directory ./docs
|
||||
{bmad_folder}/core/tasks/index-docs.xml --directory ./docs
|
||||
```
|
||||
|
||||
**Step 3: Validate**
|
||||
|
||||
@@ -419,7 +419,7 @@ Team C (2 devs): Analytics feature (3 epics)
|
||||
|
||||
**Problem:** Teams customize BMad (agents, workflows, configs) but don't want personal tooling in main repo.
|
||||
|
||||
**Anti-pattern:** Adding `bmad/` to `.gitignore` breaks IDE tools, submodule management.
|
||||
**Anti-pattern:** Adding `{bmad_folder}/` to `.gitignore` breaks IDE tools, submodule management.
|
||||
|
||||
### The Solution: Git Submodules
|
||||
|
||||
@@ -457,7 +457,7 @@ git commit -m "Add BMM as submodule"
|
||||
git clone https://github.com/your-org/your-project.git
|
||||
cd your-project
|
||||
git submodule update --init --recursive
|
||||
# Make personal customizations in bmad/
|
||||
# Make personal customizations in {bmad_folder}/
|
||||
```
|
||||
|
||||
### Daily Workflow
|
||||
@@ -466,7 +466,7 @@ git submodule update --init --recursive
|
||||
|
||||
```bash
|
||||
cd /path/to/your-project
|
||||
# BMad available at ./bmad/, load agents normally
|
||||
# BMad available at ./{bmad_folder}/, load agents normally
|
||||
```
|
||||
|
||||
**Update personal config:**
|
||||
|
||||
@@ -403,7 +403,7 @@ See [IDE Setup Guides](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/do
|
||||
|
||||
### Q: Can I customize agents?
|
||||
|
||||
**A:** Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `bmad/_cfg/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options.
|
||||
**A:** Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `{bmad_folder}/_cfg/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options.
|
||||
|
||||
**Note:** While source agents in this repo are YAML, they install as `.md` files with XML-style tags - a format any LLM can read and follow.
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent), and su
|
||||
|
||||
**The basics:**
|
||||
|
||||
1. Party mode reads `bmad/_cfg/agent-manifest.csv`
|
||||
1. Party mode reads `{bmad_folder}/_cfg/agent-manifest.csv`
|
||||
2. Loads ALL installed agents (already includes your customizations from install)
|
||||
3. BMad Master orchestrates - picks 2-3 relevant agents per message based on topic
|
||||
4. Agents respond in character, can agree/disagree/build on each other's ideas
|
||||
@@ -126,11 +126,11 @@ _(Multiple perspectives reveal the right answer)_
|
||||
|
||||
## Agent Customization
|
||||
|
||||
Party mode uses agents from `bmad/[module]/agents/*.md` - these already include any customizations you applied during install.
|
||||
Party mode uses agents from `{bmad_folder}/[module]/agents/*.md` - these already include any customizations you applied during install.
|
||||
|
||||
**To customize agents for party mode:**
|
||||
|
||||
1. Create customization file: `bmad/_cfg/agents/bmm-pm.customize.yaml`
|
||||
1. Create customization file: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
|
||||
2. Run `npx bmad-method install` to rebuild agents
|
||||
3. Customizations now active in party mode
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user