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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/CHANGELOG.md +219 -1105
  2. package/README.md +129 -359
  3. package/docs/custom-agent-installation.md +169 -0
  4. package/{v6-open-items.md → docs/v6-open-items.md} +1 -1
  5. package/package.json +4 -2
  6. package/src/core/resources/excalidraw/README.md +160 -0
  7. package/src/core/resources/excalidraw/library-loader.md +50 -0
  8. package/src/modules/bmb/docs/agent-compilation.md +340 -0
  9. package/src/modules/bmb/docs/agent-menu-patterns.md +524 -0
  10. package/src/modules/bmb/docs/expert-agent-architecture.md +364 -0
  11. package/src/modules/bmb/docs/index.md +55 -0
  12. package/src/modules/bmb/docs/module-agent-architecture.md +367 -0
  13. package/src/modules/bmb/docs/simple-agent-architecture.md +288 -0
  14. package/src/modules/bmb/docs/understanding-agent-types.md +184 -0
  15. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/README.md +242 -0
  16. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md +24 -0
  17. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md +108 -0
  18. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md +46 -0
  19. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md +39 -0
  20. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml +152 -0
  21. package/src/modules/bmb/reference/agents/module-examples/README.md +50 -0
  22. package/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml +53 -0
  23. package/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml +57 -0
  24. package/src/modules/bmb/reference/agents/simple-examples/README.md +223 -0
  25. package/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml +126 -0
  26. package/src/modules/bmb/reference/readme.md +3 -0
  27. package/src/modules/bmb/workflows/create-agent/agent-validation-checklist.md +174 -0
  28. package/src/modules/bmb/workflows/create-agent/brainstorm-context.md +99 -120
  29. package/src/modules/bmb/workflows/create-agent/communication-presets.csv +61 -0
  30. package/src/modules/bmb/workflows/create-agent/instructions.md +126 -65
  31. package/src/modules/bmb/workflows/create-agent/workflow.yaml +19 -12
  32. package/src/modules/bmb/workflows/edit-agent/README.md +174 -47
  33. package/src/modules/bmb/workflows/edit-agent/instructions.md +397 -33
  34. package/src/modules/bmb/workflows/edit-agent/workflow.yaml +24 -8
  35. package/src/modules/bmgd/workflows/4-production/story-context/workflow.yaml +1 -1
  36. package/src/modules/bmm/agents/analyst.agent.yaml +2 -2
  37. package/src/modules/bmm/agents/architect.agent.yaml +10 -2
  38. package/src/modules/bmm/agents/dev.agent.yaml +2 -2
  39. package/src/modules/bmm/agents/pm.agent.yaml +7 -3
  40. package/src/modules/bmm/agents/sm.agent.yaml +2 -2
  41. package/src/modules/bmm/agents/tea.agent.yaml +2 -2
  42. package/src/modules/bmm/agents/tech-writer.agent.yaml +15 -3
  43. package/src/modules/bmm/agents/ux-designer.agent.yaml +6 -2
  44. package/src/modules/bmm/docs/README.md +4 -0
  45. package/src/modules/bmm/docs/images/workflow-method-greenfield.excalidraw +5919 -0
  46. package/src/modules/bmm/docs/images/workflow-method-greenfield.svg +2 -0
  47. package/src/modules/bmm/docs/quick-start.md +6 -0
  48. package/src/modules/bmm/docs/scale-adaptive-system.md +6 -0
  49. package/src/modules/bmm/docs/workflows-implementation.md +10 -0
  50. package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.yaml +4 -4
  51. package/src/modules/bmm/workflows/{2-plan-workflows → 3-solutioning}/create-epics-and-stories/workflow.yaml +5 -5
  52. package/src/modules/bmm/workflows/4-implementation/story-context/workflow.yaml +1 -1
  53. package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-dataflow/instructions.md +7 -8
  54. package/src/modules/bmm/workflows/diagrams/create-dataflow/workflow.yaml +27 -0
  55. package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-diagram/instructions.md +9 -10
  56. package/src/modules/bmm/workflows/diagrams/create-diagram/workflow.yaml +27 -0
  57. package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-flowchart/instructions.md +4 -5
  58. package/src/modules/bmm/workflows/diagrams/create-flowchart/workflow.yaml +27 -0
  59. package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-wireframe/instructions.md +3 -3
  60. package/src/modules/bmm/workflows/diagrams/create-wireframe/workflow.yaml +27 -0
  61. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +18 -30
  62. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +2 -14
  63. package/src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml +2 -14
  64. package/src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml +2 -14
  65. package/src/modules/cis/agents/presentation-master.agent.yaml +60 -0
  66. package/tools/cli/commands/agent-install.js +409 -0
  67. package/tools/cli/installers/lib/core/installer.js +119 -0
  68. package/tools/cli/installers/lib/ide/_base-ide.js +25 -0
  69. package/tools/cli/installers/lib/ide/antigravity.js +463 -0
  70. package/tools/cli/installers/lib/ide/claude-code.js +43 -0
  71. package/tools/cli/installers/lib/ide/codex.js +217 -32
  72. package/tools/cli/installers/lib/ide/cursor.js +48 -0
  73. package/tools/cli/installers/lib/ide/github-copilot.js +74 -0
  74. package/tools/cli/installers/lib/ide/manager.js +35 -0
  75. package/tools/cli/installers/lib/ide/opencode.js +45 -0
  76. package/tools/cli/installers/lib/ide/windsurf.js +47 -0
  77. package/tools/cli/lib/agent/compiler.js +390 -0
  78. package/tools/cli/lib/agent/installer.js +725 -0
  79. package/tools/cli/lib/agent/template-engine.js +152 -0
  80. package/docs/installers-bundlers/web-bundler-usage.md +0 -54
  81. package/src/modules/bmb/workflows/create-agent/README.md +0 -203
  82. package/src/modules/bmb/workflows/create-agent/agent-architecture.md +0 -415
  83. package/src/modules/bmb/workflows/create-agent/agent-command-patterns.md +0 -759
  84. package/src/modules/bmb/workflows/create-agent/agent-types.md +0 -292
  85. package/src/modules/bmb/workflows/create-agent/checklist.md +0 -62
  86. package/src/modules/bmb/workflows/create-agent/communication-styles.md +0 -202
  87. package/src/modules/bmb/workflows/edit-agent/checklist.md +0 -112
  88. package/src/modules/bmb/workflows/redoc/README.md +0 -87
  89. package/src/modules/bmb/workflows/redoc/checklist.md +0 -99
  90. package/src/modules/bmb/workflows/redoc/instructions.md +0 -265
  91. package/src/modules/bmb/workflows/redoc/workflow.yaml +0 -34
  92. package/src/modules/bmm/agents/frame-expert.agent.yaml +0 -42
  93. package/src/modules/bmm/workflows/frame-expert/create-dataflow/workflow.yaml +0 -24
  94. package/src/modules/bmm/workflows/frame-expert/create-diagram/workflow.yaml +0 -25
  95. package/src/modules/bmm/workflows/frame-expert/create-flowchart/workflow.yaml +0 -28
  96. package/src/modules/bmm/workflows/frame-expert/create-wireframe/workflow.yaml +0 -24
  97. package/src/modules/bmm/workflows/workflow-status/paths/game-design.yaml +0 -52
  98. /package/src/{modules/bmm/workflows/frame-expert/_shared → core/resources/excalidraw}/excalidraw-helpers.md +0 -0
  99. /package/src/{modules/bmm/workflows/frame-expert/_shared → core/resources/excalidraw}/validate-json-instructions.md +0 -0
  100. /package/src/modules/bmm/workflows/{2-plan-workflows → 3-solutioning}/create-epics-and-stories/epics-template.md +0 -0
  101. /package/src/modules/bmm/workflows/{2-plan-workflows → 3-solutioning}/create-epics-and-stories/instructions.md +0 -0
  102. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/_shared/excalidraw-library.json +0 -0
  103. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/_shared/excalidraw-templates.yaml +0 -0
  104. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-dataflow/checklist.md +0 -0
  105. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-diagram/checklist.md +0 -0
  106. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-flowchart/checklist.md +0 -0
  107. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-wireframe/checklist.md +0 -0
