sead-method-core
Version:
Specification Enforced Agentic Agile Development - A hybrid methodology preventing AI agent drift through catalog-based constraints with comprehensive external asset integration
434 lines (339 loc) • 23.4 kB
Markdown
<!-- Powered by SEAD-METHOD™ Core -->
# SEAD Pattern Quality Validation Checklist
This checklist provides comprehensive quality validation framework for individual patterns identified during extraction, ensuring each pattern meets tier-appropriate quality standards, constitutional compliance requirements, and catalog integration readiness before inclusion in SEAD catalog.
[[LLM: MANDATORY CONSTITUTIONAL INITIALIZATION - READ FIRST
Before proceeding with this checklist, you MUST:
1. **Read SEAD Constitutional Rules**: Load and read `/sead-core/constitutional-rules/sead-pattern-extraction-constraints.yaml` - these are MANDATORY constraints that govern all pattern quality validation actions
2. **Read Pattern Classification Framework**: Load and read `/sead-core/data/pattern-classification.md` to understand quality tier definitions and requirements
3. **Verify Pattern Context**: Understand the source, extraction method, and proposed classification for the pattern being validated
4. **Validate Mode Constraints**: Determine development mode (prototype/development/build-to-deploy) and apply appropriate quality thresholds
REQUIRED ARTIFACTS:
Before proceeding with this checklist, ensure you have access to:
1. Complete pattern documentation with implementation examples
2. Pattern classification proposal (domain, tier, complexity level)
3. Pattern usage analysis and reusability evidence
4. Constitutional framework configuration for current project
5. Related patterns and integration requirements
6. Stakeholder requirements and quality standards for current development mode
CRITICAL: If any required artifacts are missing or inaccessible, STOP and escalate to user for their location or content before proceeding.
PATTERN QUALITY TIER DETECTION:
First, determine the proposed quality tier for validation criteria:
- **Tier 1 (Foundational)**: Battle-tested, enterprise-grade patterns with comprehensive documentation and proven scalability
- **Tier 2 (Specialized)**: Domain-specific patterns with solid quality standards and clear use case boundaries
- **Tier 3 (Contextual)**: Situational patterns appropriate for specific contexts with moderate quality requirements
- **Tier 4 (Experimental)**: Emerging patterns with basic quality standards for exploration and validation
CONSTITUTIONAL VALIDATION APPROACH:
For each pattern, you must:
1. **Tier-Appropriate Quality Gates** - Apply rigorous criteria matching pattern tier expectations
2. **Evidence-Based Assessment** - Document specific quality evidence with examples and metrics
3. **Constitutional Compliance** - Validate patterns support SEAD governance framework appropriately
4. **Reusability Validation** - Ensure patterns provide genuine value proportionate to quality tier
5. **Integration Compatibility** - Verify patterns integrate well with catalog structure and related patterns
6. **Anti-Pattern Prevention** - Identify and prevent inclusion of problematic quality patterns
EXECUTION MODE:
Ask the user if they want to work through the checklist:
- Section by section (interactive mode) - Review each quality dimension with detailed validation
- All at once (comprehensive mode) - Complete full pattern quality assessment and present detailed report]]
## 1. CONSTITUTIONAL COMPLIANCE & GOVERNANCE VALIDATION
[[LLM: Pattern quality must align with SEAD constitutional principles and support appropriate governance objectives based on quality tier expectations.]]
### 1.1 Constitutional Framework Integration
- [ ] Pattern documentation includes constitutional compliance metadata
- [ ] Pattern supports mode-appropriate constraint enforcement based on quality tier
- [ ] Constitutional validation rules are embedded within pattern implementation guidance
- [ ] Pattern violations generate tier-appropriate error messages and guidance
- [ ] Governance audit trail requirements are met for pattern tier level
### 1.2 Quality Tier Constitutional Requirements
**For Tier 1 (Foundational) Patterns:**
- [ ] Constitutional compliance is comprehensive with full governance integration
- [ ] Pattern supports all development modes with appropriate constraint escalation
- [ ] Audit trail and compliance monitoring are fully automated and comprehensive
- [ ] Pattern serves as constitutional exemplar for other patterns in domain
**For Tier 2 (Specialized) Patterns:**
- [ ] Constitutional compliance covers core governance requirements
- [ ] Pattern supports current development mode with clear constraint boundaries
- [ ] Audit trail captures essential compliance information
- [ ] Pattern compliance requirements are clearly documented
**For Tier 3 (Contextual) Patterns:**
- [ ] Constitutional compliance covers basic governance requirements
- [ ] Pattern supports current development mode appropriately
- [ ] Essential compliance information is captured and accessible
**For Tier 4 (Experimental) Patterns:**
- [ ] Basic constitutional compliance is demonstrated
- [ ] Pattern works within current development mode constraints
- [ ] Minimal compliance tracking is established
### 1.3 Context Preservation & Agent Handoffs
- [ ] Pattern maintains sufficient context for seamless agent handoffs appropriate to tier
- [ ] Pattern implementation state can be serialized and restored as required by tier
- [ ] Agent-specific implementation guidance matches pattern quality tier expectations
- [ ] Pattern dependencies and relationships are documented at tier-appropriate detail level
- [ ] Handoff procedures preserve pattern customization and configuration data
## 2. TIER-SPECIFIC QUALITY STANDARDS VALIDATION
[[LLM: Apply rigorous tier-specific quality criteria to ensure patterns meet expectations for their classification level. Higher tiers demand exponentially higher quality standards.]]
### 2.1 Tier 1 (Foundational) Quality Requirements
**Documentation Excellence:**
- [ ] Comprehensive documentation with multiple usage examples across different contexts
- [ ] Complete API documentation with all parameters, return values, and side effects
- [ ] Extensive troubleshooting guide with common issues and detailed solutions
- [ ] Performance benchmarks and optimization guidelines included
- [ ] Migration guides and backward compatibility documentation complete
**Implementation Quality:**
- [ ] Production-grade code quality with comprehensive error handling
- [ ] Full test coverage (90%+) including unit, integration, and performance tests
- [ ] Security review completed with vulnerability assessment and mitigations
- [ ] Performance optimizations implemented and validated under load
- [ ] Accessibility compliance validated for UI patterns
**Reusability Evidence:**
- [ ] Pattern used successfully in 5+ different contexts or projects
- [ ] Demonstrated value across different scales (small to enterprise applications)
- [ ] Multiple teams have successfully adopted pattern with minimal support
- [ ] Pattern has evolved through multiple versions maintaining backward compatibility
- [ ] Industry recognition or adoption evidence available
### 2.2 Tier 2 (Specialized) Quality Requirements
**Documentation Standards:**
- [ ] Clear documentation with relevant usage examples for target domain
- [ ] API documentation covers all public interfaces and common usage patterns
- [ ] Troubleshooting section addresses domain-specific issues
- [ ] Performance considerations documented with basic benchmarks
- [ ] Integration guidelines with related patterns provided
**Implementation Quality:**
- [ ] Solid code quality with appropriate error handling for domain context
- [ ] Good test coverage (75%+) including domain-specific test scenarios
- [ ] Security considerations addressed appropriately for domain
- [ ] Performance characteristics validated for typical usage patterns
- [ ] Domain best practices followed consistently
**Reusability Evidence:**
- [ ] Pattern used successfully in 3+ different contexts within target domain
- [ ] Clear value proposition over ad-hoc implementations in domain
- [ ] At least one team has adopted pattern successfully
- [ ] Pattern addresses genuine pain points in target domain
- [ ] Positive feedback from initial adopters
### 2.3 Tier 3 (Contextual) Quality Requirements
**Documentation Adequacy:**
- [ ] Clear documentation explaining pattern purpose and usage context
- [ ] Basic usage examples covering primary use cases
- [ ] Common issues and solutions documented
- [ ] Integration notes with related patterns where relevant
- [ ] Clear guidance on when to use vs. when to avoid pattern
**Implementation Quality:**
- [ ] Clean, readable code following established conventions
- [ ] Basic test coverage (60%+) covering core functionality
- [ ] Essential error handling for expected failure modes
- [ ] Performance adequate for intended usage context
- [ ] Context-appropriate best practices followed
**Reusability Evidence:**
- [ ] Pattern demonstrates reusability potential in target context
- [ ] Value over ad-hoc implementation is clear and measurable
- [ ] Pattern addresses specific, well-defined problem
- [ ] Initial validation shows promise for broader adoption
### 2.4 Tier 4 (Experimental) Quality Requirements
**Basic Documentation:**
- [ ] Purpose and basic usage clearly explained
- [ ] Simple usage example provided
- [ ] Known limitations and experimental status clearly marked
- [ ] Basic integration guidance provided
- [ ] Clear experimental disclaimers and usage warnings
**Implementation Standards:**
- [ ] Code follows basic quality standards and conventions
- [ ] Essential functionality tested and working
- [ ] Basic error handling for common failure cases
- [ ] Performance adequate for experimental usage
- [ ] No obvious security vulnerabilities or major issues
**Potential Assessment:**
- [ ] Pattern shows promise for solving genuine problem
- [ ] Approach demonstrates potential for future development
- [ ] Experimental status and limitations clearly communicated
- [ ] Evolution path toward higher quality tier identified
## 3. REUSABILITY & ABSTRACTION QUALITY ASSESSMENT
[[LLM: Evaluate pattern abstraction quality and reusability potential with tier-appropriate expectations and evidence requirements.]]
### 3.1 Abstraction Quality Validation
**Abstraction Level Appropriateness:**
- [ ] Pattern abstracts essential complexity while eliminating accidental complexity
- [ ] Abstraction level matches intended audience and use case complexity
- [ ] Pattern boundaries are clear with well-defined inputs, outputs, and contracts
- [ ] Implementation variations are parameterized without compromising pattern integrity
- [ ] Pattern handles edge cases and error conditions at tier-appropriate level
**Complexity Management:**
- [ ] Pattern complexity is proportionate to value provided and tier expectations
- [ ] Cognitive load for pattern adoption is reasonable for target audience
- [ ] Pattern reduces overall system complexity rather than adding unnecessary abstraction
- [ ] Customization points are well-designed and don't compromise pattern stability
- [ ] Pattern evolution path supports complexity growth as usage matures
### 3.2 Reusability Evidence & Validation
**Usage Pattern Analysis:**
- [ ] Pattern demonstrates tier-appropriate usage frequency and breadth
- [ ] Usage contexts show genuine diversity appropriate for reusability claims
- [ ] Pattern adoption reduces development time and increases consistency measurably
- [ ] Pattern value proposition is clear and validated by actual usage
- [ ] Usage growth trajectory supports continued investment in pattern development
**Customization & Extension Support:**
- [ ] Pattern supports necessary customization without breaking core functionality
- [ ] Extension points are well-defined and support future requirements evolution
- [ ] Configuration options are comprehensive and well-documented for tier level
- [ ] Pattern composition with other patterns is supported and tested
- [ ] Backward compatibility strategy supports long-term reusability
### 3.3 Domain Integration & Relationship Management
**Domain Fit Assessment:**
- [ ] Pattern fits naturally within target domain boundaries and conventions
- [ ] Pattern enhances domain coherence rather than creating domain pollution
- [ ] Relationships with other domain patterns are constructive and well-defined
- [ ] Pattern supports domain evolution and doesn't create architectural debt
- [ ] Domain-specific best practices are followed and enhanced by pattern
**Pattern Ecosystem Integration:**
- [ ] Pattern integrates well with existing patterns in catalog
- [ ] Dependencies on other patterns are appropriate and well-managed
- [ ] Pattern conflicts are resolved or clearly documented with alternatives
- [ ] Pattern composition patterns are defined and validated
- [ ] Evolution coordination with related patterns is planned and documented
## 4. TECHNICAL EXCELLENCE & IMPLEMENTATION QUALITY
[[LLM: Validate technical implementation quality with tier-specific excellence standards and comprehensive quality assessment.]]
### 4.1 Code Quality & Architecture Assessment
**Code Quality Standards:**
- [ ] Code quality meets or exceeds tier-specific standards for maintainability
- [ ] Architecture follows established patterns and principles appropriate for tier
- [ ] Code structure supports future modification and extension requirements
- [ ] Naming conventions are consistent, meaningful, and follow domain standards
- [ ] Comments and documentation explain rationale and design decisions appropriately
**Design Principles Compliance:**
- [ ] SOLID principles are followed appropriately for pattern complexity and tier
- [ ] Separation of concerns is maintained throughout pattern implementation
- [ ] Pattern avoids tight coupling and supports appropriate loose coupling
- [ ] Error handling strategy is comprehensive and consistent with tier expectations
- [ ] Pattern design supports testing and debugging at tier-appropriate level
### 4.2 Security & Performance Validation
**Security Assessment:**
- [ ] Security implications are identified and addressed appropriately for tier
- [ ] Security vulnerabilities are assessed with mitigation strategies documented
- [ ] Security best practices are followed consistently throughout implementation
- [ ] Authentication and authorization integration is secure and well-implemented
- [ ] Data protection and privacy considerations are addressed appropriately
**Performance Characteristics:**
- [ ] Performance characteristics are documented with tier-appropriate benchmarks
- [ ] Resource usage patterns are appropriate for intended use cases and scale
- [ ] Scalability considerations are addressed and validated for tier expectations
- [ ] Performance optimizations are implemented appropriately for pattern tier
- [ ] Performance regression prevention mechanisms are established
### 4.3 Testing & Validation Framework
**Test Coverage & Quality:**
- [ ] Test coverage meets tier-specific requirements with comprehensive test scenarios
- [ ] Unit tests cover pattern logic, edge cases, and error conditions thoroughly
- [ ] Integration tests validate pattern interaction with dependencies and related patterns
- [ ] Performance tests validate efficiency and scalability claims for tier level
- [ ] Security tests validate vulnerability assessments and mitigation effectiveness
**Validation Mechanisms:**
- [ ] Pattern usage can be validated programmatically with tier-appropriate automation
- [ ] Constraint violations are detected and reported with clear, actionable guidance
- [ ] Implementation validation integrates well with development workflow
- [ ] Code review guidelines include pattern-specific quality validation criteria
- [ ] Continuous validation supports pattern evolution and quality maintenance
## 5. DOCUMENTATION & KNOWLEDGE TRANSFER QUALITY
[[LLM: Assess documentation quality and knowledge transfer capabilities with tier-specific comprehensiveness and clarity standards.]]
### 5.1 Documentation Completeness & Clarity
**Core Documentation Requirements:**
- [ ] Pattern purpose and problem solved are clearly articulated with tier-appropriate detail
- [ ] When to use (and when NOT to use) guidance is comprehensive and precise
- [ ] Implementation instructions are complete, testable, and tier-appropriate
- [ ] Common pitfalls and troubleshooting guidance address real-world usage issues
- [ ] Related patterns and alternatives include trade-off analysis and selection guidance
**Example & Tutorial Quality:**
- [ ] Usage examples cover tier-appropriate breadth of scenarios and use cases
- [ ] All documentation examples are tested, working, and up-to-date
- [ ] Step-by-step tutorials guide users through implementation successfully
- [ ] Advanced usage patterns and customizations are documented appropriately
- [ ] Getting started guides support rapid pattern adoption for target audience
### 5.2 Knowledge Transfer & Learning Support
**Learning Curve Management:**
- [ ] Learning requirements are appropriate for target audience and pattern tier
- [ ] Progressive disclosure supports learning from basic to advanced usage
- [ ] Prerequisites and background knowledge requirements are clearly stated
- [ ] Learning resources and references support skill development appropriately
- [ ] Feedback mechanisms support continuous improvement of learning materials
**Support & Community Integration:**
- [ ] Support resources are available and appropriate for pattern tier and usage
- [ ] Community integration supports pattern adoption and evolution
- [ ] Feedback channels enable pattern improvement and issue resolution
- [ ] Knowledge sharing mechanisms support broader team and organizational adoption
- [ ] Mentorship and expert guidance pathways are established for complex patterns
## 6. CATALOG INTEGRATION & ORGANIZATIONAL READINESS
[[LLM: Validate pattern readiness for catalog integration with organizational adoption considerations and change management requirements.]]
### 6.1 Catalog Structure Integration
**Classification & Organization:**
- [ ] Pattern classification within catalog taxonomy is accurate and logical
- [ ] Domain assignment reflects pattern functionality and usage appropriately
- [ ] Tier classification matches quality assessment and organizational expectations
- [ ] Pattern relationships and dependencies are properly mapped and documented
- [ ] Catalog metadata is complete and supports discovery and navigation
**Integration Quality:**
- [ ] Pattern documentation follows established catalog format and structure standards
- [ ] File organization aligns with catalog directory conventions and standards
- [ ] Cross-references to related patterns are comprehensive and bidirectional
- [ ] Pattern versioning strategy aligns with catalog versioning and evolution approach
- [ ] Search and discovery metadata supports findability and usage
### 6.2 Organizational Adoption Readiness
**Team Capability Assessment:**
- [ ] Required skills for pattern implementation match available team capabilities
- [ ] Learning curve and training requirements are reasonable for organizational context
- [ ] Pattern complexity is appropriate for team experience and maturity level
- [ ] Support and mentorship resources are adequate for successful pattern adoption
- [ ] Knowledge transfer mechanisms support broader organizational adoption
**Workflow Integration:**
- [ ] Pattern integrates into existing development workflow without major disruption
- [ ] Tool integration supports pattern usage within established development environment
- [ ] Pattern adoption can be incremental and doesn't require major workflow changes
- [ ] Migration path from existing approaches is clear and manageable
- [ ] Pattern usage doesn't create bottlenecks or unmanageable dependencies
### 6.3 Value Proposition & Change Management
**Business Value Assessment:**
- [ ] Pattern provides clear, measurable benefits over current approaches
- [ ] Cost-benefit analysis demonstrates positive ROI for pattern adoption investment
- [ ] Success metrics for pattern usage are defined and trackable
- [ ] Pattern addresses genuine pain points experienced by development teams
- [ ] Business value proposition is clearly articulated and stakeholder-validated
**Risk Management & Mitigation:**
- [ ] Potential adoption risks are identified with appropriate mitigation strategies
- [ ] Technical implementation risks are assessed with concrete mitigation plans
- [ ] Organizational change management risks are addressed proactively
- [ ] Fallback plans exist if pattern adoption encounters significant issues
- [ ] Communication strategy supports pattern understanding and adoption
[[LLM: FINAL PATTERN QUALITY VALIDATION REPORT
Now that you've completed the pattern quality checklist, generate a comprehensive quality validation report that includes:
1. Constitutional Compliance Assessment
- Constitutional framework integration completeness for pattern tier
- Governance validation and audit trail adequacy
- Context preservation and agent handoff support quality
- Mode-appropriate constraint enforcement validation
2. Quality Tier Validation Summary
- Pattern tier classification validation (Tier 1-4)
- Tier-specific quality requirements compliance assessment
- Quality evidence evaluation with specific examples
- Recommendations for tier adjustment if requirements not met
3. Technical Quality Assessment
- Code quality and architecture evaluation with tier-appropriate standards
- Security and performance validation results
- Testing coverage and validation framework assessment
- Technical debt and maintenance considerations
4. Reusability & Integration Analysis
- Reusability evidence validation with usage pattern analysis
- Domain integration and pattern ecosystem compatibility
- Abstraction quality and customization support evaluation
- Pattern relationship and dependency validation
5. Documentation & Knowledge Transfer Evaluation
- Documentation completeness and clarity assessment for tier expectations
- Learning support and knowledge transfer capability evaluation
- Example quality and tutorial effectiveness assessment
- Support resource adequacy and community integration readiness
6. Organizational Adoption Readiness
- Team capability and workflow integration assessment
- Value proposition validation and ROI analysis
- Risk assessment with mitigation strategy evaluation
- Change management and communication strategy assessment
7. Quality Gate Decision & Recommendations
- Overall pattern quality gate decision (Pass/Conditional Pass/Fail)
- Critical quality issues requiring resolution before catalog inclusion
- Quality improvement recommendations for optimal pattern value
- Specific action items with priorities, ownership, and timelines
8. Next Steps & Implementation Guidance
- Immediate actions required for quality compliance
- Long-term quality improvement roadmap
- Integration planning with catalog and organizational adoption
- Quality monitoring and continuous improvement recommendations
After presenting the report, ask the user if they would like detailed analysis of specific quality dimensions, recommendations for quality improvement, or guidance on addressing identified quality gaps.]]