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/1-analysis/brainstorm-project/README.md
+++ b/bmad/bmm/workflows/1-analysis/brainstorm-project/README.md
@@ -0,0 +1,113 @@
+# Project Brainstorming Workflow
+
+Structured ideation for software projects exploring problem spaces, architectures, and innovative solutions beyond traditional requirements gathering.
+
+## Table of Contents
+
+- [Purpose](#purpose)
+- [Usage](#usage)
+- [Process](#process)
+- [Inputs & Outputs](#inputs--outputs)
+- [Integration](#integration)
+
+## Purpose
+
+Generate multiple solution approaches for software projects through:
+
+- Parallel ideation tracks (architecture, UX, integration, value delivery)
+- Technical-business alignment from inception
+- Hidden assumption discovery
+- Innovation beyond obvious solutions
+
+## Usage
+
+```bash
+# Run brainstorming session
+bmad bmm *brainstorm-project
+
+# Or via Analyst agent
+*brainstorm-project
+```
+
+## Process
+
+### 1. Context Capture
+
+- Business objectives and constraints
+- Technical environment
+- Stakeholder needs
+- Success criteria
+
+### 2. Parallel Ideation
+
+- **Architecture Track**: Technical approaches with trade-offs
+- **UX Track**: Interface paradigms and user journeys
+- **Integration Track**: System connection patterns
+- **Value Track**: Feature prioritization and delivery
+
+### 3. Solution Synthesis
+
+- Evaluate feasibility and impact
+- Align with strategic objectives
+- Surface hidden assumptions
+- Generate recommendations
+
+## Inputs & Outputs
+
+### Inputs
+
+| Input             | Type     | Purpose                                       |
+| ----------------- | -------- | --------------------------------------------- |
+| Project Context   | Document | Business objectives, environment, constraints |
+| Problem Statement | Optional | Core challenge or opportunity                 |
+
+### Outputs
+
+| Output                   | Content                                     |
+| ------------------------ | ------------------------------------------- |
+| Architecture Proposals   | Multiple approaches with trade-off analysis |
+| Value Framework          | Prioritized features aligned to objectives  |
+| Risk Analysis            | Dependencies, challenges, opportunities     |
+| Strategic Recommendation | Synthesized direction with rationale        |
+
+## Integration
+
+### Workflow Chain
+
+1. **brainstorm-project** ← Current step
+2. research (optional deep dive)
+3. product-brief (strategic document)
+4. Phase 2 planning (PRD/tech-spec)
+
+### Feed Into
+
+- Product Brief development
+- Architecture decisions
+- PRD requirements
+- Epic prioritization
+
+## Best Practices
+
+1. **Prepare context** - Gather business and technical background
+2. **Think broadly** - Explore non-obvious approaches
+3. **Document assumptions** - Capture implicit beliefs
+4. **Consider constraints** - Technical, organizational, resource
+5. **Focus on value** - Align to business objectives
+
+## Configuration
+
+```yaml
+# bmad/bmm/config.yaml
+output_folder: ./output
+project_name: Your Project
+```
+
+## Related Workflows
+
+- [Research](../research/README.md) - Deep investigation
+- [Product Brief](../product-brief/README.md) - Strategic planning
+- [PRD](../../2-plan-workflows/prd/README.md) - Requirements document
+
+---
+
+Part of BMad Method v6 - Phase 1 Analysis workflows
--- a/bmad/bmm/workflows/1-analysis/brainstorm-project/instructions.md
+++ b/bmad/bmm/workflows/1-analysis/brainstorm-project/instructions.md
@@ -0,0 +1,110 @@
+# Brainstorm Project - Workflow Instructions
+
+```xml
+<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>Communicate all responses in {communication_language}</critical>
+<critical>This is a meta-workflow that orchestrates the CIS brainstorming workflow with project-specific context</critical>
+
+<workflow>
+
+  <step n="1" goal="Validate workflow readiness" tag="workflow-status">
+    <action>Check if {output_folder}/bmm-workflow-status.yaml exists</action>
+
+    <check if="status file not found">
+      <output>No workflow status file found. Brainstorming is optional - you can continue without status tracking.</output>
+      <action>Set standalone_mode = true</action>
+    </check>
+
+    <check if="status file found">
+      <action>Load the FULL file: {output_folder}/bmm-workflow-status.yaml</action>
+      <action>Parse workflow_status section</action>
+      <action>Check status of "brainstorm-project" workflow</action>
+      <action>Get project_level from YAML metadata</action>
+      <action>Find first non-completed workflow (next expected workflow)</action>
+
+      <check if="brainstorm-project status is file path (already completed)">
+        <output>⚠️ Brainstorming session already completed: {{brainstorm-project status}}</output>
+        <ask>Re-running will create a new session. Continue? (y/n)</ask>
+        <check if="n">
+          <output>Exiting. Use workflow-status to see your next step.</output>
+          <action>Exit workflow</action>
+        </check>
+      </check>
+
+      <check if="brainstorm-project is not the next expected workflow (anything after brainstorm-project is completed already)">
+        <output>⚠️ Next expected workflow: {{next_workflow}}. Brainstorming is out of sequence.</output>
+        <ask>Continue with brainstorming anyway? (y/n)</ask>
+        <check if="n">
+          <output>Exiting. Run {{next_workflow}} instead.</output>
+          <action>Exit workflow</action>
+        </check>
+      </check>
+
+      <action>Set standalone_mode = false</action>
+    </check>
+  </step>
+
+  <step n="2" goal="Load project brainstorming context">
+    <action>Read the project context document from: {project_context}</action>
+    <action>This context provides project-specific guidance including:
+      - Focus areas for project ideation
+      - Key considerations for software/product projects
+      - Recommended techniques for project brainstorming
+      - Output structure guidance
+    </action>
+  </step>
+
+  <step n="3" goal="Invoke core brainstorming with project context">
+    <action>Execute the CIS brainstorming workflow with project context</action>
+    <invoke-workflow path="{core_brainstorming}" data="{project_context}">
+      The CIS brainstorming workflow will:
+      - Present interactive brainstorming techniques menu
+      - Guide the user through selected ideation methods
+      - Generate and capture brainstorming session results
+      - Save output to: {output_folder}/brainstorming-session-results-{{date}}.md
+    </invoke-workflow>
+  </step>
+
+  <step n="4" goal="Update status and complete" tag="workflow-status">
+    <check if="standalone_mode != true">
+      <action>Load the FULL file: {output_folder}/bmm-workflow-status.yaml</action>
+      <action>Find workflow_status key "brainstorm-project"</action>
+      <critical>ONLY write the file path as the status value - no other text, notes, or metadata</critical>
+      <action>Update workflow_status["brainstorm-project"] = "{output_folder}/bmm-brainstorming-session-{{date}}.md"</action>
+      <action>Save file, preserving ALL comments and structure including STATUS DEFINITIONS</action>
+
+      <action>Find first non-completed workflow in workflow_status (next workflow to do)</action>
+      <action>Determine next agent from path file based on next workflow</action>
+    </check>
+
+    <output>**✅ Brainstorming Session Complete, {user_name}!**
+
+**Session Results:**
+
+- Brainstorming results saved to: {output_folder}/bmm-brainstorming-session-{{date}}.md
+
+{{#if standalone_mode != true}}
+**Status Updated:**
+
+- Progress tracking updated
+
+**Next Steps:**
+
+- **Next required:** {{next_workflow}} ({{next_agent}} agent)
+- **Optional:** You can run other analysis workflows (research, product-brief) before proceeding
+
+Check status anytime with: `workflow-status`
+{{else}}
+**Next Steps:**
+
+Since no workflow is in progress:
+
+- Refer to the BMM workflow guide if unsure what to do next
+- Or run `workflow-init` to create a workflow path and get guided next steps
+{{/if}}
+    </output>
+  </step>
+
+</workflow>
+```
--- a/bmad/bmm/workflows/1-analysis/brainstorm-project/project-context.md
+++ b/bmad/bmm/workflows/1-analysis/brainstorm-project/project-context.md
@@ -0,0 +1,25 @@
+# Project Brainstorming Context
+
+This context guide provides project-specific considerations for brainstorming sessions focused on software and product development.
+
+## Session Focus Areas
+
+When brainstorming for projects, consider exploring:
+
+- **User Problems and Pain Points** - What challenges do users face?
+- **Feature Ideas and Capabilities** - What could the product do?
+- **Technical Approaches** - How might we build it?
+- **User Experience** - How will users interact with it?
+- **Business Model and Value** - How does it create value?
+- **Market Differentiation** - What makes it unique?
+- **Technical Risks and Challenges** - What could go wrong?
+- **Success Metrics** - How will we measure success?
+
+## Integration with Project Workflow
+
+Brainstorming sessions typically feed into:
+
+- **Product Briefs** - Initial product vision and strategy
+- **PRDs** - Detailed requirements documents
+- **Technical Specifications** - Architecture and implementation plans
+- **Research Activities** - Areas requiring further investigation
--- a/bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml
+++ b/bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml
@@ -0,0 +1,26 @@
+# Brainstorm Project Workflow Configuration
+name: "brainstorm-project"
+description: "Facilitate project brainstorming sessions by orchestrating the CIS brainstorming workflow with project-specific context and guidance."
+author: "BMad"
+
+# Critical variables from config
+config_source: "{project-root}/bmad/bmm/config.yaml"
+output_folder: "{config_source}:output_folder"
+user_name: "{config_source}:user_name"
+communication_language: "{config_source}:communication_language"
+document_output_language: "{config_source}:document_output_language"
+user_skill_level: "{config_source}:user_skill_level"
+date: system-generated
+
+# Module path and component files
+installed_path: "{project-root}/bmad/bmm/workflows/1-analysis/brainstorm-project"
+template: false
+instructions: "{installed_path}/instructions.md"
+
+# Context document for project brainstorming
+project_context: "{installed_path}/project-context.md"
+
+# CORE brainstorming workflow to invoke
+core_brainstorming: "{project-root}/bmad/core/workflows/brainstorming/workflow.yaml"
+
+standalone: true