@@ -1,87 +0,0 @@
1
- # ReDoc - Reverse-Tree Documentation Engine
2
-
3
- **Type:** Autonomous Action Workflow
4
- **Module:** BMad Builder (bmb)
5
-
6
- ## Purpose
7
-
8
- ReDoc is an intelligent documentation maintenance system for BMAD modules, workflows, and agents. It uses a reverse-tree approach (leaf folders first, then parent folders) to systematically generate and update README.md files with technical writer quality output.
9
-
10
- The workflow understands BMAD conventions deeply and focuses documentation on distinctive features rather than explaining standard patterns, resulting in succinct, precise technical documentation.
11
-
12
- ## Key Features
13
-
14
- - **Reverse-Tree Processing**: Documents from deepest folders up to module root, allowing child documentation to inform parent summaries
15
- - **Convention-Aware**: Loads BMAD architecture patterns and only documents unique/distinctive aspects
16
- - **Scalability**: Automatically creates catalog documents (WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md) for massive folders (>10 items)
17
- - **Diff-Aware**: Tracks `last-redoc-date` frontmatter to enable change detection since last run
18
- - **Autonomous**: Runs without user checkpoints unless clarification is genuinely required
19
- - **Comprehensive**: Reads ALL files completely before generating documentation (no partial reads)
20
-
21
- ## Usage
22
-
23
- Invoke with a target path:
24
-
25
- ```
26
- workflow redoc
27
- ```
28
-
29
- When prompted, provide one of:
30
-
31
- - **Module path**: `{bmad_folder}/bmm` (documents entire module: root, workflows, agents)
32
- - **Workflows folder**: `{bmad_folder}/bmm/workflows` (documents all workflows)
33
- - **Agents folder**: `{bmad_folder}/bmm/agents` (documents all agents)
34
- - **Single workflow**: `{bmad_folder}/bmm/workflows/product-brief` (documents one workflow)
35
- - **Single agent**: `{bmad_folder}/bmm/agents/prd-agent.md` (documents one agent)
36
-
37
- ## Inputs
38
-
39
- ### Required
40
-
41
- - **target_path**: Path to module, folder, or specific component to document
42
-
43
- ### Knowledge Base (Auto-loaded)
44
-
45
- - agent-architecture.md
46
- - agent-command-patterns.md
47
- - agent-types.md
48
- - module-structure.md
49
- - workflow-creation-guide.md
50
-
51
- ## Outputs
52
-
53
- ### Created/Updated Files
54
-
55
- - **README.md**: At each documented level (workflow folders, agent folders, module root)
56
- - **Catalog files**: WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md (for massive folders)
57
- - **Frontmatter**: All READMEs include `last-redoc-date: <timestamp>`
58
-
59
- ### Summary Report
60
-
61
- - Documentation coverage statistics
62
- - List of files created/updated
63
- - Any items requiring manual review
64
-
65
- ## Workflow Steps
66
-
67
- 1. **Initialize**: Load BMAD conventions and validate target
68
- 2. **Analyze Structure**: Build reverse-tree execution plan
69
- 3. **Process Leaves**: Document individual workflows/agents (deepest first)
70
- 4. **Process Folders**: Document workflow/agent collections with categorization
71
- 5. **Process Root**: Document module overview with links and highlights
72
- 6. **Validate**: Verify completeness and generate report
73
- 7. **Diff Analysis** (optional): Show changes since last redoc
74
- 8. **Complete**: Report success and suggest next steps
75
-
76
- ## Technical Details
77
-
78
- - **Execution**: Autonomous with minimal user interaction
79
- - **Quality**: Technical writer standards - succinct, precise, professional
80
- - **Context-Aware**: Uses BMAD convention knowledge to highlight only distinctive features
81
- - **Scalable**: Handles folders of any size with intelligent catalog creation
82
-
83
- ## Next Steps After Running
84
-
85
- 1. Review generated documentation for accuracy
86
- 2. If documenting a subfolder, run redoc on parent module to update references
87
- 3. Commit documentation updates with meaningful message
@@ -1,99 +0,0 @@
1
- # ReDoc Workflow Validation Checklist
2
-
3
- ## Initialization and Setup
4
-
5
- - [ ] All BMAD convention documents loaded and understood
6
- - [ ] Target path validated and exists
7
- - [ ] Target type correctly identified (module/workflow/agent/folder)
8
- - [ ] Documentation execution plan created with reverse-tree order
9
-
10
- ## File Analysis
11
-
12
- - [ ] All files in target scope read completely (no offset/limit usage)
13
- - [ ] Existing README.md files detected and last-redoc-date parsed
14
- - [ ] Massive folders (>10 items) identified for catalog document creation
15
- - [ ] Documentation depth levels calculated correctly
16
-
17
- ## Leaf-Level Documentation (Workflows)
18
-
19
- - [ ] Each workflow's ALL files read: workflow.yaml, instructions.md, template.md, checklist.md
20
- - [ ] README.md includes frontmatter with current last-redoc-date
21
- - [ ] Description is 2-4 paragraphs of technical writer quality
22
- - [ ] Focuses on DISTINCTIVE features, not BMAD boilerplate conventions
23
- - [ ] Includes "Usage" section with invocation command
24
- - [ ] Includes "Inputs" and "Outputs" sections where applicable
25
- - [ ] Succinct and precise language used throughout
26
-
27
- ## Leaf-Level Documentation (Agents)
28
-
29
- - [ ] Each agent file read completely including XML structure, commands, persona
30
- - [ ] README.md includes frontmatter with current last-redoc-date
31
- - [ ] Description is 1-3 paragraphs of technical writer quality
32
- - [ ] Lists all available commands clearly
33
- - [ ] Explains when to use this agent
34
- - [ ] Highlights unique capabilities vs standard agent patterns
35
-
36
- ## Mid-Level Documentation (Folders)
37
-
38
- - [ ] All child README.md files read before generating folder README
39
- - [ ] Workflows categorized logically if massive folder (>10 items)
40
- - [ ] Agents categorized by type if massive folder (>10 items)
41
- - [ ] Catalog documents (WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md) created for massive folders
42
- - [ ] Catalog documents include frontmatter with last-redoc-date
43
- - [ ] Folder README.md references catalog if one exists
44
- - [ ] Folder README.md is succinct (1-2 paragraphs + listings/links)
45
- - [ ] Notable/commonly-used items highlighted
46
-
47
- ## Root Module Documentation
48
-
49
- - [ ] Module config.yaml read and understood
50
- - [ ] Workflows and agents folder READMEs read before creating root README
51
- - [ ] Root README includes frontmatter with current last-redoc-date
52
- - [ ] Module purpose clearly stated in 2-3 sentences
53
- - [ ] Links to /workflows/README.md and /agents/README.md included
54
- - [ ] 2-3 key workflows mentioned with context
55
- - [ ] 2-3 key agents mentioned with context
56
- - [ ] Configuration section highlights UNIQUE settings only
57
- - [ ] Usage section explains invocation patterns
58
- - [ ] BMAD convention knowledge applied (describes only distinctive aspects)
59
-
60
- ## Quality Standards
61
-
62
- - [ ] All documentation uses proper BMAD terminology
63
- - [ ] Technical writer quality: clear, concise, professional
64
- - [ ] No placeholder text or generic descriptions remain
65
- - [ ] All links are valid and correctly formatted
66
- - [ ] Frontmatter syntax is correct and dates are current
67
- - [ ] No redundant explanation of standard BMAD patterns
68
-
69
- ## Validation and Reporting
70
-
71
- - [ ] All planned documentation items created/updated
72
- - [ ] Frontmatter dates verified as current across all files
73
- - [ ] File paths and internal links validated
74
- - [ ] Summary report generated with counts and coverage
75
- - [ ] Files skipped (if any) documented with reasons
76
-
77
- ## Git Diff Analysis (Optional Step)
78
-
79
- - [ ] last-redoc-date timestamps extracted correctly
80
- - [ ] Git log queried for changes since last redoc
81
- - [ ] Modified files identified and reported
82
- - [ ] Findings presented clearly to user
83
-
84
- ## Final Validation
85
-
86
- - [ ] Documentation Coverage
87
- - All README.md files in scope created/updated
88
- - Catalog documents created where needed
89
- - No documentation gaps identified
90
-
91
- - [ ] Execution Quality
92
- - Reverse-tree order followed (leaf → root)
93
- - Autonomous execution (minimal user prompts)
94
- - Only clarification questions asked when truly necessary
95
-
96
- - [ ] Output Quality
97
- - Technical precision maintained throughout
98
- - Succinct descriptions (no verbose explanations)
99
- - Professional documentation standards met
@@ -1,265 +0,0 @@
1
- # ReDoc Workflow Instructions
2
-
3
- <critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
4
- <critical>You MUST have already loaded and processed: {project-root}/src/modules/bmb/workflows/redoc/workflow.yaml</critical>
5
- <critical>Communicate in {communication_language} throughout the documentation process</critical>
6
- <critical>This is an AUTONOMOUS workflow - minimize user interaction unless clarification is absolutely required</critical>
7
- <critical>IMPORTANT: Process ONE document at a time to avoid token limits. Each README should be created individually, not batched.</critical>
8
- <critical>When using Task tool with sub-agents: Only request ONE workflow or agent documentation per invocation to prevent token overflow.</critical>
9
-
10
- <workflow>
11
-
12
- <step n="1" goal="Load BMAD conventions and initialize">
13
- <action>Load ALL BMAD convention documents from {bmad_conventions}:
14
- - agent_architecture.md - Understand agent XML structure and patterns
15
- - agent_command_patterns.md - Command syntax and activation patterns
16
- - agent_types.md - Standard agent categories and purposes
17
- - module_structure.md - Module organization and folder conventions
18
- - workflow_guide.md - Workflow structure and best practices
19
- </action>
20
-
21
- <action>Internalize these conventions so you can:
22
-
23
- - Recognize standard patterns vs unique implementations
24
- - Describe only what's distinctive about each component
25
- - Use proper terminology consistently
26
- - Write with technical precision
27
- </action>
28
-
29
- <action>Get target path from user:
30
-
31
- - Ask: "What do you want to document? (module path, workflow path, agent path, or folder path)"
32
- - Store as {{target_path}}
33
- </action>
34
-
35
- <action>Validate target path exists and determine target type:
36
-
37
- - Module root (contains config.yaml, /workflows, /agents folders)
38
- - Workflows folder (contains multiple workflow folders)
39
- - Agents folder (contains multiple agent .md files)
40
- - Single workflow folder (contains workflow.yaml)
41
- - Single agent file (.md)
42
- </action>
43
-
44
- <action>Store target type as {{target_type}} for conditional processing</action>
45
- </step>
46
-
47
- <step n="2" goal="Analyze directory structure and existing documentation">
48
- <action>Build complete tree structure of {{target_path}} using Glob and file system tools</action>
49
-
50
- <action>Identify all documentation points:
51
-
52
- - List all folders requiring README.md files
53
- - Detect existing README.md files
54
- - Parse frontmatter from existing READMEs to extract last-redoc-date
55
- - Calculate documentation depth (how many levels deep)
56
- </action>
57
-
58
- <action>Create documentation map with execution order (deepest → shallowest):
59
-
60
- - Level 0 (deepest): Individual workflow folders, individual agent files
61
- - Level 1: /workflows folder, /agents folder
62
- - Level 2 (root): Module root README.md
63
- </action>
64
-
65
- <action>Detect "massive folders" requiring child catalog documents:
66
-
67
- - Threshold: >10 items or complex categorization needed
68
- - Mark folders for catalog document creation (e.g., WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md)
69
- </action>
70
-
71
- <critical>Store execution order as {{doc_execution_plan}} - this ensures reverse-tree processing</critical>
72
- </step>
73
-
74
- <step n="3" goal="Process leaf-level documentation" repeat="for-each-leaf-item">
75
- <critical>TOKEN LIMIT WARNING: Process ONE item at a time to prevent token overflow issues.</critical>
76
- <critical>If using Task tool with sub-agents: NEVER batch multiple workflows/agents in a single invocation.</critical>
77
- <critical>Each README creation should be a separate operation with its own file save.</critical>
78
- <critical>Sequential processing is MANDATORY - do not attempt parallel documentation generation.</critical>
79
- <action>For each individual workflow folder in execution plan (PROCESS ONE AT A TIME):
80
- 1. Read ALL files completely:
81
- - workflow.yaml (metadata, purpose, configuration)
82
- - instructions.md (step structure, goals)
83
- - template.md (output structure) if exists
84
- - checklist.md (validation criteria) if exists
85
- - Any supporting data files
86
-
87
- 2. Synthesize understanding:
88
- - Core purpose and use case
89
- - Input requirements
90
- - Output produced
91
- - Unique characteristics (vs standard BMAD workflow patterns)
92
- - Key steps or special features
93
-
94
- 3. Generate/update README.md:
95
- - Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
96
- - Write 2-4 paragraph technical description
97
- - Include "Usage" section with invocation command
98
- - Include "Inputs" section if applicable
99
- - Include "Outputs" section
100
- - Be succinct and precise - technical writer quality
101
- - Focus on DISTINCTIVE features, not boilerplate
102
-
103
- 4. Save README.md to workflow folder
104
-
105
- <critical>If multiple workflows need documentation, process them SEQUENTIALLY not in parallel. Each workflow gets its own complete processing cycle.</critical>
106
- </action>
107
-
108
- <action>For each individual agent file in execution plan (PROCESS ONE AT A TIME):
109
-
110
- 1. Read agent definition file completely:
111
- - XML structure and metadata
112
- - Commands and their purposes
113
- - Activation patterns
114
- - Persona and communication style
115
- - Critical actions and workflows invoked
116
-
117
- 2. Synthesize understanding:
118
- - Agent purpose and role
119
- - Available commands
120
- - When to use this agent
121
- - Unique capabilities
122
-
123
- 3. Generate/update README.md (or agent-name-README.md if in shared folder):
124
- - Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
125
- - Write 1-3 paragraph technical description
126
- - Include "Commands" section listing available commands
127
- - Include "Usage" section
128
- - Focus on distinctive features
129
-
130
- 4. Save README.md
131
- </action>
132
-
133
- <action if="clarification needed about purpose or unique features">Ask user briefly, then continue</action>
134
- </step>
135
-
136
- <step n="4" goal="Process mid-level folder documentation" if="target_type requires folder docs">
137
- <action>For /workflows folder:
138
- 1. Read ALL workflow README.md files created in Step 3
139
- 2. Categorize workflows by purpose/type if folder is massive (>10 workflows):
140
- - Document generation workflows
141
- - Action workflows
142
- - Meta-workflows
143
- - Interactive workflows
144
-
145
- 3. If massive folder detected:
146
- - Create WORKFLOWS-CATALOG.md with categorized listings
147
- - Each entry: workflow name, 1-sentence description, link to folder
148
- - Add frontmatter with last-redoc-date
149
-
150
- 4. Generate/update /workflows/README.md:
151
- - Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
152
- - High-level summary of workflow collection
153
- - If catalog exists: reference it
154
- - If not massive: list all workflows with brief descriptions and links
155
- - Highlight notable or commonly-used workflows
156
- - Keep succinct (1-2 paragraphs + list)
157
-
158
- 5. Save README.md
159
- </action>
160
-
161
- <action>For /agents folder:
162
-
163
- 1. Read ALL agent README.md files
164
- 2. Categorize agents by type if massive folder (>10 agents):
165
- - Task agents
166
- - Meta agents
167
- - Specialized agents
168
- - Utility agents
169
-
170
- 3. If massive folder detected:
171
- - Create AGENTS-CATALOG.md with categorized listings
172
- - Each entry: agent name, 1-sentence description, link
173
- - Add frontmatter with last-redoc-date
174
-
175
- 4. Generate/update /agents/README.md:
176
- - Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
177
- - High-level summary of agent collection
178
- - If catalog exists: reference it
179
- - If not massive: list all agents with brief descriptions
180
- - Highlight key agents and their purposes
181
- - Keep succinct
182
-
183
- 5. Save README.md
184
- </action>
185
- </step>
186
-
187
- <step n="5" goal="Process root module documentation" if="target_type is module root">
188
- <action>For module root README.md:
189
- 1. Read module config.yaml for metadata and configuration
190
- 2. Read /workflows/README.md and /agents/README.md created in Step 4
191
- 3. Identify module's unique purpose within BMAD ecosystem
192
-
193
- 4. Generate/update module README.md:
194
- - Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
195
-
196
- Structure:
197
- - # Module Name
198
- - **Purpose**: 2-3 sentence high-level module purpose
199
- - **Overview**: 1-2 paragraphs describing what this module provides
200
-
201
- - ## Workflows
202
- - Link to /workflows/README.md with 1-sentence summary
203
- - Mention count and highlight 2-3 key workflows
204
-
205
- - ## Agents
206
- - Link to /agents/README.md with 1-sentence summary
207
- - Mention count and highlight 2-3 key agents
208
-
209
- - ## Configuration
210
- - Notable config.yaml settings if unique/important
211
- - Reference paths and conventions
212
-
213
- - ## Usage
214
- - How to invoke workflows or agents from this module
215
- - Prerequisites if any
216
-
217
- Focus on UNIQUE aspects using BMAD convention knowledge:
218
- - Don't explain standard BMAD patterns
219
- - Highlight what makes THIS module distinctive
220
- - Use proper BMAD terminology
221
-
222
- 5. Save README.md to module root
223
- </action>
224
- </step>
225
-
226
- <step n="6" goal="Validation and summary report">
227
- <action>Verify all planned documentation was created/updated:
228
- - Check each item in {{doc_execution_plan}}
229
- - Confirm frontmatter dates are current
230
- - Validate file paths and links
231
- </action>
232
-
233
- <action>Generate summary report showing:
234
-
235
- - Target documented: {{target_path}}
236
- - Target type: {{target_type}}
237
- - Documentation files created/updated (count and list)
238
- - Any catalog files created
239
- - Files skipped or requiring manual review (if any)
240
- - Coverage: X% of items documented
241
- - Processing notes: Confirm sequential processing was used to avoid token limits
242
- </action>
243
-
244
- <action>Display summary to user</action>
245
- </step>
246
-
247
- <step n="7" goal="Optional git diff analysis" optional="true">
248
- <ask>Would you like to see what changed since the last redoc run? [y/n]</ask>
249
-
250
- <action if="user_response == 'y'">
251
- For each README with last-redoc-date frontmatter:
252
- 1. Extract last-redoc-date timestamp
253
- 2. Use git log to find files modified since that date in the documented folder
254
- 3. Highlight files that changed but may need documentation updates
255
- 4. Report findings to user
256
- </action>
257
- </step>
258
-
259
- <step n="8" goal="Completion">
260
- <action>Confirm to {user_name} in {communication_language} that autonomous workflow execution is complete</action>
261
- <action>Provide path to all updated documentation</action>
262
- <action>Suggest next steps if needed</action>
263
- </step>
264
-
265
- </workflow>
@@ -1,34 +0,0 @@
1
- # ReDoc - Reverse-Tree Documentation Engine
2
- name: "redoc"
3
- description: "Autonomous documentation system that maintains module, workflow, and agent documentation using a reverse-tree approach (leaf folders first, then parents). Understands BMAD conventions and produces technical writer quality output."
4
- author: "BMad"
5
-
6
- # Critical variables
7
- config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
8
- user_name: "{config_source}:user_name"
9
- communication_language: "{config_source}:communication_language"
10
-
11
- # Required knowledge base - BMAD conventions and patterns
12
- bmad_conventions:
13
- agent_architecture: "{project-root}/src/modules/bmb/workflows/create-agent/agent-architecture.md"
14
- agent_command_patterns: "{project-root}/src/modules/bmb/workflows/create-agent/agent-command-patterns.md"
15
- agent_types: "{project-root}/src/modules/bmb/workflows/create-agent/agent-types.md"
16
- module_structure: "{project-root}/src/modules/bmb/workflows/create-module/module-structure.md"
17
- workflow_guide: "{project-root}/src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md"
18
-
19
- # Runtime inputs
20
- target_path: "" # User specifies: module path, workflow path, agent path, or folder path
21
-
22
- # Module path and component files
23
- installed_path: "{project-root}/src/modules/bmb/workflows/redoc"
24
- template: false # Action workflow - updates files in place
25
- instructions: "{installed_path}/instructions.md"
26
- validation: "{installed_path}/checklist.md"
27
-
28
- # Configuration
29
- autonomous: true # Runs without user checkpoints unless clarification needed
30
-
31
- standalone: true
32
-
33
- # Web bundle configuration
34
- web_bundle: false # BMB workflows run locally in BMAD-METHOD project
@@ -1,42 +0,0 @@
1
- # Frame Expert Agent Definition
2
-
3
- agent:
4
- webskip: true
5
- metadata:
6
- id: "{bmad_folder}/bmm/agents/frame-expert.md"
7
- name: Saif
8
- title: Visual Design & Diagramming Expert
9
- icon: 📐
10
- module: bmm
11
-
12
- persona:
13
- role: Expert Visual Designer & Diagramming Specialist
14
- identity: Expert who creates visual representations using Excalidraw with optimized, reusable components. Specializes in flowcharts, diagrams, wire-frames, ERDs, UML diagrams, mind maps, data flows, and API mappings.
15
- communication_style: Visual-first, structured, detail-oriented, composition-focused. Presents options as numbered lists for easy selection.
16
- principles: |
17
- - Composition Over Creation - Use reusable components and templates. Minimal Payload - Strip unnecessary metadata, optimize serialization.
18
- - Reference-Based Design - Use library references instead of redefining components. Structured Approach - Follow task-specific workflows for different diagram types.
19
- - Clean Output - Remove history, deleted elements, unused styles from final output. JSON Validation
20
- - Always validate JSON syntax after saving files using validation tool.
21
- - Error Recovery - NEVER delete files due to syntax errors, always fix them using error location information.
22
-
23
- menu:
24
- - trigger: flowchart
25
- workflow: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/create-flowchart/workflow.yaml"
26
- description: Create flowchart for processes, pipelines, or logic flows
27
-
28
- - trigger: diagram
29
- workflow: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/create-diagram/workflow.yaml"
30
- description: Create system architecture or general technical diagram
31
-
32
- - trigger: dataflow
33
- workflow: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/create-dataflow/workflow.yaml"
34
- description: Create data flow diagram
35
-
36
- - trigger: wireframe
37
- workflow: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/create-wireframe/workflow.yaml"
38
- description: Create website or app wireframe
39
-
40
- - trigger: party-mode
41
- workflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.yaml"
42
- description: Bring the whole team in to chat with other expert agents from the party
@@ -1,24 +0,0 @@
1
- name: create-dataflow
2
- description: "Create data flow diagrams (DFD) in Excalidraw format"
3
- author: "BMad"
4
-
5
- installed_path: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/create-dataflow"
6
- shared_path: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/_shared"
7
- instructions: "{installed_path}/instructions.md"
8
- validation: "{installed_path}/checklist.md"
9
-
10
- helpers: "{shared_path}/excalidraw-helpers.md"
11
- templates: "{shared_path}/excalidraw-templates.yaml"
12
- library: "{shared_path}/excalidraw-library.json"
13
-
14
- variables:
15
- dfd_level: ""
16
- process_count: ""
17
- datastore_count: ""
18
- external_entities: ""
19
- save_location: ""
20
-
21
- default_output_file: "{project-root}/docs/dataflow/dfd-{timestamp}.excalidraw"
22
-
23
- standalone: true
24
- web_bundle: false
@@ -1,25 +0,0 @@
1
- name: create-diagram
2
- description: "Create system architecture diagrams, ERDs, UML diagrams, or general technical diagrams in Excalidraw format"
3
- author: "BMad"
4
-
5
- installed_path: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/create-diagram"
6
- shared_path: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/_shared"
7
- instructions: "{installed_path}/instructions.md"
8
- validation: "{installed_path}/checklist.md"
9
-
10
- helpers: "{shared_path}/excalidraw-helpers.md"
11
- templates: "{shared_path}/excalidraw-templates.yaml"
12
- library: "{shared_path}/excalidraw-library.json"
13
-
14
- variables:
15
- diagram_type: ""
16
- component_count: ""
17
- relationship_type: ""
18
- notation_standard: ""
19
- save_location: ""
20
- theme_choice: ""
21
-
22
- default_output_file: "{project-root}/docs/diagrams/diagram-{timestamp}.excalidraw"
23
-
24
- standalone: true
25
- web_bundle: false
@@ -1,28 +0,0 @@
1
- name: create-flowchart
2
- description: "Create a flowchart visualization in Excalidraw format for processes, pipelines, or logic flows"
3
- author: "BMad"
4
-
5
- # Workflow components
6
- installed_path: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/create-flowchart"
7
- shared_path: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/_shared"
8
- instructions: "{installed_path}/instructions.md"
9
- validation: "{installed_path}/checklist.md"
10
-
11
- # Shared resources
12
- helpers: "{shared_path}/excalidraw-helpers.md"
13
- templates: "{shared_path}/excalidraw-templates.yaml"
14
- library: "{shared_path}/excalidraw-library.json"
15
-
16
- # Variables
17
- variables:
18
- flowchart_type: "" # Will be elicited
19
- complexity: "" # Will be elicited
20
- decision_points: "" # Will be elicited
21
- save_location: "" # Will be elicited
22
- theme_choice: "" # Will be elicited
23
- custom_colors: {} # For custom theme
24
-
25
- default_output_file: "{project-root}/docs/flowcharts/flowchart-{timestamp}.excalidraw"
26
-
27
- standalone: true
28
- web_bundle: false
@@ -1,24 +0,0 @@
1
- name: create-wireframe
2
- description: "Create website or app wireframes in Excalidraw format"
3
- author: "BMad"
4
-
5
- installed_path: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/create-wireframe"
6
- shared_path: "{project-root}/{bmad_folder}/bmm/workflows/frame-expert/_shared"
7
- instructions: "{installed_path}/instructions.md"
8
- validation: "{installed_path}/checklist.md"
9
-
10
- helpers: "{shared_path}/excalidraw-helpers.md"
11
- templates: "{shared_path}/excalidraw-templates.yaml"
12
- library: "{shared_path}/excalidraw-library.json"
13
-
14
- variables:
15
- wireframe_type: ""
16
- fidelity_level: ""
17
- screen_count: ""
18
- device_type: ""
19
- save_location: ""
20
-
21
- default_output_file: "{project-root}/docs/wireframes/wireframe-{timestamp}.excalidraw"
22
-
23
- standalone: true
24
- web_bundle: false