docs: add comprehensive README for story-implementation expansion pack
Add detailed documentation following BMAD repository standards: - Complete overview and purpose explanation - Dual workflow usage guide with selection criteria - Comprehensive component breakdown (workflows, tasks, checklists) - Core BMAD integration details and agent requirements - Installation and usage examples for both workflow variants - Learning system documentation with 6-category triage - Epic management and retrospective system explanation - Team integration patterns and customization guidance 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
2-gabadi
parent
70585ede70
commit
3349a90ee4
|
|
@ -0,0 +1,239 @@
|
||||||
|
# Story Implementation Expansion Pack
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
Comprehensive end-to-end story implementation workflows with dual-variant approach, extensive validation systems, and intelligent learning extraction. Transforms epic context into production-ready deliverables with built-in quality gates and continuous improvement mechanisms.
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
Addresses the complexity gap in agile story implementation by providing:
|
||||||
|
- **Progressive validation**: Epic readiness → Story approval → Implementation → Quality review
|
||||||
|
- **Dual workflow variants**: Simple (9 steps, 2-3 days) vs Standard (15 steps, 4-5 days)
|
||||||
|
- **Comprehensive review system**: Round 1 multi-agent reviews + Round 2+ efficient validation
|
||||||
|
- **Learning extraction**: Structured triage system feeding future epics and process improvement
|
||||||
|
- **Epic progress tracking**: Automatic completion tracking with retrospective triggers
|
||||||
|
|
||||||
|
## When to Use This Pack
|
||||||
|
|
||||||
|
### Use story-simple workflow for:
|
||||||
|
- UI/UX improvements and content updates
|
||||||
|
- Simple bug fixes and configuration changes
|
||||||
|
- Minor backend adjustments
|
||||||
|
- Straightforward feature toggles
|
||||||
|
|
||||||
|
### Use story-implementation workflow for:
|
||||||
|
- New feature development with business logic
|
||||||
|
- Database schema changes and migrations
|
||||||
|
- Cross-system integrations
|
||||||
|
- Complex user workflows and state management
|
||||||
|
|
||||||
|
## What's Included
|
||||||
|
|
||||||
|
### Workflows
|
||||||
|
- **story-simple.yml**: Streamlined 9-step workflow for simple changes
|
||||||
|
- **story-implementation.yml**: Comprehensive 15-step workflow for complex features
|
||||||
|
|
||||||
|
### Tasks
|
||||||
|
- **approve-story-for-development.md**: Product Owner validation and approval
|
||||||
|
- **setup-development-environment.md**: Environment preparation and validation
|
||||||
|
- **implement-story-development.md**: Project-agnostic implementation with build integration
|
||||||
|
- **consolidate-review-feedback.md**: Multi-agent feedback consolidation with priority classification
|
||||||
|
- **implement-consolidated-fixes.md**: Systematic fix implementation based on consolidated feedback
|
||||||
|
- **validate-consolidated-fixes.md**: Architect validation with browser MCP testing
|
||||||
|
- **capture-learning-triage.md**: Structured learning extraction in 6 categories
|
||||||
|
- **party-mode-learning-review.md**: Collaborative team learning session
|
||||||
|
- **commit-and-prepare-pr.md**: Context generation for comprehensive PRs
|
||||||
|
- **create-comprehensive-pr.md**: Business-context rich PR creation
|
||||||
|
- **update-epic-progress.md**: Epic completion tracking with learning integration
|
||||||
|
- **epic-party-mode-retrospective.md**: Automatic epic retrospective with multi-agent analysis
|
||||||
|
|
||||||
|
### Checklists
|
||||||
|
- **story-approval-checklist.md**: Product Owner story validation framework
|
||||||
|
- **epic-readiness-checklist.md**: Epic business readiness validation
|
||||||
|
|
||||||
|
## Integration with Core BMAD
|
||||||
|
|
||||||
|
### Required Core Agents
|
||||||
|
- **sm** (Scrum Master): Workflow orchestration and process management
|
||||||
|
- **po** (Product Owner): Business validation and story approval
|
||||||
|
- **dev** (Developer): Implementation execution and code quality
|
||||||
|
- **architect** (Architect): Technical validation and learning triage
|
||||||
|
- **qa** (Quality Assurance): Quality gate validation
|
||||||
|
- **ux-expert** (UX Expert): User experience validation
|
||||||
|
- **infra-devops-platform** (DevOps): Environment and infrastructure management
|
||||||
|
|
||||||
|
### Core Components Integration
|
||||||
|
- Leverages existing **story-tmpl.md** for consistent story structure
|
||||||
|
- Uses **story-draft-checklist.md** for initial story validation
|
||||||
|
- Integrates with **create-next-story** task for epic progression
|
||||||
|
- Connects to core architect and PO validation workflows
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install the story implementation expansion pack
|
||||||
|
bmad install expansion-pack story-implementation
|
||||||
|
|
||||||
|
# Verify installation
|
||||||
|
bmad list expansion-packs
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage Examples
|
||||||
|
|
||||||
|
### Simple Story Implementation
|
||||||
|
```bash
|
||||||
|
# For UI changes, content updates, simple fixes
|
||||||
|
*workflow story-simple epic_number=5 story_number=3
|
||||||
|
|
||||||
|
# Example output: Epic 5, Story 3 implemented with 9 validation steps
|
||||||
|
```
|
||||||
|
|
||||||
|
### Full Feature Implementation
|
||||||
|
```bash
|
||||||
|
# For complex features, business logic, integrations
|
||||||
|
*workflow story-implementation epic_number=12 story_number=7
|
||||||
|
|
||||||
|
# Example output: Epic 12, Story 7 with comprehensive 15-step workflow
|
||||||
|
```
|
||||||
|
|
||||||
|
### Workflow Selection Validation
|
||||||
|
Both workflows include complexity validation warnings to ensure appropriate selection based on:
|
||||||
|
- Implementation scope and complexity
|
||||||
|
- Business logic requirements
|
||||||
|
- Integration touchpoints
|
||||||
|
- Quality validation needs
|
||||||
|
|
||||||
|
## Workflow Selection Guide
|
||||||
|
|
||||||
|
| Criteria | story-simple | story-implementation |
|
||||||
|
|----------|--------------|---------------------|
|
||||||
|
| **Duration** | 2-3 days | 4-5 days |
|
||||||
|
| **Steps** | 9 optimized steps | 15 comprehensive steps |
|
||||||
|
| **Code Changes** | Single component focus | Multi-component integration |
|
||||||
|
| **Business Logic** | Minimal/none | Significant business rules |
|
||||||
|
| **Database Changes** | Read-only or minor | Schema changes, migrations |
|
||||||
|
| **Testing Scope** | Component-level | Integration and system-level |
|
||||||
|
| **Review Rounds** | Single efficient round | Multi-round comprehensive |
|
||||||
|
|
||||||
|
## Team Integration
|
||||||
|
|
||||||
|
### Agent Team Configuration
|
||||||
|
Add to your team configuration files:
|
||||||
|
```yaml
|
||||||
|
expansion_packs:
|
||||||
|
- story-implementation
|
||||||
|
|
||||||
|
workflows:
|
||||||
|
story_simple:
|
||||||
|
trigger: "story-simple"
|
||||||
|
agents: [sm, po, dev, architect]
|
||||||
|
|
||||||
|
story_implementation:
|
||||||
|
trigger: "story-implementation"
|
||||||
|
agents: [sm, po, dev, architect, qa, ux-expert, infra-devops-platform]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Role Assignments
|
||||||
|
- **SM**: Workflow orchestration, process compliance, team coordination
|
||||||
|
- **PO**: Business validation, story approval, value assessment
|
||||||
|
- **Dev**: Implementation execution, code quality, technical fixes
|
||||||
|
- **Architect**: Technical validation, learning triage, system design
|
||||||
|
- **QA**: Quality gates, testing validation, defect management
|
||||||
|
- **UX-Expert**: User experience validation, design consistency
|
||||||
|
- **DevOps**: Environment setup, build integration, deployment readiness
|
||||||
|
|
||||||
|
## Learning System
|
||||||
|
|
||||||
|
### Six Learning Categories
|
||||||
|
1. **ARCH_CHANGE**: Architecture improvements and technical debt
|
||||||
|
2. **FUTURE_EPIC**: Epic candidates and feature opportunities
|
||||||
|
3. **URGENT_FIX**: Critical issues requiring immediate attention
|
||||||
|
4. **PROCESS_IMPROVEMENT**: Development workflow enhancements
|
||||||
|
5. **TOOLING**: Infrastructure and automation improvements
|
||||||
|
6. **KNOWLEDGE_GAP**: Team training and skill development needs
|
||||||
|
|
||||||
|
### Learning Flow
|
||||||
|
```
|
||||||
|
Implementation → Learning Triage → Collaborative Review → Epic Integration → Retrospective
|
||||||
|
```
|
||||||
|
|
||||||
|
### Learning Integration
|
||||||
|
- **Story Level**: Individual story learning capture and triage
|
||||||
|
- **Epic Level**: Aggregated learning analysis and pattern identification
|
||||||
|
- **Team Level**: Collaborative review sessions with consensus building
|
||||||
|
- **Process Level**: Continuous improvement based on learning insights
|
||||||
|
|
||||||
|
## Epic Management
|
||||||
|
|
||||||
|
### Epic Progress Tracking
|
||||||
|
- Automatic story completion percentage calculation
|
||||||
|
- Learning integration across all epic stories
|
||||||
|
- Epic health monitoring and risk assessment
|
||||||
|
- Completion milestone triggers
|
||||||
|
|
||||||
|
### Epic Retrospective System
|
||||||
|
- **Trigger**: Automatic when epic reaches 100% completion
|
||||||
|
- **Participants**: Multi-agent collaborative analysis (SM, Architect, PO, Dev, UX-Expert)
|
||||||
|
- **Output**: Strategic insights, action items, knowledge base creation
|
||||||
|
- **Integration**: Seamless connection with final story PR
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
### Core BMAD Components Required
|
||||||
|
- bmad-core v4.0+ (agent framework and core tasks)
|
||||||
|
- Core agent definitions (sm, po, dev, architect, qa, ux-expert, infra-devops-platform)
|
||||||
|
- Core templates (story-tmpl.md, story-draft-checklist.md)
|
||||||
|
- Core workflow engine and Task tool execution capabilities
|
||||||
|
|
||||||
|
### External Dependencies
|
||||||
|
- Git repository with proper branch management
|
||||||
|
- Build system integration (detected automatically)
|
||||||
|
- Browser MCP for testing validation (optional but recommended)
|
||||||
|
- GitHub CLI for PR creation (optional but recommended)
|
||||||
|
|
||||||
|
## Customization
|
||||||
|
|
||||||
|
### Workflow Customization
|
||||||
|
Modify workflow files to adjust:
|
||||||
|
- Task sequence and dependencies
|
||||||
|
- Agent assignments and responsibilities
|
||||||
|
- Quality gate criteria and thresholds
|
||||||
|
- Learning extraction categories and priorities
|
||||||
|
|
||||||
|
### Task Customization
|
||||||
|
Individual tasks can be customized for:
|
||||||
|
- Organization-specific validation criteria
|
||||||
|
- Custom build and test integration
|
||||||
|
- Extended learning categories
|
||||||
|
- Modified review and approval processes
|
||||||
|
|
||||||
|
### Template Integration
|
||||||
|
Customize story and epic templates to match:
|
||||||
|
- Organization documentation standards
|
||||||
|
- Business context requirements
|
||||||
|
- Technical architecture patterns
|
||||||
|
- Quality and compliance needs
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
⚠️ **Important Considerations:**
|
||||||
|
- Both workflows require Task tool execution for proper expansion pack compliance
|
||||||
|
- Epic files must exist and be properly formatted before story creation
|
||||||
|
- Learning system requires structured documentation for maximum effectiveness
|
||||||
|
- Browser MCP integration highly recommended for comprehensive testing validation
|
||||||
|
- Epic retrospective triggers automatically - ensure team availability for collaborative sessions
|
||||||
|
|
||||||
|
🔧 **Performance Optimization:**
|
||||||
|
- Simple workflow optimized for rapid iteration on straightforward changes
|
||||||
|
- Implementation workflow designed for comprehensive validation of complex features
|
||||||
|
- Learning system token-optimized for efficient LLM processing
|
||||||
|
- Review consolidation reduces validation overhead in subsequent rounds
|
||||||
|
|
||||||
|
📊 **Quality Metrics:**
|
||||||
|
- Built-in complexity validation prevents workflow misselection
|
||||||
|
- Multi-round review system ensures comprehensive quality validation
|
||||||
|
- Learning extraction drives continuous process improvement
|
||||||
|
- Epic progress tracking provides visibility into delivery health
|
||||||
|
|
||||||
|
---
|
||||||
|
_Version: 1.0.0_
|
||||||
|
_Compatible with: BMAD Method v4.0+_
|
||||||
|
_Build on: Core bmad-method components for maximum reliability_
|
||||||
Loading…
Reference in New Issue