mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
7eb52520fa
- 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.
4.0 KiB
4.0 KiB
ReDoc Workflow Validation Checklist
Initialization and Setup
- All BMAD convention documents loaded and understood
- Target path validated and exists
- Target type correctly identified (module/workflow/agent/folder)
- Documentation execution plan created with reverse-tree order
File Analysis
- All files in target scope read completely (no offset/limit usage)
- Existing README.md files detected and last-redoc-date parsed
- Massive folders (>10 items) identified for catalog document creation
- Documentation depth levels calculated correctly
Leaf-Level Documentation (Workflows)
- Each workflow's ALL files read: workflow.yaml, instructions.md, template.md, checklist.md
- README.md includes frontmatter with current last-redoc-date
- Description is 2-4 paragraphs of technical writer quality
- Focuses on DISTINCTIVE features, not BMAD boilerplate conventions
- Includes "Usage" section with invocation command
- Includes "Inputs" and "Outputs" sections where applicable
- Succinct and precise language used throughout
Leaf-Level Documentation (Agents)
- Each agent file read completely including XML structure, commands, persona
- README.md includes frontmatter with current last-redoc-date
- Description is 1-3 paragraphs of technical writer quality
- Lists all available commands clearly
- Explains when to use this agent
- Highlights unique capabilities vs standard agent patterns
Mid-Level Documentation (Folders)
- All child README.md files read before generating folder README
- Workflows categorized logically if massive folder (>10 items)
- Agents categorized by type if massive folder (>10 items)
- Catalog documents (WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md) created for massive folders
- Catalog documents include frontmatter with last-redoc-date
- Folder README.md references catalog if one exists
- Folder README.md is succinct (1-2 paragraphs + listings/links)
- Notable/commonly-used items highlighted
Root Module Documentation
- Module config.yaml read and understood
- Workflows and agents folder READMEs read before creating root README
- Root README includes frontmatter with current last-redoc-date
- Module purpose clearly stated in 2-3 sentences
- Links to /workflows/README.md and /agents/README.md included
- 2-3 key workflows mentioned with context
- 2-3 key agents mentioned with context
- Configuration section highlights UNIQUE settings only
- Usage section explains invocation patterns
- BMAD convention knowledge applied (describes only distinctive aspects)
Quality Standards
- All documentation uses proper BMAD terminology
- Technical writer quality: clear, concise, professional
- No placeholder text or generic descriptions remain
- All links are valid and correctly formatted
- Frontmatter syntax is correct and dates are current
- No redundant explanation of standard BMAD patterns
Validation and Reporting
- All planned documentation items created/updated
- Frontmatter dates verified as current across all files
- File paths and internal links validated
- Summary report generated with counts and coverage
- Files skipped (if any) documented with reasons
Git Diff Analysis (Optional Step)
- last-redoc-date timestamps extracted correctly
- Git log queried for changes since last redoc
- Modified files identified and reported
- Findings presented clearly to user
Final Validation
-
Documentation Coverage
- All README.md files in scope created/updated
- Catalog documents created where needed
- No documentation gaps identified
-
Execution Quality
- Reverse-tree order followed (leaf → root)
- Autonomous execution (minimal user prompts)
- Only clarification questions asked when truly necessary
-
Output Quality
- Technical precision maintained throughout
- Succinct descriptions (no verbose explanations)
- Professional documentation standards met