mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
cfedecbd53
## 📚 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>
75 lines
3.0 KiB
YAML
75 lines
3.0 KiB
YAML
# Review Story Workflow
|
|
name: code-review
|
|
description: "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."
|
|
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"
|
|
user_skill_level: "{config_source}:user_skill_level"
|
|
document_output_language: "{config_source}:document_output_language"
|
|
date: system-generated
|
|
|
|
# Workflow components
|
|
installed_path: "{project-root}/bmad/bmm/workflows/4-implementation/code-review"
|
|
instructions: "{installed_path}/instructions.md"
|
|
validation: "{installed_path}/checklist.md"
|
|
|
|
# This is an action workflow (no output template document)
|
|
template: false
|
|
|
|
# Variables (can be provided by caller)
|
|
variables:
|
|
story_path: "" # Optional: Explicit path to story file. If not provided, finds first story with status "review"
|
|
story_dir: "{config_source}:dev_story_location" # Directory containing story files
|
|
tech_spec_search_dir: "{project-root}/docs"
|
|
tech_spec_glob_template: "tech-spec-epic-{{epic_num}}*.md"
|
|
arch_docs_search_dirs: |
|
|
- "{project-root}/docs"
|
|
- "{output_folder}"
|
|
arch_docs_file_names: |
|
|
- architecture.md
|
|
enable_mcp_doc_search: true # Prefer enabled MCP servers for doc/best-practice lookup
|
|
enable_web_fallback: true # Fallback to web search/read-url if MCP not available
|
|
# Persistence controls for review action items and notes
|
|
persist_action_items: true
|
|
# Valid targets: story_tasks, story_review_section, backlog_file, epic_followups
|
|
persist_targets: |
|
|
- story_review_section
|
|
- story_tasks
|
|
- backlog_file
|
|
- epic_followups
|
|
backlog_file: "{project-root}/docs/backlog.md"
|
|
update_epic_followups: true
|
|
epic_followups_section_title: "Post-Review Follow-ups"
|
|
|
|
# Recommended inputs
|
|
recommended_inputs:
|
|
- story: "Path to the story file (auto-discovered if omitted - finds first story with status 'review')"
|
|
- tech_spec: "Epic technical specification document (auto-discovered)"
|
|
- story_context_file: "Story context file (.context.xml) (auto-discovered)"
|
|
|
|
# Smart input file references - handles both whole docs and sharded docs
|
|
# Priority: Whole document first, then sharded version
|
|
# Strategy: SELECTIVE LOAD - only load the specific epic needed for this story review
|
|
input_file_patterns:
|
|
architecture:
|
|
whole: "{output_folder}/*architecture*.md"
|
|
sharded: "{output_folder}/*architecture*/index.md"
|
|
|
|
ux_design:
|
|
whole: "{output_folder}/*ux*.md"
|
|
sharded: "{output_folder}/*ux*/index.md"
|
|
|
|
epics:
|
|
whole: "{output_folder}/*epic*.md"
|
|
sharded_index: "{output_folder}/*epic*/index.md"
|
|
sharded_single: "{output_folder}/*epic*/epic-{{epic_num}}.md"
|
|
|
|
document_project:
|
|
sharded: "{output_folder}/docs/index.md"
|
|
|
|
standalone: true
|