BMAD-METHOD/bmad/bmm/workflows
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
..
1-analysis docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
2-plan-workflows docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
3-solutioning docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
4-implementation docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
document-project docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
techdoc docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
testarch docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
workflow-status docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
README.md docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00

README.md

BMM Workflows - Complete v6 Guide

Master guide for BMM's four-phase methodology that adapts to project scale (Level 0-4) and context (greenfield/brownfield).

Table of Contents

Core Innovations

  • Scale-Adaptive Planning - Automatic routing based on complexity (Level 0-4)
  • Just-In-Time Design - Tech specs created per epic during implementation
  • Dynamic Expertise Injection - Story-specific technical guidance
  • Continuous Learning Loop - Retrospectives improve each cycle
  • Document Sharding Support - All workflows handle whole or sharded documents for efficiency

Universal Entry Point

Always start with workflow-status or workflow-init

workflow-status

  • Checks for existing workflow status file
  • Displays current phase and progress
  • Routes to appropriate next workflow
  • Shows Phase 4 implementation state

workflow-init

  • Creates initial bmm-workflow-status.md
  • Detects greenfield vs brownfield
  • Routes undocumented brownfield to document-project
  • Sets up workflow tracking

Four Phases Overview

PREREQUISITE: document-project (brownfield without docs)
                    ↓
PHASE 1: Analysis (optional)
    brainstorm → research → brief
                    ↓
PHASE 2: Planning (required, scale-adaptive)
    Level 0-1: tech-spec only
    Level 2-4: PRD + epics
                    ↓
PHASE 3: Solutioning (Level 2-4 only)
    architecture → validation → gate-check
                    ↓
PHASE 4: Implementation (iterative)
    sprint-planning → epic-context → story cycle

Phase Details

Documentation Prerequisite

When: Brownfield projects without documentation OR post-completion cleanup

Workflow Purpose Output
document-project Analyze and document codebase Comprehensive docs

Use Cases:

  1. Pre-Phase 1: Understand existing brownfield code
  2. Post-Phase 4: Create clean documentation replacing scattered artifacts

Phase 1: Analysis

Optional workflows for discovery and requirements gathering

Workflow Agent Purpose Output
brainstorm-project Analyst Software ideation Architecture proposals
brainstorm-game Game Designer Game concept ideation Concept proposals
research Analyst Multi-mode research Research artifacts
product-brief Analyst Strategic planning Product brief
game-brief Game Designer Game foundation Game brief

Phase 2: Planning

Required phase with scale-adaptive routing

Workflow Agent Output Levels
prd PM PRD.md + epics 2-4
tech-spec PM tech-spec.md 0-1
gdd Game Designer GDD.md Games
create-ux-design UX ux-design.md Conditional

Phase 3: Solutioning

Architecture phase for Level 2-4 projects

Workflow Agent Purpose Output
create-architecture Architect System design architecture.md + ADRs
validate-architecture Architect Design validation Validation report
solutioning-gate-check Architect PRD/UX/arch check Gate report

Phase 4: Implementation

Sprint-based development cycle

Sprint Status System

Epic Flow: backlog → contexted

Story Flow: backlog → drafted → ready-for-dev → in-progress → review → done

Implementation Workflows

Workflow Agent Purpose Status Updates
sprint-planning SM Initialize tracking Creates sprint-status.yaml
epic-tech-context SM Epic technical context Epic: backlog → contexted
create-story SM Draft story files Story: backlog → drafted
story-context SM Implementation guidance Story: drafted → ready-for-dev
dev-story DEV Implement Story: ready-for-dev → in-progress → review
code-review DEV Quality validation No auto update
retrospective SM Capture learnings Retrospective: optional → completed
correct-course SM Handle issues Adaptive

Implementation Loop

sprint-planning (creates sprint-status.yaml)
    ↓
For each epic:
    epic-tech-context
        ↓
    For each story:
        create-story → story-context → dev-story → code-review
            ↓
        Mark done in sprint-status.yaml
    ↓
    retrospective (epic complete)

Scale Levels

Level Scope Documentation Path
0 Single change tech-spec only Phase 2 → 4
1 1-10 stories tech-spec only Phase 2 → 4
2 5-15 stories PRD + architecture Phase 2 → 3 → 4
3 12-40 stories PRD + full arch Phase 2 → 3 → 4
4 40+ stories PRD + enterprise arch Phase 2 → 3 → 4

Greenfield vs Brownfield

Greenfield (New Projects)

Phase 1 (optional) → Phase 2 → Phase 3 (L2-4) → Phase 4
  • Clean slate for design
  • No existing constraints
  • Direct to planning

Brownfield (Existing Code)

document-project (if needed) → Phase 1 (optional) → Phase 2 → Phase 3 (L2-4) → Phase 4
  • Must understand existing patterns
  • Documentation prerequisite if undocumented
  • Consider technical debt in planning

Critical Rules

Phase Transitions

  1. Check workflow-status before any Phase 1-3 workflow
  2. Document brownfield before planning if undocumented
  3. Complete planning before solutioning
  4. Complete architecture (L2-4) before implementation

Implementation Rules

  1. Epic context first - Must context epic before drafting stories
  2. Sequential by default - Work stories in order within epic
  3. Learning transfer - Draft next story after previous done
  4. Manual status updates - Update sprint-status.yaml as needed

Story Management

  1. Single source of truth - sprint-status.yaml tracks everything
  2. No story search - Agents read exact story from status file
  3. Context injection - Each story gets specific technical guidance
  4. Retrospective learning - Capture improvements per epic

Best Practices

  1. Trust the process - Let workflows guide you
  2. Respect scale - Don't over-document small projects
  3. Use status tracking - Always know where you are
  4. Iterate and learn - Each epic improves the next
  5. Consider sharding - Split large documents (PRD, epics, architecture) for efficiency

Document Sharding

For large multi-epic projects, consider sharding planning documents to improve workflow efficiency.

What is Sharding?

Splits large markdown files into smaller section-based files:

  • PRD with 15 epics → prd/epic-1.md, prd/epic-2.md, etc.
  • Large epics file → Individual epic files
  • Architecture layers → Separate layer files

Benefits

Phase 1-3 Workflows:

  • Workflows load entire sharded documents (transparent to user)
  • Better organization for large projects

Phase 4 Workflows:

  • Selective loading - Only load the epic/section needed
  • Massive efficiency - 90%+ token reduction for 10+ epic projects
  • Examples: epic-tech-context, create-story, story-context, code-review

Usage

Load bmad-master or analyst agent:
/shard-doc

Source: docs/PRD.md
Destination: docs/prd/

All BMM workflows automatically support both whole and sharded documents.

→ Complete Sharding Guide


For specific workflow details, see individual workflow READMEs in their respective directories.