ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity
BMAD-METHOD/bmad/bmb/workflows/redoc
History
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
..
README.md minor fixes 2025-10-16 21:50:50 -05:00
checklist.md minor fixes 2025-10-16 21:50:50 -05:00
instructions.md installer improvements 2025-10-28 12:47:45 -05:00
workflow.yaml installer improvements 2025-10-28 12:47:45 -05:00
workflow.yaml.bak docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00

README.md

ReDoc - Reverse-Tree Documentation Engine

Type: Autonomous Action Workflow Module: BMad Builder (bmb)

Purpose

ReDoc is an intelligent documentation maintenance system for BMAD modules, workflows, and agents. It uses a reverse-tree approach (leaf folders first, then parent folders) to systematically generate and update README.md files with technical writer quality output.

The workflow understands BMAD conventions deeply and focuses documentation on distinctive features rather than explaining standard patterns, resulting in succinct, precise technical documentation.

Key Features

  • Reverse-Tree Processing: Documents from deepest folders up to module root, allowing child documentation to inform parent summaries
  • Convention-Aware: Loads BMAD architecture patterns and only documents unique/distinctive aspects
  • Scalability: Automatically creates catalog documents (WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md) for massive folders (>10 items)
  • Diff-Aware: Tracks last-redoc-date frontmatter to enable change detection since last run
  • Autonomous: Runs without user checkpoints unless clarification is genuinely required
  • Comprehensive: Reads ALL files completely before generating documentation (no partial reads)

Usage

Invoke with a target path:

workflow redoc

When prompted, provide one of:

  • Module path: bmad/bmm (documents entire module: root, workflows, agents)
  • Workflows folder: bmad/bmm/workflows (documents all workflows)
  • Agents folder: bmad/bmm/agents (documents all agents)
  • Single workflow: bmad/bmm/workflows/product-brief (documents one workflow)
  • Single agent: bmad/bmm/agents/prd-agent.md (documents one agent)

Inputs

Required

  • target_path: Path to module, folder, or specific component to document

Knowledge Base (Auto-loaded)

  • agent-architecture.md
  • agent-command-patterns.md
  • agent-types.md
  • module-structure.md
  • workflow-creation-guide.md

Outputs

Created/Updated Files

  • README.md: At each documented level (workflow folders, agent folders, module root)
  • Catalog files: WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md (for massive folders)
  • Frontmatter: All READMEs include last-redoc-date: <timestamp>

Summary Report

  • Documentation coverage statistics
  • List of files created/updated
  • Any items requiring manual review

Workflow Steps

  1. Initialize: Load BMAD conventions and validate target
  2. Analyze Structure: Build reverse-tree execution plan
  3. Process Leaves: Document individual workflows/agents (deepest first)
  4. Process Folders: Document workflow/agent collections with categorization
  5. Process Root: Document module overview with links and highlights
  6. Validate: Verify completeness and generate report
  7. Diff Analysis (optional): Show changes since last redoc
  8. Complete: Report success and suggest next steps

Technical Details

  • Execution: Autonomous with minimal user interaction
  • Quality: Technical writer standards - succinct, precise, professional
  • Context-Aware: Uses BMAD convention knowledge to highlight only distinctive features
  • Scalable: Handles folders of any size with intelligent catalog creation

Next Steps After Running

  1. Review generated documentation for accuracy
  2. If documenting a subfolder, run redoc on parent module to update references
  3. Commit documentation updates with meaningful message