External/BMAD-METHOD
1
0
Fork 0
mirror of https://github.com/bmadcode/BMAD-METHOD.git synced 2025-12-29 16:14:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
BMAD-METHOD/bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md
Brian Madison cfedecbd53 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

3.3 KiB
Raw Blame History

{{project_name}} - Product Requirements Document

Author: {{user_name}} Date: {{date}} Version: 1.0

Executive Summary

{{vision_alignment}}

What Makes This Special

{{product_magic_essence}}

Project Classification

Technical Type: {{project_type}} Domain: {{domain_type}} Complexity: {{complexity_level}}

{{project_classification}}

{{#if domain_context_summary}}

Domain Context

{{domain_context_summary}} {{/if}}

Success Criteria

{{success_criteria}}

{{#if business_metrics}}

Business Metrics

{{business_metrics}} {{/if}}

Product Scope

MVP - Minimum Viable Product

{{mvp_scope}}

Growth Features (Post-MVP)

{{growth_features}}

Vision (Future)

{{vision_features}}

{{#if domain_considerations}}

Domain-Specific Requirements

{{domain_considerations}}

This section shapes all functional and non-functional requirements below. {{/if}}

{{#if innovation_patterns}}

Innovation & Novel Patterns

{{innovation_patterns}}

Validation Approach

{{validation_approach}} {{/if}}

{{#if project_type_requirements}}

{{project_type}} Specific Requirements

{{project_type_requirements}}

{{#if endpoint_specification}}

API Specification

{{endpoint_specification}} {{/if}}

{{#if authentication_model}}

Authentication & Authorization

{{authentication_model}} {{/if}}

{{#if platform_requirements}}

Platform Support

{{platform_requirements}} {{/if}}

{{#if device_features}}

Device Capabilities

{{device_features}} {{/if}}

{{#if tenant_model}}

Multi-Tenancy Architecture

{{tenant_model}} {{/if}}

{{#if permission_matrix}}

Permissions & Roles

{{permission_matrix}} {{/if}} {{/if}}

{{#if ux_principles}}

User Experience Principles

{{ux_principles}}

Key Interactions

{{key_interactions}} {{/if}}

Functional Requirements

{{functional_requirements_complete}}

Non-Functional Requirements

{{#if performance_requirements}}

Performance

{{performance_requirements}} {{/if}}

{{#if security_requirements}}

Security

{{security_requirements}} {{/if}}

{{#if scalability_requirements}}

Scalability

{{scalability_requirements}} {{/if}}

{{#if accessibility_requirements}}

Accessibility

{{accessibility_requirements}} {{/if}}

{{#if integration_requirements}}

Integration

{{integration_requirements}} {{/if}}

{{#if no_nfrs}} No specific non-functional requirements identified for this project type. {{/if}}

Implementation Planning

Epic Breakdown Required

Requirements must be decomposed into epics and bite-sized stories (200k context limit).

Next Step: Run workflow epics-stories to create the implementation breakdown.

References

{{#if product_brief_path}}

  • Product Brief: {{product_brief_path}} {{/if}} {{#if domain_brief_path}}
  • Domain Brief: {{domain_brief_path}} {{/if}} {{#if research_documents}}
  • Research: {{research_documents}} {{/if}}

Next Steps

  1. Epic & Story Breakdown - Run: workflow epics-stories
  2. UX Design (if UI) - Run: workflow ux-design
  3. Architecture - Run: workflow create-architecture

This PRD captures the essence of {{project_name}} - {{product_magic_summary}}

Created through collaborative discovery between {{user_name}} and AI facilitator.