mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
feat: Add documentation guides, simplify folder structure, and major workflow refactoring
Created two comprehensive guides for v6 features:
**docs/agent-customization-guide.md**
- Complete guide for customizing agent names, personas, memories, and behaviors
- Update-safe customization via bmad/_cfg/agents/ configuration files
- Real-world examples (TDD setup, multilingual agents, custom workflows)
- Troubleshooting and best practices
**docs/web-bundles-gemini-gpt-guide.md**
- Comprehensive guide for using BMad agents in Gemini Gems and Custom GPTs
- Critical setup rules with exact configuration text required
- Cost-saving strategy: web planning → local implementation (60-80% savings)
- Platform comparison (Gemini Gems strongly recommended over Custom GPTs)
- Complete workflow examples showing full planning-to-implementation cycle
- Team bundle guidance (Gemini 2.5 Pro+ only)
**README.md updates**
- Added prominent links in v6 Core Enhancements section
- Created new "Customization & Sharing" documentation category
- Web Bundles feature highlighted with direct guide link
**Unified output folder structure across all modules:**
**Before (confusing):**
- output_folder: Main docs
- game_design_docs: Separate design folder
- tech_docs: Separate technical folder
- dev_ephemeral_location: Separate ephemeral folder outside docs
**After (simplified):**
- output_folder: Single location for ALL AI-generated artifacts (default: "docs")
- Clearer prompt: "Where should AI Generated Artifacts be saved?"
- sprint_artifacts: Phase 4 ephemeral content now WITHIN output_folder
- BMM: {output_folder}/stories (stories, context, reports)
- BMGD: {output_folder}/sprint-artifacts
- No longer in separate {bmad_folder}-ephemeral location
**Benefits:**
- One clear location for all planning artifacts (PRD, Architecture, UX, etc.)
- Phase 4 ephemeral items logically grouped within output folder
- Eliminated confusing separate folder proliferation
- sprint_artifacts now configurable per module
**Files changed:**
- src/core/_module-installer/install-config.yaml
- src/modules/bmm/_module-installer/install-config.yaml
- src/modules/bmgd/_module-installer/install-config.yaml
**Also cleaned up BMGD config:**
- Renamed: specified_framework → primary_platform (clearer naming)
- Removed: unused data_path variable
Replaced old "project_level" (0-4) system with new "selected_track" terminology:
- **quick-flow**: Bug fixes and small features (replaces Level 0-1)
- **bmad-method**: Full planning track (replaces Level 2-3)
- **enterprise-bmad-method**: Extended planning (replaces Level 4)
**Core workflow updates:**
- solutioning-gate-check: Complete rewrite of validation logic for track-based artifacts
- architecture: Updated context detection, error handling, and messaging for tracks
- workflow-init: Updated artifact detection patterns for track-based paths
- All workflow status paths updated (method-greenfield, method-brownfield, enterprise-*)
Unified variable naming conventions across all workflows:
- {output_folder} → {output-folder} (hyphenated format)
- {dev_ephemeral_location} → {sprint_artifacts} (clearer purpose)
- Hardcoded status file paths → {workflow_status_file} variable
Fixed corrupted variable patterns throughout workflow files:
- {output*folder} → {output-folder}
- {ephemeral*location} → {sprint_artifacts}
- \_prd* → *prd* (escaped underscore artifacts)
- **\*\***\_\_\_**\*\*** → proper field placeholders
Affected patterns included malformed glob patterns, template variables, and markdown formatting artifacts from previous edits.
**Architecture workflow (create-architecture):**
- Fixed: "Decision Architecture" → "Create Architecture" (consistent naming)
- Improved PRD not found handling with exit/continue options
- Better user guidance when running standalone vs. within workflow path
- Removed hardcoded Level checks, now track-aware
- Enhanced validation checklist formatting (□ → - [])
- Typo fixes: "mulitple" → "multiple"
**Solutioning gate check:**
- Complete validation logic rewrite for track-based system
- Removed Level-specific artifact expectations
- Simplified document discovery (track determines what exists)
- Better analysis prompts and user feedback
**Workflow-init:**
- Updated artifact detection patterns for new folder structure
- Fixed corrupt glob patterns throughout
- Better sprint_artifacts location detection
- Improved workflow path assignment logic
**Various workflows:**
- Consistent variable naming across 40+ workflow files
- Improved error messages and user guidance
- Better markdown formatting (checkboxes, lists)
- Removed redundant validation criteria files (now inline)
Removed duplicate BMGD 4-production workflows (12 workflows):
- code-review, correct-course, create-story, dev-story
- epic-tech-context, retrospective, sprint-planning
- story-context, story-done, story-ready
**Why:** BMGD now uses shared BMM Phase 4 implementation workflows
**Benefit:** Single source of truth, no duplication to maintain
Also removed:
- validation-criteria.yaml (validation now inline in instructions)
- architecture-patterns.yaml references (patterns now managed differently)
- AUDIT-REPORT.md files (stale audit artifacts)
**BMB workflows:**
- Updated checklists for workflow and module creation
- Improved agent architecture documentation
- Minor instruction clarifications
**Core brainstorming workflow:**
- Updated README with usage examples
- Enhanced instructions and template clarity
- Better integration with other modules
**BMM installer:**
- Updated for track-based system
- sprint_artifacts configuration
**Tech Writer agent:**
- Minor configuration update for documentation workflows
Removed 200+ files that should not be in repository:
- Installed agent markdown files (analyst, architect, dev, pm, sm, tea, etc.)
- Complete workflow instruction copies
- Documentation duplicates (quick-start, agents-guide, workflows-*)
- Test architecture knowledge base (22 files, 14,000+ lines)
- Configuration files (config.yaml, team definitions)
These are generated during installation and should not be version controlled.
Removed 21 pre-generated XML bundles:
- BMM agents (analyst, architect, dev, pm, sm, tea, tech-writer, ux-designer)
- BMGD agents (game-architect, game-designer, game-dev, game-scrum-master)
- CIS agents (brainstorming-coach, creative-problem-solver, etc.)
- Team bundles (team-fullstack, team-gamedev, creative-squad)
**Why:** Users should generate fresh bundles via `npm run bundle` to get latest changes and customizations.
- **2 new documentation files** (comprehensive guides)
- **98 source files modified** (299 insertions, 6,567 deletions)
- **3 installer config files simplified** (major folder structure improvement)
- **200+ .bmad/ artifacts removed** (should not be in repo)
- **21 web-bundle files removed** (users regenerate as needed)
- **12 duplicate workflows removed** (BMGD consolidation)
- **40+ workflows updated** (track system, variable standardization, corruption fixes)
This commit is contained in:
@@ -125,10 +125,9 @@ _List any cleanup recommendations:_
|
||||
|
||||
## Audit Summary
|
||||
|
||||
**Total Checks:** 72
|
||||
**Passed:** **\_** / 72
|
||||
**Failed:** **\_** / 72
|
||||
**Pass Rate:** **\_**%
|
||||
**Total Checks:**
|
||||
**Passed:** {total}
|
||||
**Failed:** {total}
|
||||
|
||||
**Recommendation:**
|
||||
|
||||
|
||||
@@ -7,10 +7,6 @@ _LLM-Optimized Technical Documentation for Agent Building_
|
||||
### Minimal Valid Agent
|
||||
|
||||
```xml
|
||||
<!-- Powered by BMAD-CORE™ -->
|
||||
|
||||
# Agent Name
|
||||
|
||||
<agent id="path/to/agent.md" name="Name" title="Title" icon="🤖">
|
||||
<persona>
|
||||
<role>My primary function</role>
|
||||
|
||||
@@ -186,8 +186,7 @@ Note any interaction preferences for future workflow creation.
|
||||
- New workflows needed: Note that they'll be created with intent-based + interactive defaults unless specified
|
||||
</action>
|
||||
|
||||
<example>
|
||||
```yaml
|
||||
<example type='yaml'>
|
||||
menu:
|
||||
# Commands emerge from discussion
|
||||
- trigger: [emerging from conversation]
|
||||
@@ -200,9 +199,7 @@ menu:
|
||||
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]
|
||||
|
||||
`````
|
||||
</example>
|
||||
</example>
|
||||
|
||||
<note>**Workflow Vendoring (Advanced):**
|
||||
When an agent needs workflows from another module, use both `workflow` (source) and `workflow-install` (destination).
|
||||
@@ -244,14 +241,14 @@ This is typically used when creating specialized modules that reuse common workf
|
||||
icon: {{agent_icon}} # The perfect emoji
|
||||
module: {{target_module}}
|
||||
|
||||
persona:
|
||||
role: |
|
||||
{{The role discovered}}
|
||||
identity: |
|
||||
{{The background that emerged}}
|
||||
communication_style: |
|
||||
{{The style they loved}}
|
||||
principles: {{The beliefs articulated}}
|
||||
persona:
|
||||
role: |
|
||||
{{The role discovered}}
|
||||
identity: |
|
||||
{{The background that emerged}}
|
||||
communication_style: |
|
||||
{{The style they loved}}
|
||||
principles: {{The beliefs articulated}}
|
||||
|
||||
# Features explored
|
||||
|
||||
@@ -312,7 +309,7 @@ menu: {{The capabilities built}}
|
||||
|
||||
**Folder Structure:**
|
||||
|
||||
`````
|
||||
```text
|
||||
|
||||
{{agent_filename}}-sidecar/
|
||||
├── memories.md # Persistent memory
|
||||
@@ -321,7 +318,7 @@ menu: {{The capabilities built}}
|
||||
│ └── README.md
|
||||
└── sessions/ # Session notes
|
||||
|
||||
````
|
||||
```
|
||||
|
||||
**File: memories.md**
|
||||
|
||||
@@ -339,7 +336,7 @@ menu: {{The capabilities built}}
|
||||
## Personal Notes
|
||||
|
||||
<!-- My observations and insights -->
|
||||
````
|
||||
```
|
||||
|
||||
**File: instructions.md**
|
||||
|
||||
|
||||
@@ -233,12 +233,3 @@
|
||||
- [ ] Alpha (Core functionality works)
|
||||
- [ ] Beta (Most features complete, needs testing)
|
||||
- [ ] Release (Full functionality, documented)
|
||||
|
||||
## Sign-off
|
||||
|
||||
**Module Name:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
|
||||
**Module Code:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
|
||||
**Version:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
|
||||
**Validated By:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
|
||||
**Date:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
|
||||
**Status:** ⬜ Pass / ⬜ Pass with Issues / ⬜ Fail
|
||||
|
||||
@@ -180,7 +180,7 @@
|
||||
└── data/ # User data directory
|
||||
```
|
||||
|
||||
**SOURCE MODULE** (\_module-installer is for installation only, not copied to target):
|
||||
**SOURCE MODULE** (module-installer is for installation only, not copied to target):
|
||||
|
||||
```
|
||||
{{module_code}}/
|
||||
@@ -268,7 +268,7 @@
|
||||
<critical>IMPORTANT: Create install-config.yaml NOT install-config.yaml</critical>
|
||||
<critical>This is the STANDARD format that BMAD installer uses</critical>
|
||||
|
||||
Create \_module-installer/install-config.yaml:
|
||||
Create module-installer/install-config.yaml:
|
||||
|
||||
```yaml
|
||||
# {{module_name}} Module Configuration
|
||||
@@ -329,7 +329,7 @@ prompt:
|
||||
|
||||
<critical>Save location:</critical>
|
||||
|
||||
- Save to {{module_path}}/\_module-installer/install-config.yaml
|
||||
- Save to {{module_path}}/module-installer/install-config.yaml
|
||||
|
||||
<ask>Does your module need custom installation logic (database setup, API registration, etc.)?</ask>
|
||||
|
||||
@@ -374,7 +374,7 @@ module.exports = { install };
|
||||
|
||||
<critical>Save location:</critical>
|
||||
|
||||
- Save to {{module_path}}/\_module-installer/installer.js
|
||||
- Save to {{module_path}}/module-installer/installer.js
|
||||
</check>
|
||||
|
||||
<check if="no">
|
||||
|
||||
@@ -172,7 +172,7 @@ menu:
|
||||
|
||||
## Installation Infrastructure
|
||||
|
||||
### Required: \_module-installer/install-config.yaml
|
||||
### Required: module-installer/install-config.yaml
|
||||
|
||||
This file defines both installation questions AND static configuration values:
|
||||
|
||||
@@ -226,7 +226,7 @@ data_path:
|
||||
- `result` field uses placeholders: `{value}`, `{project-root}`, `{directory_name}`
|
||||
- Installer generates final `config.yaml` from this template
|
||||
|
||||
### Optional: \_module-installer/installer.js
|
||||
### Optional: module-installer/installer.js
|
||||
|
||||
For complex installations requiring custom logic:
|
||||
|
||||
@@ -252,7 +252,7 @@ async function install(options) {
|
||||
module.exports = { install };
|
||||
```
|
||||
|
||||
### Optional: \_module-installer/assets/
|
||||
### Optional: module-installer/assets/
|
||||
|
||||
Files to copy during installation:
|
||||
|
||||
|
||||
@@ -112,5 +112,5 @@
|
||||
|
||||
**Validation Complete:** ⬜ Yes / ⬜ With Issues / ⬜ Needs Revision
|
||||
|
||||
**Validated By:** **\*\*\*\***\_**\*\*\*\***
|
||||
**Date:** **\*\*\*\***\_**\*\*\*\***
|
||||
**Validated By:** {name}
|
||||
**Date:** {date}
|
||||
|
||||
Reference in New Issue
Block a user