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>
181 lines
2.5 KiB
Markdown
181 lines
2.5 KiB
Markdown
# Domain Brief - {project_name}
|
|
|
|
Generated: {date}
|
|
Domain: {primary_domain}
|
|
Complexity: {complexity_level}
|
|
|
|
## Executive Summary
|
|
|
|
{brief_overview_of_domain_research_findings}
|
|
|
|
## Domain Overview
|
|
|
|
### Industry Context
|
|
|
|
{domain_overview}
|
|
|
|
### Regulatory Landscape
|
|
|
|
{regulatory_environment}
|
|
|
|
### Key Stakeholders
|
|
|
|
{stakeholder_analysis}
|
|
|
|
## Critical Concerns
|
|
|
|
### Compliance Requirements
|
|
|
|
{concern_mapping}
|
|
|
|
### Technical Constraints
|
|
|
|
{technical_limitations_from_domain}
|
|
|
|
### Safety/Risk Considerations
|
|
|
|
{safety_risk_factors}
|
|
|
|
## Regulatory Requirements
|
|
|
|
{regulatory_requirements}
|
|
|
|
## Industry Standards
|
|
|
|
{industry_standards}
|
|
|
|
## Practical Implications
|
|
|
|
### Architecture Impact
|
|
|
|
{architecture_implications}
|
|
|
|
### Development Impact
|
|
|
|
{development_implications}
|
|
|
|
### Timeline Impact
|
|
|
|
{timeline_implications}
|
|
|
|
### Cost Impact
|
|
|
|
{cost_implications}
|
|
|
|
## Domain Patterns
|
|
|
|
### Established Patterns
|
|
|
|
{domain_patterns}
|
|
|
|
### Innovation Opportunities
|
|
|
|
{innovation_notes}
|
|
|
|
## Risk Assessment
|
|
|
|
### Identified Risks
|
|
|
|
{risk_assessment}
|
|
|
|
### Mitigation Strategies
|
|
|
|
{mitigation_approaches}
|
|
|
|
## Validation Strategy
|
|
|
|
### Compliance Validation
|
|
|
|
{compliance_validation_approach}
|
|
|
|
### Technical Validation
|
|
|
|
{technical_validation_approach}
|
|
|
|
### Domain Expert Validation
|
|
|
|
{expert_validation_approach}
|
|
|
|
## Key Decisions
|
|
|
|
{key_decisions}
|
|
|
|
## Recommendations
|
|
|
|
### Must Have (Critical)
|
|
|
|
{critical_requirements}
|
|
|
|
### Should Have (Important)
|
|
|
|
{important_requirements}
|
|
|
|
### Consider (Nice-to-Have)
|
|
|
|
{optional_enhancements}
|
|
|
|
### Development Sequence
|
|
|
|
{recommended_sequence}
|
|
|
|
### Required Expertise
|
|
|
|
{expertise_needed}
|
|
|
|
## PRD Integration Guide
|
|
|
|
### Summary for PRD
|
|
|
|
{summary_for_prd}
|
|
|
|
### Requirements to Incorporate
|
|
|
|
- {requirement_1}
|
|
- {requirement_2}
|
|
- {requirement_3}
|
|
|
|
### Architecture Considerations
|
|
|
|
- {architecture_consideration_1}
|
|
- {architecture_consideration_2}
|
|
|
|
### Development Considerations
|
|
|
|
- {development_consideration_1}
|
|
- {development_consideration_2}
|
|
|
|
## References
|
|
|
|
### Regulations Researched
|
|
|
|
- {regulation_1_with_link}
|
|
- {regulation_2_with_link}
|
|
|
|
### Standards Referenced
|
|
|
|
- {standard_1_with_link}
|
|
- {standard_2_with_link}
|
|
|
|
### Additional Resources
|
|
|
|
- {resource_1}
|
|
- {resource_2}
|
|
|
|
## Appendix
|
|
|
|
### Research Notes
|
|
|
|
{detailed_research_notes}
|
|
|
|
### Conversation Highlights
|
|
|
|
{key_discussion_points_with_user}
|
|
|
|
### Open Questions
|
|
|
|
{questions_requiring_further_research}
|
|
|
|
---
|
|
|
|
_This domain brief was created through collaborative research between {user_name} and the AI facilitator. It should be referenced during PRD creation and updated as new domain insights emerge._
|