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>
39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
# Document Project Workflow Templates
|
|
|
|
This directory contains template files for the `document-project` workflow.
|
|
|
|
## Template Files
|
|
|
|
- **index-template.md** - Master index template (adapts for single/multi-part projects)
|
|
- **project-overview-template.md** - Executive summary and high-level overview
|
|
- **source-tree-template.md** - Annotated directory structure
|
|
|
|
## Template Usage
|
|
|
|
The workflow dynamically selects and populates templates based on:
|
|
|
|
1. **Project structure** (single part vs multi-part)
|
|
2. **Project type** (web, backend, mobile, etc.)
|
|
3. **Documentation requirements** (from documentation-requirements.csv)
|
|
|
|
## Variable Naming Convention
|
|
|
|
Templates use Handlebars-style variables:
|
|
|
|
- `{{variable_name}}` - Simple substitution
|
|
- `{{#if condition}}...{{/if}}` - Conditional blocks
|
|
- `{{#each collection}}...{{/each}}` - Iteration
|
|
|
|
## Additional Templates
|
|
|
|
Architecture-specific templates are dynamically loaded from:
|
|
`/bmad/bmm/workflows/3-solutioning/templates/`
|
|
|
|
Based on the matched architecture type from the registry.
|
|
|
|
## Notes
|
|
|
|
- Templates support both simple and complex project structures
|
|
- Multi-part projects get part-specific file naming (e.g., `architecture-{part_id}.md`)
|
|
- Single-part projects use simplified naming (e.g., `architecture.md`)
|