182 lines
2.3 KiB
Markdown
Raw Normal View History

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>
2025-11-02 21:18:33 -06:00
# Product Brief: {{project_name}}
**Date:** {{date}}
**Author:** {{user_name}}
**Context:** {{context_type}}
---
## Executive Summary
{{executive_summary}}
---
## Core Vision
### Problem Statement
{{problem_statement}}
{{#if problem_impact}}
### Problem Impact
{{problem_impact}}
{{/if}}
{{#if existing_solutions_gaps}}
### Why Existing Solutions Fall Short
{{existing_solutions_gaps}}
{{/if}}
### Proposed Solution
{{proposed_solution}}
{{#if key_differentiators}}
### Key Differentiators
{{key_differentiators}}
{{/if}}
---
## Target Users
### Primary Users
{{primary_user_segment}}
{{#if secondary_user_segment}}
### Secondary Users
{{secondary_user_segment}}
{{/if}}
{{#if user_journey}}
### User Journey
{{user_journey}}
{{/if}}
---
{{#if success_metrics}}
## Success Metrics
{{success_metrics}}
{{#if business_objectives}}
### Business Objectives
{{business_objectives}}
{{/if}}
{{#if key_performance_indicators}}
### Key Performance Indicators
{{key_performance_indicators}}
{{/if}}
{{/if}}
---
## MVP Scope
### Core Features
{{core_features}}
{{#if out_of_scope}}
### Out of Scope for MVP
{{out_of_scope}}
{{/if}}
{{#if mvp_success_criteria}}
### MVP Success Criteria
{{mvp_success_criteria}}
{{/if}}
{{#if future_vision_features}}
### Future Vision
{{future_vision_features}}
{{/if}}
---
{{#if market_analysis}}
## Market Context
{{market_analysis}}
{{/if}}
{{#if financial_considerations}}
## Financial Considerations
{{financial_considerations}}
{{/if}}
{{#if technical_preferences}}
## Technical Preferences
{{technical_preferences}}
{{/if}}
{{#if organizational_context}}
## Organizational Context
{{organizational_context}}
{{/if}}
{{#if risks_and_assumptions}}
## Risks and Assumptions
{{risks_and_assumptions}}
{{/if}}
{{#if timeline_constraints}}
## Timeline
{{timeline_constraints}}
{{/if}}
{{#if supporting_materials}}
## Supporting Materials
{{supporting_materials}}
{{/if}}
---
_This Product Brief captures the vision and requirements for {{project_name}}._
_It was created through collaborative discovery and reflects the unique needs of this {{context_type}} project._
{{#if next_workflow}}
_Next: {{next_workflow}} will transform this brief into detailed planning artifacts._
{{else}}
_Next: Use the PRD workflow to create detailed product requirements from this brief._
{{/if}}