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>
136 lines
2.1 KiB
Markdown
136 lines
2.1 KiB
Markdown
# {{project_name}} - Source Tree Analysis
|
|
|
|
**Date:** {{date}}
|
|
|
|
## Overview
|
|
|
|
{{source_tree_overview}}
|
|
|
|
{{#if is_multi_part}}
|
|
|
|
## Multi-Part Structure
|
|
|
|
This project is organized into {{parts_count}} distinct parts:
|
|
|
|
{{#each project_parts}}
|
|
|
|
- **{{part_name}}** (`{{root_path}}`): {{purpose}}
|
|
{{/each}}
|
|
{{/if}}
|
|
|
|
## Complete Directory Structure
|
|
|
|
```
|
|
{{complete_source_tree}}
|
|
```
|
|
|
|
## Critical Directories
|
|
|
|
{{#each critical_folders}}
|
|
|
|
### `{{folder_path}}`
|
|
|
|
{{description}}
|
|
|
|
**Purpose:** {{purpose}}
|
|
**Contains:** {{contents_summary}}
|
|
{{#if entry_points}}**Entry Points:** {{entry_points}}{{/if}}
|
|
{{#if integration_note}}**Integration:** {{integration_note}}{{/if}}
|
|
|
|
{{/each}}
|
|
|
|
{{#if is_multi_part}}
|
|
|
|
## Part-Specific Trees
|
|
|
|
{{#each project_parts}}
|
|
|
|
### {{part_name}} Structure
|
|
|
|
```
|
|
{{source_tree}}
|
|
```
|
|
|
|
**Key Directories:**
|
|
{{#each critical_directories}}
|
|
|
|
- **`{{path}}`**: {{description}}
|
|
{{/each}}
|
|
|
|
{{/each}}
|
|
|
|
## Integration Points
|
|
|
|
{{#each integration_points}}
|
|
|
|
### {{from_part}} → {{to_part}}
|
|
|
|
- **Location:** `{{integration_path}}`
|
|
- **Type:** {{integration_type}}
|
|
- **Details:** {{details}}
|
|
{{/each}}
|
|
|
|
{{/if}}
|
|
|
|
## Entry Points
|
|
|
|
{{#if is_single_part}}
|
|
|
|
- **Main Entry:** `{{main_entry_point}}`
|
|
{{#if additional_entry_points}}
|
|
- **Additional:**
|
|
{{#each additional_entry_points}}
|
|
- `{{path}}`: {{description}}
|
|
{{/each}}
|
|
{{/if}}
|
|
{{else}}
|
|
{{#each project_parts}}
|
|
|
|
### {{part_name}}
|
|
|
|
- **Entry Point:** `{{entry_point}}`
|
|
- **Bootstrap:** {{bootstrap_description}}
|
|
{{/each}}
|
|
{{/if}}
|
|
|
|
## File Organization Patterns
|
|
|
|
{{file_organization_patterns}}
|
|
|
|
## Key File Types
|
|
|
|
{{#each file_type_patterns}}
|
|
|
|
### {{file_type}}
|
|
|
|
- **Pattern:** `{{pattern}}`
|
|
- **Purpose:** {{purpose}}
|
|
- **Examples:** {{examples}}
|
|
{{/each}}
|
|
|
|
## Asset Locations
|
|
|
|
{{#if has_assets}}
|
|
{{#each asset_locations}}
|
|
|
|
- **{{asset_type}}**: `{{location}}` ({{file_count}} files, {{total_size}})
|
|
{{/each}}
|
|
{{else}}
|
|
No significant assets detected.
|
|
{{/if}}
|
|
|
|
## Configuration Files
|
|
|
|
{{#each config_files}}
|
|
|
|
- **`{{path}}`**: {{description}}
|
|
{{/each}}
|
|
|
|
## Notes for Development
|
|
|
|
{{development_notes}}
|
|
|
|
---
|
|
|
|
_Generated using BMAD Method `document-project` workflow_
|