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-12-29 16:14:59 +00:00 · 2025-11-02 21:18:33 -06:00
parent 8a00f8ad70
commit cfedecbd53
359 changed files with 72374 additions and 809 deletions
--- a/bmad/bmm/workflows/2-plan-workflows/prd/instructions.md
+++ b/bmad/bmm/workflows/2-plan-workflows/prd/instructions.md
@@ -0,0 +1,423 @@
+# PRD Workflow - Intent-Driven Product Planning
+
+<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
+<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
+<critical>This workflow uses INTENT-DRIVEN PLANNING - adapt organically to product type and context</critical>
+<critical>Communicate all responses in {communication_language} and adapt deeply to {user_skill_level}</critical>
+<critical>Generate all documents in {document_output_language}</critical>
+<critical>LIVING DOCUMENT: Write to PRD.md continuously as you discover - never wait until the end</critical>
+<critical>GUIDING PRINCIPLE: Find and weave the product's magic throughout - what makes it special should inspire every section</critical>
+
+## 📚 Input Document Discovery
+
+This workflow requires: product brief, and may reference market research or brownfield project documentation.
+
+**Discovery Process** (execute for each referenced document):
+
+1. **Search for whole document first** - Use fuzzy file matching to find the complete document
+2. **Check for sharded version** - If whole document not found, look for `{doc-name}/index.md`
+3. **If sharded version found**:
+   - Read `index.md` to understand the document structure
+   - Read ALL section files listed in the index
+   - Treat the combined content as if it were a single document
+4. **Brownfield projects**: The `document-project` workflow always creates `{output_folder}/docs/index.md`
+
+**Priority**: If both whole and sharded versions exist, use the whole document.
+
+**Fuzzy matching**: Be flexible with document names - users may use variations in naming conventions.
+
+<workflow>
+
+<step n="0" goal="Validate workflow readiness" tag="workflow-status">
+<action>Check if {status_file} exists</action>
+
+<action if="status file not found">Set standalone_mode = true</action>
+
+<check if="status file found">
+  <action>Load the FULL file: {status_file}</action>
+  <action>Parse workflow_status section</action>
+  <action>Check status of "prd" workflow</action>
+  <action>Get project_level from YAML metadata</action>
+  <action>Find first non-completed workflow (next expected workflow)</action>
+
+  <check if="project_level < 2">
+    <output>**Level {{project_level}} Project - Redirecting**
+
+Level 0-1 projects use tech-spec workflow for simpler planning.
+PRD is for Level 2-4 projects that need comprehensive requirements.</output>
+<action>Exit and suggest tech-spec workflow</action>
+</check>
+
+  <check if="prd status is file path (already completed)">
+    <output>⚠️ PRD already completed: {{prd status}}</output>
+    <ask>Re-running will overwrite the existing PRD. Continue? (y/n)</ask>
+    <check if="n">
+      <output>Exiting. Use workflow-status to see your next step.</output>
+      <action>Exit workflow</action>
+    </check>
+  </check>
+
+<action>Set standalone_mode = false</action>
+</check>
+</step>
+
+<step n="1" goal="Discovery - Project, Domain, and Vision">
+<action>Welcome {user_name} and begin comprehensive discovery, and then start to GATHER ALL CONTEXT:
+1. Check workflow-status.yaml for project_context (if exists)
+2. Look for existing documents (Product Brief, Domain Brief, research)
+3. Detect project type AND domain complexity
+
+Load references:
+{installed_path}/project-types.csv
+{installed_path}/domain-complexity.csv
+
+Through natural conversation:
+"Tell me about what you want to build - what problem does it solve and for whom?"
+
+DUAL DETECTION:
+Project type signals: API, mobile, web, CLI, SDK, SaaS
+Domain complexity signals: medical, finance, government, education, aerospace
+
+SPECIAL ROUTING:
+If game detected → Suggest game-brief and GDD workflows
+If complex domain detected → Offer domain research options:
+A) Run domain-research workflow (thorough)
+B) Quick web search (basic)
+C) User provides context
+D) Continue with general knowledge
+
+CAPTURE THE MAGIC EARLY with a few questions such as for example: "What excites you most about this product?", "What would make users love this?", "What's the moment that will make people go 'wow'?"
+
+This excitement becomes the thread woven throughout the PRD.</action>
+
+<template-output>vision_alignment</template-output>
+<template-output>project_classification</template-output>
+<template-output>project_type</template-output>
+<template-output>domain_type</template-output>
+<template-output>complexity_level</template-output>
+<check if="complex domain">
+<template-output>domain_context_summary</template-output>
+</check>
+<template-output>product_magic_essence</template-output>
+<template-output>product_brief_path</template-output>
+<template-output>domain_brief_path</template-output>
+<template-output>research_documents</template-output>
+</step>
+
+<step n="2" goal="Success Definition">
+<action>Define what winning looks like for THIS specific product
+
+INTENT: Meaningful success criteria, not generic metrics
+
+Adapt to context:
+
+- Consumer: User love, engagement, retention
+- B2B: ROI, efficiency, adoption
+- Developer tools: Developer experience, community
+- Regulated: Compliance, safety, validation
+
+Make it specific:
+
+- NOT: "10,000 users"
+- BUT: "100 power users who rely on it daily"
+
+- NOT: "99.9% uptime"
+- BUT: "Zero data loss during critical operations"
+
+Weave in the magic:
+
+- "Success means users experience [that special moment] and [desired outcome]"</action>
+
+<template-output>success_criteria</template-output>
+<check if="business focus">
+<template-output>business_metrics</template-output>
+</check>
+</step>
+
+<step n="3" goal="Scope Definition">
+<action>Smart scope negotiation - find the sweet spot
+
+The Scoping Game:
+
+1. "What must work for this to be useful?" → MVP
+2. "What makes it competitive?" → Growth
+3. "What's the dream version?" → Vision
+
+Challenge scope creep conversationally:
+
+- "Could that wait until after launch?"
+- "Is that essential for proving the concept?"
+
+For complex domains:
+
+- Include compliance minimums in MVP
+- Note regulatory gates between phases</action>
+
+<template-output>mvp_scope</template-output>
+<template-output>growth_features</template-output>
+<template-output>vision_features</template-output>
+</step>
+
+<step n="4" goal="Domain-Specific Exploration" optional="true">
+<action>Only if complex domain detected or domain-brief exists
+
+Synthesize domain requirements that will shape everything:
+
+- Regulatory requirements
+- Compliance needs
+- Industry standards
+- Safety/risk factors
+- Required validations
+- Special expertise needed
+
+These inform:
+
+- What features are mandatory
+- What NFRs are critical
+- How to sequence development
+- What validation is required</action>
+
+<check if="complex domain">
+  <template-output>domain_considerations</template-output>
+</check>
+</step>
+
+<step n="5" goal="Innovation Discovery" optional="true">
+<action>Identify truly novel patterns if applicable
+
+Listen for innovation signals:
+
+- "Nothing like this exists"
+- "We're rethinking how [X] works"
+- "Combining [A] with [B] for the first time"
+
+Explore deeply:
+
+- What makes it unique?
+- What assumption are you challenging?
+- How do we validate it?
+- What's the fallback?
+
+<WebSearch if="novel">{concept} innovations {date}</WebSearch></action>
+
+<check if="innovation detected">
+  <template-output>innovation_patterns</template-output>
+  <template-output>validation_approach</template-output>
+</check>
+</step>
+
+<step n="6" goal="Project-Specific Deep Dive">
+<action>Based on detected project type, dive deep into specific needs
+
+Load project type requirements from CSV and expand naturally.
+
+FOR API/BACKEND:
+
+- Map out endpoints, methods, parameters
+- Define authentication and authorization
+- Specify error codes and rate limits
+- Document data schemas
+
+FOR MOBILE:
+
+- Platform requirements (iOS/Android/both)
+- Device features needed
+- Offline capabilities
+- Store compliance
+
+FOR SAAS B2B:
+
+- Multi-tenant architecture
+- Permission models
+- Subscription tiers
+- Critical integrations
+
+[Continue for other types...]
+
+Always relate back to the product magic:
+"How does [requirement] enhance [the special thing]?"</action>
+
+<template-output>project_type_requirements</template-output>
+
+<!-- Dynamic sections based on project type -->
+<check if="API/Backend project">
+  <template-output>endpoint_specification</template-output>
+  <template-output>authentication_model</template-output>
+</check>
+
+<check if="Mobile project">
+  <template-output>platform_requirements</template-output>
+  <template-output>device_features</template-output>
+</check>
+
+<check if="SaaS B2B project">
+  <template-output>tenant_model</template-output>
+  <template-output>permission_matrix</template-output>
+</check>
+</step>
+
+<step n="7" goal="UX Principles" optional="true">
+<action>Only if product has a UI
+
+Light touch on UX - not full design:
+
+- Visual personality
+- Key interaction patterns
+- Critical user flows
+
+"How should this feel to use?"
+"What's the vibe - professional, playful, minimal?"
+
+Connect to the magic:
+"The UI should reinforce [the special moment] through [design approach]"</action>
+
+<check if="has UI">
+  <template-output>ux_principles</template-output>
+  <template-output>key_interactions</template-output>
+</check>
+</step>
+
+<step n="8" goal="Functional Requirements Synthesis">
+<action>Transform everything discovered into clear functional requirements
+
+Pull together:
+
+- Core features from scope
+- Domain-mandated features
+- Project-type specific needs
+- Innovation requirements
+
+Organize by capability, not technology:
+
+- User Management (not "auth system")
+- Content Discovery (not "search algorithm")
+- Team Collaboration (not "websockets")
+
+Each requirement should:
+
+- Be specific and measurable
+- Connect to user value
+- Include acceptance criteria
+- Note domain constraints
+
+The magic thread:
+Highlight which requirements deliver the special experience</action>
+
+<template-output>functional_requirements_complete</template-output>
+</step>
+
+<step n="9" goal="Non-Functional Requirements Discovery">
+<action>Only document NFRs that matter for THIS product
+
+Performance: Only if user-facing impact
+Security: Only if handling sensitive data
+Scale: Only if growth expected
+Accessibility: Only if broad audience
+Integration: Only if connecting systems
+
+For each NFR:
+
+- Why it matters for THIS product
+- Specific measurable criteria
+- Domain-driven requirements
+
+Skip categories that don't apply!</action>
+
+<!-- Only output sections that were discussed -->
+<check if="performance matters">
+  <template-output>performance_requirements</template-output>
+</check>
+<check if="security matters">
+  <template-output>security_requirements</template-output>
+</check>
+<check if="scale matters">
+  <template-output>scalability_requirements</template-output>
+</check>
+<check if="accessibility matters">
+  <template-output>accessibility_requirements</template-output>
+</check>
+<check if="integration matters">
+  <template-output>integration_requirements</template-output>
+</check>
+<check if="no NFRs discussed">
+  <template-output>no_nfrs</template-output>
+</check>
+</step>
+
+<step n="10" goal="Review PRD and transition to epics">
+<action>Review the PRD we've built together
+
+"Let's review what we've captured:
+
+- Vision: [summary]
+- Success: [key metrics]
+- Scope: [MVP highlights]
+- Requirements: [count] functional, [count] non-functional
+- Special considerations: [domain/innovation]
+
+Does this capture your product vision?"
+
+After confirmation:
+"Excellent! Now we need to break these requirements into implementable epics and stories.
+
+For the epic breakdown, you have two options:
+
+1. Start a new session focused on epics (recommended for complex projects)
+2. Continue here (I'll transform requirements into epics now)
+
+Which would you prefer?"
+
+If new session:
+"To start epic planning in a new session:
+
+1. Save your work here
+2. Start fresh and run: workflow epics-stories
+3. It will load your PRD and create the epic breakdown
+
+This keeps each session focused and manageable."
+
+If continue:
+"Let's continue with epic breakdown here..."
+[Proceed with epics-stories subworkflow]
+Set project_level and target_scale based on project analysis
+Generate epic_details for the epics breakdown document</action>
+
+<template-output>prd_summary</template-output>
+<template-output>project_level</template-output>
+<template-output>target_scale</template-output>
+<template-output>epic_details</template-output>
+</step>
+
+<step n="11" goal="Complete PRD and suggest next steps">
+<template-output>product_magic_summary</template-output>
+
+<check if="standalone_mode != true">
+  <action>Load the FULL file: {status_file}</action>
+  <action>Update workflow_status["prd"] = "{default_output_file}"</action>
+  <action>Save file, preserving ALL comments and structure</action>
+</check>
+
+<output>**✅ PRD Complete, {user_name}!**
+
+Your product requirements are documented and ready for implementation.
+
+**Created:**
+
+- **PRD.md** - Complete requirements adapted to {project_type} and {domain}
+
+**Next Steps:**
+
+1. **Epic Breakdown** (Required)
+   Run: `workflow create-epics-and-stories` to decompose requirements into implementable stories
+
+2. **UX Design** (If UI exists)
+   Run: `workflow ux-design` for detailed user experience design
+
+3. **Architecture** (Recommended)
+   Run: `workflow create-architecture` for technical architecture decisions
+
+The magic of your product - {product_magic_summary} - is woven throughout the PRD and will guide all subsequent work.
+</output>
+</step>
+
+</workflow>