mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
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>
This commit is contained in:
@@ -0,0 +1,103 @@
|
||||
# {{project_name}} - Project Overview
|
||||
|
||||
**Date:** {{date}}
|
||||
**Type:** {{project_type}}
|
||||
**Architecture:** {{architecture_type}}
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{executive_summary}}
|
||||
|
||||
## Project Classification
|
||||
|
||||
- **Repository Type:** {{repository_type}}
|
||||
- **Project Type(s):** {{project_types_list}}
|
||||
- **Primary Language(s):** {{primary_languages}}
|
||||
- **Architecture Pattern:** {{architecture_pattern}}
|
||||
|
||||
{{#if is_multi_part}}
|
||||
|
||||
## Multi-Part Structure
|
||||
|
||||
This project consists of {{parts_count}} distinct parts:
|
||||
|
||||
{{#each project_parts}}
|
||||
|
||||
### {{part_name}}
|
||||
|
||||
- **Type:** {{project_type}}
|
||||
- **Location:** `{{root_path}}`
|
||||
- **Purpose:** {{purpose}}
|
||||
- **Tech Stack:** {{tech_stack}}
|
||||
{{/each}}
|
||||
|
||||
### How Parts Integrate
|
||||
|
||||
{{integration_description}}
|
||||
{{/if}}
|
||||
|
||||
## Technology Stack Summary
|
||||
|
||||
{{#if is_single_part}}
|
||||
{{technology_table}}
|
||||
{{else}}
|
||||
{{#each project_parts}}
|
||||
|
||||
### {{part_name}} Stack
|
||||
|
||||
{{technology_table}}
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
|
||||
## Key Features
|
||||
|
||||
{{key_features}}
|
||||
|
||||
## Architecture Highlights
|
||||
|
||||
{{architecture_highlights}}
|
||||
|
||||
## Development Overview
|
||||
|
||||
### Prerequisites
|
||||
|
||||
{{prerequisites}}
|
||||
|
||||
### Getting Started
|
||||
|
||||
{{getting_started_summary}}
|
||||
|
||||
### Key Commands
|
||||
|
||||
{{#if is_single_part}}
|
||||
|
||||
- **Install:** `{{install_command}}`
|
||||
- **Dev:** `{{dev_command}}`
|
||||
- **Build:** `{{build_command}}`
|
||||
- **Test:** `{{test_command}}`
|
||||
{{else}}
|
||||
{{#each project_parts}}
|
||||
|
||||
#### {{part_name}}
|
||||
|
||||
- **Install:** `{{install_command}}`
|
||||
- **Dev:** `{{dev_command}}`
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
|
||||
## Repository Structure
|
||||
|
||||
{{repository_structure_summary}}
|
||||
|
||||
## Documentation Map
|
||||
|
||||
For detailed information, see:
|
||||
|
||||
- [index.md](./index.md) - Master documentation index
|
||||
- [architecture.md](./architecture{{#if is_multi_part}}-{part_id}{{/if}}.md) - Detailed architecture
|
||||
- [source-tree-analysis.md](./source-tree-analysis.md) - Directory structure
|
||||
- [development-guide.md](./development-guide{{#if is_multi_part}}-{part_id}{{/if}}.md) - Development workflow
|
||||
|
||||
---
|
||||
|
||||
_Generated using BMAD Method `document-project` workflow_
|
||||
Reference in New Issue
Block a user