mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
## 📚 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>
104 lines
1.4 KiB
Markdown
104 lines
1.4 KiB
Markdown
# Architecture
|
|
|
|
## Executive Summary
|
|
|
|
{{executive_summary}}
|
|
|
|
{{project_initialization_section}}
|
|
|
|
## Decision Summary
|
|
|
|
| Category | Decision | Version | Affects Epics | Rationale |
|
|
| -------- | -------- | ------- | ------------- | --------- |
|
|
|
|
{{decision_table_rows}}
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
{{project_root}}/
|
|
{{source_tree}}
|
|
```
|
|
|
|
## Epic to Architecture Mapping
|
|
|
|
{{epic_mapping_table}}
|
|
|
|
## Technology Stack Details
|
|
|
|
### Core Technologies
|
|
|
|
{{core_stack_details}}
|
|
|
|
### Integration Points
|
|
|
|
{{integration_details}}
|
|
|
|
{{novel_pattern_designs_section}}
|
|
|
|
## Implementation Patterns
|
|
|
|
These patterns ensure consistent implementation across all AI agents:
|
|
|
|
{{implementation_patterns}}
|
|
|
|
## Consistency Rules
|
|
|
|
### Naming Conventions
|
|
|
|
{{naming_conventions}}
|
|
|
|
### Code Organization
|
|
|
|
{{code_organization_patterns}}
|
|
|
|
### Error Handling
|
|
|
|
{{error_handling_approach}}
|
|
|
|
### Logging Strategy
|
|
|
|
{{logging_approach}}
|
|
|
|
## Data Architecture
|
|
|
|
{{data_models_and_relationships}}
|
|
|
|
## API Contracts
|
|
|
|
{{api_specifications}}
|
|
|
|
## Security Architecture
|
|
|
|
{{security_approach}}
|
|
|
|
## Performance Considerations
|
|
|
|
{{performance_strategies}}
|
|
|
|
## Deployment Architecture
|
|
|
|
{{deployment_approach}}
|
|
|
|
## Development Environment
|
|
|
|
### Prerequisites
|
|
|
|
{{development_prerequisites}}
|
|
|
|
### Setup Commands
|
|
|
|
```bash
|
|
{{setup_commands}}
|
|
```
|
|
|
|
## Architecture Decision Records (ADRs)
|
|
|
|
{{key_architecture_decisions}}
|
|
|
|
---
|
|
|
|
_Generated by BMAD Decision Architecture Workflow v1.0_
|
|
_Date: {{date}}_
|
|
_For: {{user_name}}_
|