Skip to content

Commit d563c87

Browse files
Brian MadisonBrian Madison
authored andcommitted
Add module-help.csv template file
Template with example structure and documentation comments to guide new module creation for the BMAD Help system
1 parent bf24ddf commit d563c87

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

src/module-help.csv

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# module-help.csv - Workflow Menu Configuration - REMOVE THESE COMMENTS
2+
# This example file defines all workflows in your module for the BMAD Help system
3+
#
4+
# Columns:
5+
# - module: Your module code (from module.yaml)
6+
# - phase: 'anytime' OR numbered phases `1-discover 2-define 3-build 4-ship` if sequential or named phases without a number if the sequence only matters within a phase but the phase order itself is stand alone or does not matter.
7+
# - name: Display name of the workflow
8+
# - code: 2-letter menu code (used for quick commands like /module:code:workflow-name)
9+
# - sequence: Order within phase (10, 20, 30...) IF ORDER MATTERS - for anytime or ordering not mattering, do not give it a sequence number
10+
# - workflow-file: Path to workflow.yaml or workflow.md
11+
# - command: Full command syntax (bmad:module-code:workflow-name)
12+
# - required: true/false - whether this workflow must complete before later phases
13+
# - agent: Agent name from agents/*.agent.yaml files
14+
# - options: Additional workflow options (e.g., "Create Mode")
15+
# - description: Brief description of what the workflow does
16+
# - output-location: Variable name from module.yaml for where outputs go
17+
# - outputs: Expected output artifact names
18+
#
19+
# IMPORTANT: Empty phase = anytime (universal tools work regardless of workflow state)
20+
#
21+
module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputs,
22+
# anytime workflows - available at any time
23+
code,anytime,Example Workflow,EW,10,_bmad/code/workflows/example/workflow.yaml,bmad:code:example-workflow,false,example-agent,Create Mode,"An example anytime workflow that can be run anytime",output_folder,"example output",
24+
# numbered phases - sequential workflow stages
25+
code,1-discover,Discovery Step,DS,10,_bmad/code/workflows/discovery/workflow.yaml,bmad:code:discovery,false,example-agent,Create Mode,"First phase of sequential workflow",output_folder,"discovery document",
26+
code,2-define,Definition Step,DS,10,_bmad/code/workflows/definition/workflow.yaml,bmad:code:definition,true,example-agent,Create Mode,"Required step before moving to next phase",output_folder,"definition document",
27+
code,3-build,Build Step,BS,10,_bmad/code/workflows/build/workflow.yaml,bmad:code:build,true,example-agent,Create Mode,"Build and implement phase",output_folder,"implementation",
28+
code,4-ship,Ship Step,SS,10,_bmad/code/workflows/ship/workflow.yaml,bmad:code:ship,false,example-agent,Create Mode,"Final delivery and release phase",output_folder,"release",

0 commit comments

Comments
 (0)