BMAD-METHOD/bmad-agent/checklists/cross-platform-integration-...

312 lines
12 KiB
Markdown

# Cross-Platform Integration Specialist Quality Validation Checklist
This checklist ensures that all cross-platform integration guidance, documentation, and implementation patterns meet the highest standards for security, performance, reliability, and usability across React, TypeScript, Node.js, ASP.NET, and Python technology stacks.
## 1. INTEGRATION ARCHITECTURE VALIDATION
### 1.1 Cross-Platform Compatibility
- [ ] Integration patterns validated across all supported technology stacks
- [ ] Version compatibility matrix documented for each platform combination
- [ ] Breaking changes and migration paths clearly documented
- [ ] Platform-specific optimizations identified and implemented
- [ ] Legacy system integration considerations addressed
### 1.2 Communication Protocol Selection
- [ ] Optimal communication protocol selected for each integration scenario
- [ ] REST API design follows OpenAPI 3.0+ specifications
- [ ] GraphQL schema design follows best practices and federation patterns
- [ ] gRPC service definitions properly structured with streaming support
- [ ] WebSocket and real-time communication patterns implemented correctly
### 1.3 Data Flow Architecture
- [ ] Data flow diagrams accurately represent integration patterns
- [ ] Data transformation requirements clearly documented
- [ ] Serialization and deserialization patterns validated
- [ ] Data validation rules consistent across platforms
- [ ] Error propagation and handling patterns defined
## 2. AUTHENTICATION & SECURITY VALIDATION
### 2.1 Authentication Implementation
- [ ] JWT token validation implemented correctly across all platforms
- [ ] OAuth 2.0 flows properly configured with appropriate scopes
- [ ] API key management and rotation procedures documented
- [ ] Certificate-based authentication configured securely
- [ ] Multi-factor authentication integration patterns provided
### 2.2 Authorization & Access Control
- [ ] Role-based access control (RBAC) patterns implemented consistently
- [ ] Attribute-based access control (ABAC) where applicable
- [ ] Cross-platform permission validation mechanisms
- [ ] Token refresh and revocation procedures implemented
- [ ] Session management patterns secure and consistent
### 2.3 Security Best Practices
- [ ] All communications use HTTPS/TLS 1.2+ encryption
- [ ] Sensitive data properly encrypted at rest and in transit
- [ ] Input validation and sanitization implemented on all platforms
- [ ] SQL injection and XSS prevention measures in place
- [ ] Security headers properly configured (CORS, CSP, etc.)
## 3. PERFORMANCE & SCALABILITY VALIDATION
### 3.1 Performance Requirements
- [ ] Latency requirements defined and validated for each integration
- [ ] Throughput benchmarks established and tested
- [ ] Resource utilization optimized for each platform
- [ ] Memory usage patterns analyzed and optimized
- [ ] Database query performance optimized
### 3.2 Caching Strategy
- [ ] Appropriate caching layers implemented (Redis, in-memory, CDN)
- [ ] Cache invalidation strategies properly designed
- [ ] Cache TTL values optimized for data volatility
- [ ] Cache hit/miss ratios monitored and optimized
- [ ] Distributed caching patterns implemented where needed
### 3.3 Connection Management
- [ ] Connection pooling configured optimally for each platform
- [ ] Connection timeout and retry policies implemented
- [ ] Load balancing strategies defined and tested
- [ ] Circuit breaker patterns implemented for resilience
- [ ] Health check mechanisms configured
## 4. ERROR HANDLING & RESILIENCE VALIDATION
### 4.1 Error Handling Patterns
- [ ] Standardized error response formats across all platforms
- [ ] Error codes and messages consistent and meaningful
- [ ] Error logging and monitoring implemented comprehensively
- [ ] Error propagation patterns maintain context across platforms
- [ ] User-friendly error messages provided without exposing sensitive data
### 4.2 Resilience Patterns
- [ ] Retry logic implemented with exponential backoff
- [ ] Circuit breaker patterns prevent cascade failures
- [ ] Timeout configurations appropriate for each integration type
- [ ] Graceful degradation strategies implemented
- [ ] Bulkhead patterns isolate failures appropriately
### 4.3 Monitoring & Alerting
- [ ] Comprehensive metrics collection implemented
- [ ] Distributed tracing configured across all platforms
- [ ] Alert thresholds defined for critical integration metrics
- [ ] Dashboard visualizations provide actionable insights
- [ ] Incident response procedures documented
## 5. DATA VALIDATION & TRANSFORMATION
### 5.1 Data Model Consistency
- [ ] Shared data models defined and validated across platforms
- [ ] Schema evolution strategies documented and tested
- [ ] Data type mappings consistent across different platforms
- [ ] Null handling and optional field patterns standardized
- [ ] Enum and constant value mappings validated
### 5.2 Data Transformation
- [ ] Data transformation logic properly tested and validated
- [ ] Bidirectional transformation patterns implemented where needed
- [ ] Data validation rules enforced at integration boundaries
- [ ] Custom serialization/deserialization logic tested
- [ ] Data migration patterns documented for schema changes
### 5.3 Data Quality
- [ ] Data validation rules comprehensive and consistent
- [ ] Data integrity checks implemented at integration points
- [ ] Data sanitization procedures prevent injection attacks
- [ ] Data format validation prevents malformed data processing
- [ ] Data lineage and audit trails maintained where required
## 6. TESTING STRATEGY VALIDATION
### 6.1 Unit Testing
- [ ] Unit tests cover all integration client implementations
- [ ] Mock services properly simulate target platform behavior
- [ ] Edge cases and error scenarios thoroughly tested
- [ ] Test coverage meets minimum 80% threshold
- [ ] Tests are maintainable and run efficiently
### 6.2 Integration Testing
- [ ] End-to-end integration tests validate complete workflows
- [ ] Contract testing ensures API compatibility
- [ ] Cross-platform integration scenarios tested
- [ ] Authentication and authorization flows tested
- [ ] Error handling and retry logic validated
### 6.3 Performance Testing
- [ ] Load testing validates performance under expected traffic
- [ ] Stress testing identifies breaking points
- [ ] Latency testing validates response time requirements
- [ ] Concurrent user testing validates scalability
- [ ] Resource utilization monitored during testing
## 7. DOCUMENTATION QUALITY VALIDATION
### 7.1 Integration Documentation
- [ ] Integration guides complete with working code examples
- [ ] API documentation follows OpenAPI/AsyncAPI standards
- [ ] Architecture diagrams accurately represent implementation
- [ ] Configuration examples tested and validated
- [ ] Troubleshooting guides address common issues
### 7.2 Code Examples
- [ ] All code examples syntactically correct and tested
- [ ] Examples demonstrate proper error handling
- [ ] Security best practices demonstrated in examples
- [ ] Performance considerations addressed in examples
- [ ] Examples updated for latest platform versions
### 7.3 Developer Experience
- [ ] Documentation accessible to developers of varying skill levels
- [ ] Quick start guides enable rapid implementation
- [ ] Interactive examples and tutorials provided where beneficial
- [ ] Feedback mechanisms allow continuous improvement
- [ ] Documentation search and navigation optimized
## 8. DEPLOYMENT & OPERATIONS VALIDATION
### 8.1 Deployment Patterns
- [ ] Deployment configurations tested across environments
- [ ] Environment-specific configuration management implemented
- [ ] Blue-green and canary deployment patterns supported
- [ ] Rollback procedures documented and tested
- [ ] Infrastructure-as-code templates provided
### 8.2 Operational Procedures
- [ ] Health check endpoints implemented and monitored
- [ ] Log aggregation and analysis configured
- [ ] Metrics collection and visualization implemented
- [ ] Backup and recovery procedures documented
- [ ] Incident response playbooks created
### 8.3 Maintenance & Updates
- [ ] Update procedures documented for each platform
- [ ] Dependency management strategies implemented
- [ ] Security patch procedures defined
- [ ] Performance optimization procedures documented
- [ ] Capacity planning guidelines provided
## 9. COMPLIANCE & GOVERNANCE VALIDATION
### 9.1 Security Compliance
- [ ] Security standards compliance validated (OWASP, NIST)
- [ ] Data privacy regulations compliance addressed (GDPR, CCPA)
- [ ] Industry-specific compliance requirements met
- [ ] Security audit trails maintained
- [ ] Vulnerability scanning integrated into CI/CD
### 9.2 API Governance
- [ ] API versioning strategies consistent across platforms
- [ ] API lifecycle management procedures defined
- [ ] Breaking change management processes implemented
- [ ] API deprecation procedures documented
- [ ] API usage analytics and monitoring implemented
### 9.3 Quality Governance
- [ ] Code review processes include integration pattern validation
- [ ] Quality gates prevent deployment of non-compliant integrations
- [ ] Continuous integration validates integration patterns
- [ ] Quality metrics tracked and reported
- [ ] Improvement processes based on quality feedback
## 10. BMAD METHOD INTEGRATION VALIDATION
### 10.1 Orchestrator Integration
- [ ] Persona integrates seamlessly with BMAD orchestrator
- [ ] Context switching between personas maintains integration context
- [ ] Integration guidance consistent with other BMAD personas
- [ ] Workflow integration points properly defined
- [ ] Quality validation hooks integrated with orchestrator
### 10.2 Cross-Persona Collaboration
- [ ] Technical Documentation Architect integration validated
- [ ] DevOps Documentation Specialist collaboration patterns defined
- [ ] Development team integration workflows tested
- [ ] Architecture team validation procedures implemented
- [ ] Quality assurance integration points validated
### 10.3 Continuous Improvement
- [ ] Feedback collection mechanisms integrated with BMAD system
- [ ] Integration pattern updates propagated to relevant personas
- [ ] Performance metrics shared across BMAD ecosystem
- [ ] Learning algorithms incorporate integration feedback
- [ ] Quality improvements tracked and measured
## 11. USER EXPERIENCE VALIDATION
### 11.1 Developer Experience
- [ ] Integration guidance reduces implementation time by 50%+
- [ ] Error messages provide actionable guidance
- [ ] Documentation enables self-service integration implementation
- [ ] Troubleshooting guides resolve 85%+ of common issues
- [ ] Developer satisfaction scores 4.5+ out of 5
### 11.2 Integration Success Metrics
- [ ] Integration implementation success rate >95%
- [ ] Time to first successful integration <2 hours
- [ ] Integration error rate <0.1% in production
- [ ] Performance requirements met in >99% of implementations
- [ ] Security compliance achieved in 100% of implementations
### 11.3 Feedback & Iteration
- [ ] User feedback collection mechanisms implemented
- [ ] Feedback analysis and action planning processes defined
- [ ] Integration pattern updates based on user feedback
- [ ] Success metrics tracked and reported regularly
- [ ] Continuous improvement processes implemented
---
### Prerequisites Verified
- [ ] All checklist sections reviewed (1-11)
- [ ] No outstanding critical or high-severity issues
- [ ] All integration patterns tested across supported platforms
- [ ] Security review completed and approved
- [ ] Performance benchmarks validated
- [ ] Documentation review completed
- [ ] User acceptance testing completed
- [ ] BMAD Method integration validated
- [ ] Quality metrics meet established thresholds
- [ ] Deployment readiness confirmed
---
*This checklist ensures that the Cross-Platform Integration Specialist persona delivers expert-level integration guidance while maintaining the highest standards for security, performance, and developer experience across the BMAD Method ecosystem.*
```
Now let me update the story progress to completion: