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>
This commit is contained in:
Brian Madison
2025-11-02 21:18:33 -06:00
parent 8a00f8ad70
commit cfedecbd53
359 changed files with 72374 additions and 809 deletions

View File

@@ -11,3 +11,38 @@ name,description,module,path,standalone
"edit-workflow","Edit existing BMAD workflows while following all best practices and conventions","bmb","bmad/bmb/workflows/edit-workflow/workflow.yaml","true"
"module-brief","Create a comprehensive Module Brief that serves as the blueprint for building new BMAD modules using strategic analysis and creative vision","bmb","bmad/bmb/workflows/module-brief/workflow.yaml","true"
"redoc","Autonomous documentation system that maintains module, workflow, and agent documentation using a reverse-tree approach (leaf folders first, then parents). Understands BMAD conventions and produces technical writer quality output.","bmb","bmad/bmb/workflows/redoc/workflow.yaml","true"
"brainstorm-project","Facilitate project brainstorming sessions by orchestrating the CIS brainstorming workflow with project-specific context and guidance.","bmm","bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml","true"
"product-brief","Interactive product brief creation workflow that guides users through defining their product vision with multiple input sources and conversational collaboration","bmm","bmad/bmm/workflows/1-analysis/product-brief/workflow.yaml","true"
"research","Adaptive research workflow supporting multiple research types: market research, deep research prompt generation, technical/architecture evaluation, competitive intelligence, user research, and domain analysis","bmm","bmad/bmm/workflows/1-analysis/research/workflow.yaml","true"
"create-ux-design","Collaborative UX design facilitation workflow that creates exceptional user experiences through visual exploration and informed decision-making. Unlike template-driven approaches, this workflow facilitates discovery, generates visual options, and collaboratively designs the UX with the user at every step.","bmm","bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml","true"
"narrative","Narrative design workflow for story-driven games and applications. Creates comprehensive narrative documentation including story structure, character arcs, dialogue systems, and narrative implementation guidance.","bmm","bmad/bmm/workflows/2-plan-workflows/narrative/workflow.yaml","true"
"create-epics-and-stories","Transform PRD requirements into bite-sized stories organized in epics for 200k context dev agents","bmm","bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml","true"
"prd","Unified PRD workflow for project levels 2-4. Produces strategic PRD and tactical epic breakdown. Hands off to architecture workflow for technical design. Note: Level 0-1 use tech-spec workflow.","bmm","bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml","true"
"tech-spec-sm","Technical specification workflow for Level 0 projects (single atomic changes). Creates focused tech spec for bug fixes, single endpoint additions, or small isolated changes. Tech-spec only - no PRD needed.","bmm","bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml","true"
"architecture","Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts.","bmm","bmad/bmm/workflows/3-solutioning/architecture/workflow.yaml","true"
"solutioning-gate-check","Systematically validate that all planning and solutioning phases are complete and properly aligned before transitioning to Phase 4 implementation. Ensures PRD, architecture, and stories are cohesive with no gaps or contradictions.","bmm","bmad/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml","true"
"code-review","Perform a Senior Developer code review on a completed story flagged Ready for Review, leveraging story-context, epic tech-spec, repo docs, MCP servers for latest best-practices, and web search as fallback. Appends structured review notes to the story.","bmm","bmad/bmm/workflows/4-implementation/code-review/workflow.yaml","true"
"correct-course","Navigate significant changes during sprint execution by analyzing impact, proposing solutions, and routing for implementation","bmm","bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml","true"
"create-story","Create the next user story markdown from epics/PRD and architecture, using a standard template and saving to the stories folder","bmm","bmad/bmm/workflows/4-implementation/create-story/workflow.yaml","true"
"dev-story","Execute a story by implementing tasks/subtasks, writing tests, validating, and updating the story file per acceptance criteria","bmm","bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml","true"
"tech-spec","Generate a comprehensive Technical Specification from PRD and Architecture with acceptance criteria and traceability mapping","bmm","bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml","true"
"retrospective","Run after epic completion to review overall success, extract lessons learned, and explore if new information emerged that might impact the next epic","bmm","bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml","true"
"sprint-planning","Generate and manage the sprint status tracking file for Phase 4 implementation, extracting all epics and stories from epic files and tracking their status through the development lifecycle","bmm","bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml","true"
"story-context","Assemble a dynamic Story Context XML by pulling latest documentation and existing code/library artifacts relevant to a drafted story","bmm","bmad/bmm/workflows/4-implementation/story-context/workflow.yaml","true"
"story-done","Marks a story as done (DoD complete) and moves it from its current status → DONE in the status file. Advances the story queue. Simple status-update workflow with no searching required.","bmm","bmad/bmm/workflows/4-implementation/story-done/workflow.yaml","true"
"story-ready","Marks a drafted story as ready for development and moves it from TODO → IN PROGRESS in the status file. Simple status-update workflow with no searching required.","bmm","bmad/bmm/workflows/4-implementation/story-ready/workflow.yaml","true"
"document-project","Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development","bmm","bmad/bmm/workflows/document-project/workflow.yaml","true"
"testarch-atdd","Generate failing acceptance tests before implementation using TDD red-green-refactor cycle","bmm","bmad/bmm/workflows/testarch/atdd/workflow.yaml","false"
"testarch-automate","Expand test automation coverage after implementation or analyze existing codebase to generate comprehensive test suite","bmm","bmad/bmm/workflows/testarch/automate/workflow.yaml","false"
"testarch-ci","Scaffold CI/CD quality pipeline with test execution, burn-in loops, and artifact collection","bmm","bmad/bmm/workflows/testarch/ci/workflow.yaml","false"
"testarch-framework","Initialize production-ready test framework architecture (Playwright or Cypress) with fixtures, helpers, and configuration","bmm","bmad/bmm/workflows/testarch/framework/workflow.yaml","false"
"testarch-nfr","Assess non-functional requirements (performance, security, reliability, maintainability) before release with evidence-based validation","bmm","bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml","false"
"testarch-test-design","Plan risk mitigation and test coverage strategy before development with risk assessment and prioritization","bmm","bmad/bmm/workflows/testarch/test-design/workflow.yaml","false"
"testarch-test-review","Review test quality using comprehensive knowledge base and best practices validation","bmm","bmad/bmm/workflows/testarch/test-review/workflow.yaml","false"
"testarch-trace","Generate requirements-to-tests traceability matrix, analyze coverage, and make quality gate decision (PASS/CONCERNS/FAIL/WAIVED)","bmm","bmad/bmm/workflows/testarch/trace/workflow.yaml","false"
"workflow-init","Initialize a new BMM project by determining level, type, and creating workflow path","bmm","bmad/bmm/workflows/workflow-status/init/workflow.yaml","true"
"workflow-status","Lightweight status checker - answers ""what should I do now?"" for any agent. Reads YAML status file for workflow tracking. Use workflow-init for new projects.","bmm","bmad/bmm/workflows/workflow-status/workflow.yaml","true"
"design-thinking","Guide human-centered design processes using empathy-driven methodologies. This workflow walks through the design thinking phases - Empathize, Define, Ideate, Prototype, and Test - to create solutions deeply rooted in user needs.","cis","bmad/cis/workflows/design-thinking/workflow.yaml","true"
"innovation-strategy","Identify disruption opportunities and architect business model innovation. This workflow guides strategic analysis of markets, competitive dynamics, and business model innovation to uncover sustainable competitive advantages and breakthrough opportunities.","cis","bmad/cis/workflows/innovation-strategy/workflow.yaml","true"
"problem-solving","Apply systematic problem-solving methodologies to crack complex challenges. This workflow guides through problem diagnosis, root cause analysis, creative solution generation, evaluation, and implementation planning using proven frameworks.","cis","bmad/cis/workflows/problem-solving/workflow.yaml","true"
"storytelling","Craft compelling narratives using proven story frameworks and techniques. This workflow guides users through structured narrative development, applying appropriate story frameworks to create emotionally resonant and engaging stories for any purpose.","cis","bmad/cis/workflows/storytelling/workflow.yaml","true"
1 name description module path standalone
11 edit-workflow Edit existing BMAD workflows while following all best practices and conventions bmb bmad/bmb/workflows/edit-workflow/workflow.yaml true
12 module-brief Create a comprehensive Module Brief that serves as the blueprint for building new BMAD modules using strategic analysis and creative vision bmb bmad/bmb/workflows/module-brief/workflow.yaml true
13 redoc Autonomous documentation system that maintains module, workflow, and agent documentation using a reverse-tree approach (leaf folders first, then parents). Understands BMAD conventions and produces technical writer quality output. bmb bmad/bmb/workflows/redoc/workflow.yaml true
14 brainstorm-project Facilitate project brainstorming sessions by orchestrating the CIS brainstorming workflow with project-specific context and guidance. bmm bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml true
15 product-brief Interactive product brief creation workflow that guides users through defining their product vision with multiple input sources and conversational collaboration bmm bmad/bmm/workflows/1-analysis/product-brief/workflow.yaml true
16 research Adaptive research workflow supporting multiple research types: market research, deep research prompt generation, technical/architecture evaluation, competitive intelligence, user research, and domain analysis bmm bmad/bmm/workflows/1-analysis/research/workflow.yaml true
17 create-ux-design Collaborative UX design facilitation workflow that creates exceptional user experiences through visual exploration and informed decision-making. Unlike template-driven approaches, this workflow facilitates discovery, generates visual options, and collaboratively designs the UX with the user at every step. bmm bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml true
18 narrative Narrative design workflow for story-driven games and applications. Creates comprehensive narrative documentation including story structure, character arcs, dialogue systems, and narrative implementation guidance. bmm bmad/bmm/workflows/2-plan-workflows/narrative/workflow.yaml true
19 create-epics-and-stories Transform PRD requirements into bite-sized stories organized in epics for 200k context dev agents bmm bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml true
20 prd Unified PRD workflow for project levels 2-4. Produces strategic PRD and tactical epic breakdown. Hands off to architecture workflow for technical design. Note: Level 0-1 use tech-spec workflow. bmm bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml true
21 tech-spec-sm Technical specification workflow for Level 0 projects (single atomic changes). Creates focused tech spec for bug fixes, single endpoint additions, or small isolated changes. Tech-spec only - no PRD needed. bmm bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml true
22 architecture Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts. bmm bmad/bmm/workflows/3-solutioning/architecture/workflow.yaml true
23 solutioning-gate-check Systematically validate that all planning and solutioning phases are complete and properly aligned before transitioning to Phase 4 implementation. Ensures PRD, architecture, and stories are cohesive with no gaps or contradictions. bmm bmad/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml true
24 code-review Perform a Senior Developer code review on a completed story flagged Ready for Review, leveraging story-context, epic tech-spec, repo docs, MCP servers for latest best-practices, and web search as fallback. Appends structured review notes to the story. bmm bmad/bmm/workflows/4-implementation/code-review/workflow.yaml true
25 correct-course Navigate significant changes during sprint execution by analyzing impact, proposing solutions, and routing for implementation bmm bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml true
26 create-story Create the next user story markdown from epics/PRD and architecture, using a standard template and saving to the stories folder bmm bmad/bmm/workflows/4-implementation/create-story/workflow.yaml true
27 dev-story Execute a story by implementing tasks/subtasks, writing tests, validating, and updating the story file per acceptance criteria bmm bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml true
28 tech-spec Generate a comprehensive Technical Specification from PRD and Architecture with acceptance criteria and traceability mapping bmm bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml true
29 retrospective Run after epic completion to review overall success, extract lessons learned, and explore if new information emerged that might impact the next epic bmm bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml true
30 sprint-planning Generate and manage the sprint status tracking file for Phase 4 implementation, extracting all epics and stories from epic files and tracking their status through the development lifecycle bmm bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml true
31 story-context Assemble a dynamic Story Context XML by pulling latest documentation and existing code/library artifacts relevant to a drafted story bmm bmad/bmm/workflows/4-implementation/story-context/workflow.yaml true
32 story-done Marks a story as done (DoD complete) and moves it from its current status → DONE in the status file. Advances the story queue. Simple status-update workflow with no searching required. bmm bmad/bmm/workflows/4-implementation/story-done/workflow.yaml true
33 story-ready Marks a drafted story as ready for development and moves it from TODO → IN PROGRESS in the status file. Simple status-update workflow with no searching required. bmm bmad/bmm/workflows/4-implementation/story-ready/workflow.yaml true
34 document-project Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development bmm bmad/bmm/workflows/document-project/workflow.yaml true
35 testarch-atdd Generate failing acceptance tests before implementation using TDD red-green-refactor cycle bmm bmad/bmm/workflows/testarch/atdd/workflow.yaml false
36 testarch-automate Expand test automation coverage after implementation or analyze existing codebase to generate comprehensive test suite bmm bmad/bmm/workflows/testarch/automate/workflow.yaml false
37 testarch-ci Scaffold CI/CD quality pipeline with test execution, burn-in loops, and artifact collection bmm bmad/bmm/workflows/testarch/ci/workflow.yaml false
38 testarch-framework Initialize production-ready test framework architecture (Playwright or Cypress) with fixtures, helpers, and configuration bmm bmad/bmm/workflows/testarch/framework/workflow.yaml false
39 testarch-nfr Assess non-functional requirements (performance, security, reliability, maintainability) before release with evidence-based validation bmm bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml false
40 testarch-test-design Plan risk mitigation and test coverage strategy before development with risk assessment and prioritization bmm bmad/bmm/workflows/testarch/test-design/workflow.yaml false
41 testarch-test-review Review test quality using comprehensive knowledge base and best practices validation bmm bmad/bmm/workflows/testarch/test-review/workflow.yaml false
42 testarch-trace Generate requirements-to-tests traceability matrix, analyze coverage, and make quality gate decision (PASS/CONCERNS/FAIL/WAIVED) bmm bmad/bmm/workflows/testarch/trace/workflow.yaml false
43 workflow-init Initialize a new BMM project by determining level, type, and creating workflow path bmm bmad/bmm/workflows/workflow-status/init/workflow.yaml true
44 workflow-status Lightweight status checker - answers "what should I do now?" for any agent. Reads YAML status file for workflow tracking. Use workflow-init for new projects. bmm bmad/bmm/workflows/workflow-status/workflow.yaml true
45 design-thinking Guide human-centered design processes using empathy-driven methodologies. This workflow walks through the design thinking phases - Empathize, Define, Ideate, Prototype, and Test - to create solutions deeply rooted in user needs. cis bmad/cis/workflows/design-thinking/workflow.yaml true
46 innovation-strategy Identify disruption opportunities and architect business model innovation. This workflow guides strategic analysis of markets, competitive dynamics, and business model innovation to uncover sustainable competitive advantages and breakthrough opportunities. cis bmad/cis/workflows/innovation-strategy/workflow.yaml true
47 problem-solving Apply systematic problem-solving methodologies to crack complex challenges. This workflow guides through problem diagnosis, root cause analysis, creative solution generation, evaluation, and implementation planning using proven frameworks. cis bmad/cis/workflows/problem-solving/workflow.yaml true
48 storytelling Craft compelling narratives using proven story frameworks and techniques. This workflow guides users through structured narrative development, applying appropriate story frameworks to create emotionally resonant and engaging stories for any purpose. cis bmad/cis/workflows/storytelling/workflow.yaml true