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>
61 lines
2.2 KiB
YAML
61 lines
2.2 KiB
YAML
# Technical Specification Workflow (Level 0)
|
|
name: tech-spec-sm
|
|
description: "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."
|
|
author: "BMad"
|
|
|
|
# Critical variables from config
|
|
config_source: "{project-root}/bmad/bmm/config.yaml"
|
|
project_name: "{config_source}:project_name"
|
|
output_folder: "{config_source}:output_folder"
|
|
user_name: "{config_source}:user_name"
|
|
communication_language: "{config_source}:communication_language"
|
|
document_output_language: "{config_source}:document_output_language"
|
|
user_skill_level: "{config_source}:user_skill_level"
|
|
date: system-generated
|
|
|
|
# Runtime variables (captured during workflow execution)
|
|
project_level: runtime-captured
|
|
project_type: runtime-captured
|
|
development_context: runtime-captured
|
|
change_type: runtime-captured
|
|
field_type: runtime-captured
|
|
|
|
# Workflow components
|
|
installed_path: "{project-root}/bmad/bmm/workflows/2-plan-workflows/tech-spec"
|
|
instructions: "{installed_path}/instructions.md"
|
|
template: "{installed_path}/tech-spec-template.md"
|
|
|
|
# Story generation instructions (invoked based on level)
|
|
instructions_level0_story: "{installed_path}/instructions-level0-story.md"
|
|
instructions_level1_stories: "{installed_path}/instructions-level1-stories.md"
|
|
|
|
# Templates
|
|
user_story_template: "{installed_path}/user-story-template.md"
|
|
epics_template: "{installed_path}/epics-template.md"
|
|
|
|
# Output configuration
|
|
default_output_file: "{output_folder}/tech-spec.md"
|
|
user_story_file: "{output_folder}/user-story.md"
|
|
epics_file: "{output_folder}/epics.md"
|
|
|
|
# Recommended input documents (optional for Level 0)
|
|
recommended_inputs:
|
|
- bug_report: "Bug description or issue ticket"
|
|
- feature_request: "Brief feature description"
|
|
|
|
# Smart input file references - handles both whole docs and sharded docs
|
|
# Priority: Whole document first, then sharded version
|
|
input_file_patterns:
|
|
product_brief:
|
|
whole: "{output_folder}/*brief*.md"
|
|
sharded: "{output_folder}/*brief*/index.md"
|
|
|
|
research:
|
|
whole: "{output_folder}/*research*.md"
|
|
sharded: "{output_folder}/*research*/index.md"
|
|
|
|
document_project:
|
|
sharded: "{output_folder}/docs/index.md"
|
|
|
|
standalone: true
|