## 📚 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> |
||
|---|---|---|
| .. | ||
| README.md | ||
| checklist.md | ||
| instructions.md | ||
| sprint-status-template.yaml | ||
| workflow.yaml | ||
README.md
Sprint Planning Workflow
Overview
The sprint-planning workflow generates and manages the sprint status tracking file that serves as the single source of truth for Phase 4 implementation. It extracts all epics and stories from epic files and tracks their progress through the development lifecycle.
In Agile terminology, this workflow facilitates Sprint Planning or Sprint 0 Kickoff - the transition from planning/architecture into actual development execution.
Purpose
This workflow creates a sprint-status.yaml file that:
- Lists all epics, stories, and retrospectives in order
- Tracks the current status of each item
- Provides a clear view of what needs to be worked on next
- Ensures only one story is in progress at a time
- Maintains the development flow from backlog to done
When to Use
Run this workflow:
- Initially - After Phase 3 (solutioning) is complete and epics are finalized
- After epic context creation - To update epic status to 'contexted'
- Periodically - To auto-detect newly created story files
- For status checks - To see overall project progress
Status State Machine
Epic Flow
backlog → contexted
Story Flow
backlog → drafted → ready-for-dev → in-progress → review → done
Retrospective Flow
optional ↔ completed
Key Guidelines
- Epic Context Recommended: Epics should be
contextedbefore their stories can bedrafted - Flexible Parallelism: Multiple stories can be
in-progressbased on team capacity - Sequential Default: Stories within an epic are typically worked in order, but parallel work is supported
- Review Flow: Stories should go through
reviewbeforedone - Learning Transfer: SM typically drafts next story after previous is
done, incorporating learnings
File Locations
Input Files
- Epic Files:
{output_folder}/epic*.mdor{output_folder}/epics.md - Epic Context:
{output_folder}/epic-{n}-context.md - Story Files:
{story_dir}/{epic}-{story}-{title}.md- Example:
stories/1-1-user-authentication.md
- Example:
- Story Context:
{story_dir}/{epic}-{story}-{title}-context.md- Example:
stories/1-1-user-authentication-context.md
- Example:
Output File
- Status File:
{output_folder}/sprint-status.yaml
Usage by Agents
SM (Scrum Master) Agent
Tasks:
- Check sprint-status.yaml for stories in 'done' status
- Identify next 'backlog' story to draft
- Run create-story workflow
- Update status to 'drafted'
- Create story context
- Update status to 'ready-for-dev'
Developer Agent
Tasks:
- Find stories with 'ready-for-dev' status
- Update to 'in-progress' when starting
- Implement the story
- Update to 'review' when complete
- Address review feedback
- Update to 'done' after review
Test Architect
Tasks:
- Monitor stories entering 'review'
- Track epic progress
- Identify when retrospectives are needed
Example Output
# Sprint Status
# Generated: 2025-01-20
# Project: MyPlantFamily
development_status:
epic-1: contexted
1-1-project-foundation: done
1-2-app-shell: done
1-3-user-authentication: in-progress
1-4-plant-data-model: ready-for-dev
1-5-add-plant-manual: drafted
1-6-photo-identification: backlog
epic-1-retrospective: optional
epic-2: contexted
2-1-personality-system: in-progress
2-2-chat-interface: drafted
2-3-llm-integration: backlog
2-4-reminder-system: backlog
epic-2-retrospective: optional
Integration with BMM Workflow
This workflow is part of Phase 4 (Implementation) and integrates with:
- epic-tech-context - Creates technical context for epics
- create-story - Drafts individual story files
- story-context - Adds implementation context to stories
- dev-story - Developer implements the story
- code-review - SM reviews implementation
- retrospective - Optional epic retrospective
Benefits
- Clear Visibility: Everyone knows what's being worked on
- Flexible Capacity: Supports both sequential and parallel work patterns
- Learning Transfer: SM can incorporate learnings when drafting next story
- Progress Tracking: Easy to see overall project status
- Automation Friendly: Simple YAML format for agent updates
Tips
- Initial Generation: Run immediately after epics are finalized
- Regular Updates: Agents should update status as they work
- Manual Override: You can manually edit the file if needed
- Backup First: The workflow backs up existing status before regenerating
- Validation: The workflow validates legal status transitions