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>
56 lines
1.8 KiB
YAML
56 lines
1.8 KiB
YAML
# Sprint Status Template
|
|
# This is an EXAMPLE showing the expected format
|
|
# The actual file will be generated with all epics/stories from your epic files
|
|
|
|
# generated: {date}
|
|
# project: {project_name}
|
|
# project_key: {project_key}
|
|
# tracking_system: {tracking_system}
|
|
# story_location: {story_location}
|
|
|
|
# STATUS DEFINITIONS:
|
|
# ==================
|
|
# Epic Status:
|
|
# - backlog: Epic exists in epic file but not contexted
|
|
# - contexted: Next epic tech context created by *epic-tech-context (required)
|
|
#
|
|
# Story Status:
|
|
# - backlog: Story only exists in epic file
|
|
# - drafted: Story file created in stories folder by *create-story
|
|
# - ready-for-dev: Draft approved and story context created by *story-ready
|
|
# - in-progress: Developer actively working on implementation by *dev-story
|
|
# - review: Implementation complete, ready for review by *code-review
|
|
# - done: Story completed by *story-done
|
|
#
|
|
# Retrospective Status:
|
|
# - optional: Can be completed but not required
|
|
# - completed: Retrospective has been done by *retrospective
|
|
#
|
|
# WORKFLOW NOTES:
|
|
# ===============
|
|
# - Epics should be 'contexted' before stories can be 'drafted'
|
|
# - SM typically drafts next story ONLY after previous one is 'done' to incorporate learnings
|
|
# - Dev moves story to 'review', dev reviews, then Dev moves to 'done'
|
|
|
|
# EXAMPLE STRUCTURE (your actual epics/stories will replace these):
|
|
|
|
generated: 05-06-2-2025 21:30
|
|
project: My Awesome Project
|
|
project_key: jira-1234
|
|
tracking_system: file-system
|
|
story_location: "{project-root}/docs/stories"
|
|
|
|
development_status:
|
|
epic-1: contexted
|
|
1-1-user-authentication: done
|
|
1-2-account-management: drafted
|
|
1-3-plant-data-model: backlog
|
|
1-4-add-plant-manual: backlog
|
|
epic-1-retrospective: optional
|
|
|
|
epic-2: backlog
|
|
2-1-personality-system: backlog
|
|
2-2-chat-interface: backlog
|
|
2-3-llm-integration: backlog
|
|
epic-2-retrospective: optional
|