cfedecbd53
## 📚 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> |
||
|---|---|---|
| .. | ||
| README.md | ||
| architecture.md | ||
| brainstorm-project.md | ||
| code-review.md | ||
| correct-course.md | ||
| create-epics-and-stories.md | ||
| create-story.md | ||
| create-ux-design.md | ||
| dev-story.md | ||
| document-project.md | ||
| narrative.md | ||
| prd.md | ||
| product-brief.md | ||
| research.md | ||
| retrospective.md | ||
| solutioning-gate-check.md | ||
| sprint-planning.md | ||
| story-context.md | ||
| story-done.md | ||
| story-ready.md | ||
| tech-spec-sm.md | ||
| tech-spec.md | ||
| workflow-init.md | ||
| workflow-status.md | ||
README.md
BMM Workflows
Available Workflows in bmm
brainstorm-project
- Path:
bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml - Facilitate project brainstorming sessions by orchestrating the CIS brainstorming workflow with project-specific context and guidance.
product-brief
- Path:
bmad/bmm/workflows/1-analysis/product-brief/workflow.yaml - Interactive product brief creation workflow that guides users through defining their product vision with multiple input sources and conversational collaboration
research
- Path:
bmad/bmm/workflows/1-analysis/research/workflow.yaml - Adaptive research workflow supporting multiple research types: market research, deep research prompt generation, technical/architecture evaluation, competitive intelligence, user research, and domain analysis
create-ux-design
- Path:
bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml - Collaborative UX design facilitation workflow that creates exceptional user experiences through visual exploration and informed decision-making. Unlike template-driven approaches, this workflow facilitates discovery, generates visual options, and collaboratively designs the UX with the user at every step.
narrative
- Path:
bmad/bmm/workflows/2-plan-workflows/narrative/workflow.yaml - Narrative design workflow for story-driven games and applications. Creates comprehensive narrative documentation including story structure, character arcs, dialogue systems, and narrative implementation guidance.
create-epics-and-stories
- Path:
bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml - Transform PRD requirements into bite-sized stories organized in epics for 200k context dev agents
prd
- Path:
bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml - Unified PRD workflow for project levels 2-4. Produces strategic PRD and tactical epic breakdown. Hands off to architecture workflow for technical design. Note: Level 0-1 use tech-spec workflow.
tech-spec-sm
- Path:
bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml - Technical specification workflow for Level 0 projects (single atomic changes). Creates focused tech spec for bug fixes, single endpoint additions, or small isolated changes. Tech-spec only - no PRD needed.
architecture
- Path:
bmad/bmm/workflows/3-solutioning/architecture/workflow.yaml - Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts.
solutioning-gate-check
- Path:
bmad/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml - Systematically validate that all planning and solutioning phases are complete and properly aligned before transitioning to Phase 4 implementation. Ensures PRD, architecture, and stories are cohesive with no gaps or contradictions.
code-review
- Path:
bmad/bmm/workflows/4-implementation/code-review/workflow.yaml - Perform a Senior Developer code review on a completed story flagged Ready for Review, leveraging story-context, epic tech-spec, repo docs, MCP servers for latest best-practices, and web search as fallback. Appends structured review notes to the story.
correct-course
- Path:
bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml - Navigate significant changes during sprint execution by analyzing impact, proposing solutions, and routing for implementation
create-story
- Path:
bmad/bmm/workflows/4-implementation/create-story/workflow.yaml - Create the next user story markdown from epics/PRD and architecture, using a standard template and saving to the stories folder
dev-story
- Path:
bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml - Execute a story by implementing tasks/subtasks, writing tests, validating, and updating the story file per acceptance criteria
tech-spec
- Path:
bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml - Generate a comprehensive Technical Specification from PRD and Architecture with acceptance criteria and traceability mapping
retrospective
- Path:
bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml - Run after epic completion to review overall success, extract lessons learned, and explore if new information emerged that might impact the next epic
sprint-planning
- Path:
bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml - Generate and manage the sprint status tracking file for Phase 4 implementation, extracting all epics and stories from epic files and tracking their status through the development lifecycle
story-context
- Path:
bmad/bmm/workflows/4-implementation/story-context/workflow.yaml - Assemble a dynamic Story Context XML by pulling latest documentation and existing code/library artifacts relevant to a drafted story
story-done
- Path:
bmad/bmm/workflows/4-implementation/story-done/workflow.yaml - Marks a story as done (DoD complete) and moves it from its current status → DONE in the status file. Advances the story queue. Simple status-update workflow with no searching required.
story-ready
- Path:
bmad/bmm/workflows/4-implementation/story-ready/workflow.yaml - Marks a drafted story as ready for development and moves it from TODO → IN PROGRESS in the status file. Simple status-update workflow with no searching required.
document-project
- Path:
bmad/bmm/workflows/document-project/workflow.yaml - Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development
workflow-init
- Path:
bmad/bmm/workflows/workflow-status/init/workflow.yaml - Initialize a new BMM project by determining level, type, and creating workflow path
workflow-status
- Path:
bmad/bmm/workflows/workflow-status/workflow.yaml - Lightweight status checker - answers "what should I do now?" for any agent. Reads YAML status file for workflow tracking. Use workflow-init for new projects.
Execution
When running any workflow:
- LOAD {project-root}/bmad/core/tasks/workflow.xml
- Pass the workflow path as 'workflow-config' parameter
- Follow workflow.xml instructions EXACTLY
- Save outputs after EACH section
Modes
- Normal: Full interaction
- #yolo: Skip optional steps