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>
161 lines
4.7 KiB
JSON
161 lines
4.7 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"title": "Project Scan Report Schema",
|
|
"description": "State tracking file for document-project workflow resumability",
|
|
"type": "object",
|
|
"required": ["workflow_version", "timestamps", "mode", "scan_level", "completed_steps", "current_step"],
|
|
"properties": {
|
|
"workflow_version": {
|
|
"type": "string",
|
|
"description": "Version of document-project workflow",
|
|
"example": "1.2.0"
|
|
},
|
|
"timestamps": {
|
|
"type": "object",
|
|
"required": ["started", "last_updated"],
|
|
"properties": {
|
|
"started": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "ISO 8601 timestamp when workflow started"
|
|
},
|
|
"last_updated": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "ISO 8601 timestamp of last state update"
|
|
},
|
|
"completed": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "ISO 8601 timestamp when workflow completed (if finished)"
|
|
}
|
|
}
|
|
},
|
|
"mode": {
|
|
"type": "string",
|
|
"enum": ["initial_scan", "full_rescan", "deep_dive"],
|
|
"description": "Workflow execution mode"
|
|
},
|
|
"scan_level": {
|
|
"type": "string",
|
|
"enum": ["quick", "deep", "exhaustive"],
|
|
"description": "Scan depth level (deep_dive mode always uses exhaustive)"
|
|
},
|
|
"project_root": {
|
|
"type": "string",
|
|
"description": "Absolute path to project root directory"
|
|
},
|
|
"output_folder": {
|
|
"type": "string",
|
|
"description": "Absolute path to output folder"
|
|
},
|
|
"completed_steps": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"required": ["step", "status"],
|
|
"properties": {
|
|
"step": {
|
|
"type": "string",
|
|
"description": "Step identifier (e.g., 'step_1', 'step_2')"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"enum": ["completed", "partial", "failed"]
|
|
},
|
|
"timestamp": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"outputs": {
|
|
"type": "array",
|
|
"items": { "type": "string" },
|
|
"description": "Files written during this step"
|
|
},
|
|
"summary": {
|
|
"type": "string",
|
|
"description": "1-2 sentence summary of step outcome"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"current_step": {
|
|
"type": "string",
|
|
"description": "Current step identifier for resumption"
|
|
},
|
|
"findings": {
|
|
"type": "object",
|
|
"description": "High-level summaries only (detailed findings purged after writing)",
|
|
"properties": {
|
|
"project_classification": {
|
|
"type": "object",
|
|
"properties": {
|
|
"repository_type": { "type": "string" },
|
|
"parts_count": { "type": "integer" },
|
|
"primary_language": { "type": "string" },
|
|
"architecture_type": { "type": "string" }
|
|
}
|
|
},
|
|
"technology_stack": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"part_id": { "type": "string" },
|
|
"tech_summary": { "type": "string" }
|
|
}
|
|
}
|
|
},
|
|
"batches_completed": {
|
|
"type": "array",
|
|
"description": "For deep/exhaustive scans: subfolders processed",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": { "type": "string" },
|
|
"files_scanned": { "type": "integer" },
|
|
"summary": { "type": "string" }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"outputs_generated": {
|
|
"type": "array",
|
|
"items": { "type": "string" },
|
|
"description": "List of all output files generated"
|
|
},
|
|
"resume_instructions": {
|
|
"type": "string",
|
|
"description": "Instructions for resuming from current_step"
|
|
},
|
|
"validation_status": {
|
|
"type": "object",
|
|
"properties": {
|
|
"last_validated": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"validation_errors": {
|
|
"type": "array",
|
|
"items": { "type": "string" }
|
|
}
|
|
}
|
|
},
|
|
"deep_dive_targets": {
|
|
"type": "array",
|
|
"description": "Track deep-dive areas analyzed (for deep_dive mode)",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target_name": { "type": "string" },
|
|
"target_path": { "type": "string" },
|
|
"files_analyzed": { "type": "integer" },
|
|
"output_file": { "type": "string" },
|
|
"timestamp": { "type": "string", "format": "date-time" }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|