ros/BMAD-METHOD
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

checklist standardization and improvement with llm eliciatation

Browse Source
This commit is contained in:
Brian Madison
2025-06-08 20:34:07 -05:00
parent 460c47f5c8
commit 8788c1d20f
24 changed files with 2419 additions and 884 deletions
Download Patch File Download Diff File Expand all files Collapse all files

324
agent-team-workflows/brownfield-service.yml
View File

@@ -2,252 +2,116 @@ workflow:
id: brownfield-service
name: Brownfield Service/API Enhancement
description: >-
Workflow for modernizing, refactoring, or enhancing existing backend services and APIs.
Handles performance optimization, API versioning, microservice extraction, and technical debt.
Agent workflow for enhancing existing backend services and APIs with new features,
modernization, or performance improvements. Handles existing system analysis and safe integration.
type: brownfield
project_types:
- service-modernization
- api-enhancement
- microservice-extraction
- performance-optimization
- technical-debt-reduction
- integration-enhancement
stages:
- id: service-analysis
name: Service Assessment
description: Analyze existing service and identify improvement areas
steps:
- agent: analyst
action: Service Assessment
description: >-
Analyze current service architecture, performance, and technical debt
inputs:
- existing-service-code
- performance-metrics
- error-logs
outputs:
- service-assessment
- performance-bottlenecks
- technical-debt-analysis
- integration-dependencies
prompts:
- "Let's analyze the current service architecture"
- "What performance issues are you experiencing?"
- "Share service metrics, logs, or documentation"
# For Complex Service Enhancements (Multiple Stories, Architectural Changes)
complex_enhancement_sequence:
- step: scope_assessment
agent: any
action: assess complexity
notes: "First, assess if this is a simple service change (use simple_enhancement_sequence) or complex enhancement requiring full planning."
- agent: fullstack-architect
action: Architecture Analysis
description: >-
Deep dive into service architecture and identify improvement opportunities
inputs:
- service-assessment
- existing-service-code
outputs:
- architecture-assessment
- refactoring-opportunities
- modernization-candidates
prompts:
- "Analyze the service architecture patterns"
- "Identify areas for modernization"
- step: service_analysis
agent: analyst
action: analyze existing service
notes: "Review existing service documentation, codebase, performance metrics, and identify integration dependencies."
- id: enhancement-planning
name: Service Enhancement Strategy
description: Plan service improvements and modernization approach
steps:
- agent: pm
action: Enhancement Strategy
description: >-
Define enhancement goals, priorities, and migration strategy
inputs:
- service-assessment
- architecture-assessment
outputs:
- enhancement-strategy
- migration-roadmap
- risk-assessment
prompts:
- "What are the primary enhancement goals?"
- "Define the migration strategy and timeline"
- agent: pm
creates: brownfield-prd.md
uses: brownfield-prd-tmpl
requires: existing_service_analysis
notes: "Creates comprehensive brownfield PRD focused on service enhancement with existing system analysis. SAVE OUTPUT: Copy final brownfield-prd.md to your project's docs/ folder."
- agent: fullstack-architect
action: Modernization Architecture
description: >-
Design target architecture for service modernization
inputs:
- enhancement-strategy
- modernization-candidates
outputs:
- target-architecture
- migration-patterns
- backward-compatibility-plan
prompts:
- "Design the target service architecture"
- "Plan for backward compatibility during migration"
- agent: architect
creates: brownfield-architecture.md
uses: brownfield-architecture-tmpl
requires: brownfield-prd.md
notes: "Creates brownfield architecture with service integration strategy and API evolution planning. SAVE OUTPUT: Copy final brownfield-architecture.md to your project's docs/ folder."
- id: incremental-refactoring
name: Incremental Refactoring Design
description: Design safe, incremental refactoring approach
steps:
- agent: fullstack-architect
action: Refactoring Strategy
description: >-
Design strangler fig pattern or other safe refactoring approaches
inputs:
- target-architecture
- integration-dependencies
outputs:
- refactoring-strategy
- service-extraction-plan
- data-migration-strategy
prompts:
- "Design strangler fig or parallel run strategy"
- "Plan service extraction and data migration"
- agent: po
validates: all_artifacts
uses: brownfield-checklist
notes: "Validates all brownfield documents for service integration safety and API compatibility. May require updates to any document."
- agent: devops
action: Infrastructure Evolution
description: >-
Plan infrastructure changes and deployment strategy
inputs:
- refactoring-strategy
- target-architecture
outputs:
- infrastructure-migration
- deployment-strategy
- monitoring-evolution
- scaling-improvements
prompts:
- "Plan infrastructure for new architecture"
- "Design zero-downtime deployment strategy"
- agent: various
updates: any_flagged_documents
condition: po_checklist_issues
notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
- id: api-evolution
name: API Versioning & Evolution
description: Plan API changes and versioning strategy
steps:
- agent: fullstack-architect
action: API Evolution Strategy
description: >-
Design API versioning and backward compatibility
inputs:
- target-architecture
- integration-dependencies
outputs:
- api-versioning-strategy
- contract-evolution-plan
- deprecation-timeline
prompts:
- "Design API versioning strategy"
- "Plan contract evolution and deprecation"
- workflow_end:
action: move_to_ide
notes: "All planning artifacts complete. Move to IDE environment to begin development. Explain to the user the IDE Development Workflow next steps: data#bmad-kb:IDE Development Workflow"
- id: data-strategy
name: Data Migration & Consistency
description: Plan data migration and consistency strategies
steps:
- agent: fullstack-architect
action: Data Migration Planning
description: >-
Plan data migration, consistency, and synchronization
inputs:
- refactoring-strategy
- data-migration-strategy
outputs:
- data-migration-plan
- consistency-strategy
- rollback-procedures
prompts:
- "Plan data migration with zero data loss"
- "Design data consistency during transition"
# For Simple Service Enhancements (1-3 Stories, Following Existing Patterns)
simple_enhancement_sequence:
- step: enhancement_type
action: choose approach
notes: "Choose between creating single story (simple API endpoint) or epic (1-3 related service changes)."
- id: quality-assurance
name: Testing & Quality Strategy
description: Plan comprehensive testing for service changes
steps:
- agent: qa
action: Service Testing Strategy
description: >-
Design testing approach for service modernization
inputs:
- refactoring-strategy
- api-versioning-strategy
outputs:
- service-test-strategy
- contract-testing-plan
- performance-testing-plan
- chaos-testing-strategy
prompts:
- "Design comprehensive service testing"
- "Plan contract tests for API evolution"
- "Design chaos engineering tests"
- agent: pm|po|sm
creates: brownfield_epic OR brownfield_story
uses: brownfield-create-epic OR brownfield-create-story
notes: "Create focused service enhancement with existing API integration. Choose agent based on team preference and context."
- id: monitoring-observability
name: Enhanced Observability
description: Plan improved monitoring and observability
steps:
- agent: devops
action: Observability Enhancement
description: >-
Design enhanced monitoring, logging, and alerting
inputs:
- target-architecture
- performance-bottlenecks
outputs:
- observability-strategy
- sli-slo-definitions
- alerting-improvements
- dashboards-design
prompts:
- "Design comprehensive service observability"
- "Define SLIs and SLOs for the service"
- workflow_end:
action: move_to_ide
notes: "Service enhancement defined. Move to IDE environment to begin development. Explain to the user the IDE Development Workflow next steps: data#bmad-kb:IDE Development Workflow"
- id: implementation-planning
name: Phased Implementation
description: Create detailed implementation plan
steps:
- agent: sm
action: Migration Story Planning
description: >-
Create stories for incremental service migration
inputs:
- migration-roadmap
- refactoring-strategy
outputs:
- migration-stories
- implementation-phases
- dependency-management
prompts:
- "Break down migration into safe phases"
- "Plan story dependencies and risks"
flow_diagram: |
```mermaid
graph TD
A[Start: Service Enhancement] --> B{Enhancement Complexity?}
B -->|Complex/Significant| C[analyst: analyze existing service]
B -->|Simple| D{1 Story or 2-3 Stories?}
C --> E[pm: brownfield-prd.md]
E --> F[architect: brownfield-architecture.md]
F --> G[po: validate with brownfield-checklist]
G --> H{PO finds issues?}
H -->|Yes| I[Return to relevant agent for fixes]
H -->|No| J[Move to IDE Environment]
I --> G
D -->|1 Story| K[pm/po/sm: brownfield-create-story]
D -->|2-3 Stories| L[pm/po/sm: brownfield-create-epic]
K --> M[Move to IDE Environment]
L --> M
style J fill:#90EE90
style M fill:#90EE90
style E fill:#FFE4B5
style F fill:#FFE4B5
style K fill:#FFB6C1
style L fill:#FFB6C1
```
transitions:
- from: service-analysis
to: enhancement-planning
condition: assessment complete
- from: enhancement-planning
to: incremental-refactoring
condition: strategy defined
- from: incremental-refactoring
to: api-evolution
condition: refactoring planned
- from: api-evolution
to: data-strategy
condition: api strategy defined
- from: data-strategy
to: quality-assurance
condition: data strategy planned
- from: quality-assurance
to: monitoring-observability
condition: testing planned
- from: monitoring-observability
to: implementation-planning
condition: observability designed
decision_guidance:
use_complex_sequence_when:
- Service enhancement requires multiple coordinated stories (4+)
- API versioning or breaking changes needed
- Database schema changes required
- Performance or scalability improvements needed
- Multiple integration points affected
special_considerations:
- name: Zero Downtime
description: Ensure service remains available during migration
- name: Data Integrity
description: Maintain data consistency throughout migration
- name: Client Impact
description: Minimize impact on service consumers
- name: Rollback Plan
description: Always have a way to revert changes safely
- name: Performance SLA
description: Maintain or improve existing performance SLAs
use_simple_sequence_when:
- Adding simple endpoints or modifying existing ones
- Enhancement follows existing service patterns
- API compatibility maintained
- Risk to existing service is low
- Change is isolated with clear boundaries
handoff_prompts:
analyst_to_pm: "Service analysis complete. Create comprehensive brownfield PRD with service integration strategy."
pm_to_architect: "Brownfield PRD ready. Save it as docs/brownfield-prd.md, then create the service architecture."
architect_to_po: "Architecture complete. Save it as docs/brownfield-architecture.md. Please validate all artifacts for service integration safety."
po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
simple_to_ide: "Service enhancement defined with existing API integration. Move to IDE environment to begin development."
complex_complete: "All brownfield planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."