BMAD-METHOD/bmad/bmb
Brian Madison cfedecbd53 docs: massive documentation overhaul + introduce Paige (Documentation Guide agent)
## 📚 Complete Documentation Restructure

**BMM Documentation Hub Created:**
- New centralized documentation system at `src/modules/bmm/docs/`
- 18 comprehensive guides organized by topic (7000+ lines total)
- Clear learning paths for greenfield, brownfield, and quick spec flows
- Professional technical writing standards throughout

**New Documentation:**
- `README.md` - Complete documentation hub with navigation
- `quick-start.md` - 15-minute getting started guide
- `agents-guide.md` - Comprehensive 12-agent reference (45 min read)
- `party-mode.md` - Multi-agent collaboration guide (20 min read)
- `scale-adaptive-system.md` - Deep dive on Levels 0-4 (42 min read)
- `brownfield-guide.md` - Existing codebase development (53 min read)
- `quick-spec-flow.md` - Rapid Level 0-1 development (26 min read)
- `workflows-analysis.md` - Phase 1 workflows (12 min read)
- `workflows-planning.md` - Phase 2 workflows (19 min read)
- `workflows-solutioning.md` - Phase 3 workflows (13 min read)
- `workflows-implementation.md` - Phase 4 workflows (33 min read)
- `workflows-testing.md` - Testing & QA workflows (29 min read)
- `workflow-architecture-reference.md` - Architecture workflow deep-dive
- `workflow-document-project-reference.md` - Document-project workflow reference
- `enterprise-agentic-development.md` - Team collaboration patterns
- `faq.md` - Comprehensive Q&A covering all topics
- `glossary.md` - Complete terminology reference
- `troubleshooting.md` - Common issues and solutions

**Documentation Improvements:**
- Removed all version/date footers (git handles versioning)
- Agent customization docs now include full rebuild process
- Cross-referenced links between all guides
- Reading time estimates for all major docs
- Consistent professional formatting and structure

**Consolidated & Streamlined:**
- Module README (`src/modules/bmm/README.md`) streamlined to lean signpost
- Root README polished with better hierarchy and clear CTAs
- Moved docs from root `docs/` to module-specific locations
- Better separation of user docs vs. developer reference

## 🤖 New Agent: Paige (Documentation Guide)

**Role:** Technical documentation specialist and information architect

**Expertise:**
- Professional technical writing standards
- Documentation structure and organization
- Information architecture and navigation
- User-focused content design
- Style guide enforcement

**Status:** Work in progress - Paige will evolve as documentation needs grow

**Integration:**
- Listed in agents-guide.md, glossary.md, FAQ
- Available for all phases (documentation is continuous)
- Can be customized like all BMM agents

## 🔧 Additional Changes

- Updated agent manifest with Paige
- Updated workflow manifest with new documentation workflows
- Fixed workflow-to-agent mappings across all guides
- Improved root README with clearer Quick Start section
- Better module structure explanations
- Enhanced community links with Discord channel names

**Total Impact:**
- 18 new/restructured documentation files
- 7000+ lines of professional technical documentation
- Complete navigation system with cross-references
- Clear learning paths for all user types
- Foundation for knowledge base (coming in beta)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-02 21:18:33 -06:00
..
agents docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
workflows docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
README.md research will use the web more, use system date to understand what the read current date is. 2025-11-01 00:14:41 -05:00
config.yaml docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00

README.md

BMB - BMad Builder Module

Specialized tools and workflows for creating, customizing, and extending BMad components including agents, workflows, and complete modules.

Table of Contents

Module Structure

🤖 Agents

BMad Builder - Master builder agent orchestrating all creation workflows with deep knowledge of BMad architecture and conventions.

📋 Workflows

Comprehensive suite for building and maintaining BMad components.

Core Workflows

Creation Workflows

create-agent - Build BMad agents

  • Interactive persona development
  • Command structure design
  • YAML source compilation to .md

create-workflow - Design workflows

  • Structured multi-step processes
  • Configuration validation
  • Web bundle support

create-module - Build complete modules

  • Full module infrastructure
  • Agent and workflow integration
  • Installation automation

module-brief - Strategic planning

  • Module blueprint creation
  • Vision and architecture
  • Comprehensive analysis

Editing Workflows

edit-agent - Modify existing agents

  • Persona refinement
  • Command updates
  • Best practice compliance

edit-workflow - Update workflows

  • Structure maintenance
  • Configuration updates
  • Documentation sync

edit-module - Module enhancement

  • Component modifications
  • Dependency management
  • Version control

Maintenance Workflows

convert-legacy - Migration tool

  • v4 to v6 conversion
  • Structure compliance
  • Convention updates

audit-workflow - Quality validation

  • Structure verification
  • Config standards check
  • Bloat detection
  • Web bundle completeness

redoc - Auto-documentation

  • Reverse-tree approach
  • Technical writer quality
  • Convention compliance

Agent Types

BMB creates three agent architectures:

Full Module Agent

  • Complete persona and role definition
  • Command structure with fuzzy matching
  • Workflow integration
  • Module-specific capabilities

Hybrid Agent

  • Shared core capabilities
  • Module-specific extensions
  • Cross-module compatibility

Standalone Agent

  • Independent operation
  • Minimal dependencies
  • Specialized single purpose

Quick Start

  1. Load BMad Builder agent in your IDE
  2. Choose creation type:
    *create-agent     # New agent
    *create-workflow  # New workflow
    *create-module    # Complete module
    
  3. Follow interactive prompts

Example: Creating an Agent

User: I need a code review agent
Builder: *create-agent

[Interactive session begins]
- Brainstorming phase (optional)
- Persona development
- Command structure
- Integration points

Use Cases

Custom Development Teams

Build specialized agents for:

  • Domain expertise (legal, medical, finance)
  • Company processes
  • Tool integrations
  • Automation tasks

Workflow Extensions

Create workflows for:

  • Compliance requirements
  • Quality gates
  • Deployment pipelines
  • Custom methodologies

Complete Solutions

Package modules for:

  • Industry verticals
  • Technology stacks
  • Business processes
  • Educational frameworks

Best Practices

  1. Study existing patterns - Review BMM/CIS implementations
  2. Follow conventions - Use established structures
  3. Document thoroughly - Clear instructions essential
  4. Test iteratively - Validate during creation
  5. Consider reusability - Build modular components

Integration

BMB components integrate with:

  • BMad Core - Framework foundation
  • BMM - Extend development capabilities
  • CIS - Leverage creative workflows
  • Custom Modules - Your domain solutions

BMB empowers you to extend BMad Method for your specific needs while maintaining framework consistency and power.