mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
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>
77 lines
2.1 KiB
YAML
77 lines
2.1 KiB
YAML
# Brownfield Level 2 - Medium Project in Existing Codebase
|
|
# 5-15 stories, multiple features added to existing system
|
|
|
|
project_type: "software"
|
|
level: 2
|
|
field_type: "brownfield"
|
|
description: "Medium project adding multiple features to existing codebase"
|
|
|
|
phases:
|
|
- prerequisite: true
|
|
name: "Documentation"
|
|
conditional: "if_undocumented"
|
|
note: "NOT a phase - prerequisite for brownfield without docs OR post-completion cleanup"
|
|
workflows:
|
|
- id: "document-project"
|
|
required: true
|
|
agent: "analyst"
|
|
command: "document-project"
|
|
output: "Comprehensive project documentation"
|
|
purpose: "Understand existing codebase before planning OR create superior final docs after Phase 4"
|
|
|
|
- phase: 1
|
|
name: "Analysis"
|
|
optional: true
|
|
workflows:
|
|
- id: "brainstorm-project"
|
|
optional: true
|
|
agent: "analyst"
|
|
command: "brainstorm-project"
|
|
- id: "research"
|
|
optional: true
|
|
agent: "analyst"
|
|
command: "research"
|
|
- id: "product-brief"
|
|
optional: true
|
|
agent: "analyst"
|
|
command: "product-brief"
|
|
|
|
- phase: 2
|
|
name: "Planning"
|
|
required: true
|
|
workflows:
|
|
- id: "prd"
|
|
recommended: true
|
|
agent: "pm"
|
|
command: "prd"
|
|
output: "Focused PRD for new features"
|
|
note: "Must consider existing system constraints"
|
|
- id: "validate-prd"
|
|
optional: true
|
|
agent: "pm"
|
|
command: "validate-prd"
|
|
- id: "tech-spec"
|
|
required: true
|
|
agent: "pm"
|
|
command: "tech-spec"
|
|
output: "Creates spec with multiple story files"
|
|
note: "Integrate with existing patterns"
|
|
- id: "create-design"
|
|
conditional: "if_has_ui"
|
|
agent: "ux-designer"
|
|
command: "create-design"
|
|
|
|
- phase: 3
|
|
name: "Solutioning"
|
|
skip: true
|
|
|
|
- phase: 4
|
|
name: "Implementation"
|
|
required: true
|
|
workflows:
|
|
- id: "sprint-planning"
|
|
required: true
|
|
agent: "sm"
|
|
command: "sprint-planning"
|
|
note: "Creates sprint plan with all stories - subsequent work tracked in sprint plan output, not workflow-status"
|