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 7eb52520fa Major Enhancements: 
- Installation path is now fully configurable, allowing users to specify custom installation directories during setup
  - Default installation location changed to .bmad (hidden directory) for cleaner project root organization

    Web Bundle Improvements:

    - All web bundles (single agent and team) now include party mode support for multi-agent collaboration!
    - Advanced elicitation capabilities integrated into standalone agents
    - All bundles enhanced with party mode agent manifests
    - Added default-party.csv files to bmm, bmgd, and cis module teams
    - The default party file is what will be used with single agent bundles. teams can customize for different party configurations before web bundling through a setting in the team yaml file
    - New web bundle outputs for all agents (analyst, architect, dev, pm, sm, tea, tech-writer, ux-designer, game-*, creative-squad)

    Phase 4 Workflow Updates (In Progress):

    - Initiated shift to separate phase 4 implementation artifacts from documentation
        - Phase 4 implementation artifacts (stories, code review, sprint plan, context files) will move to dedicated location outside docs folder
        - Installer questions and configuration added for artifact path selection
        - Updated workflow.yaml files for code-review, sprint-planning, story-context, epic-tech-context, and retrospective workflows to support this, but still might require some udpates

    Additional Changes:

    - New agent and action command header models for standardization
    - Enhanced web-bundle-activation-steps fragment
    - Updated web-bundler.js to support new structure
    - VS Code settings updated for new .bmad directory
    - Party mode instructions and workflow enhanced for better orchestration

   IDE Installer Updates:

    - Show version number of installer in cli
    - improved Installer UX
    - Gemini TOML Improved to have clear loading instructions with @ commands
    - All tools agent launcher mds improved to use a central file template critical indication isntead of hardcoding in 2 different locations.
 		2025-11-09 17:39:05 -06:00
..
README.md Major Enhancements: 2025-11-09 17:39:05 -06:00
checklist.md Major Enhancements: 2025-11-09 17:39:05 -06:00
instructions.md Major Enhancements: 2025-11-09 17:39:05 -06:00
workflow.yaml Major Enhancements: 2025-11-09 17:39:05 -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