cqt-agent
Version:
180 lines (141 loc) • 9.3 kB
Markdown
# Hubtel Task Quality Checklist
## Overview
This checklist ensures all tasks meet Hubtel's quality standards for junior engineer implementation readiness, technical completeness, and integration compatibility.
## Task Quality Validation
### 1. Clarity and Completeness
#### Basic Information
- [ ] **Clear Title**: Task title is specific and includes technical context
- [ ] **Objective Clarity**: Task purpose is immediately obvious to any developer
- [ ] **Scope Definition**: Clear boundaries of what's included and excluded
- [ ] **Business Context**: Explains why the task is needed and its value
#### Requirements Specification
- [ ] **Functional Requirements**: All functional requirements clearly defined
- [ ] **Technical Requirements**: Technology stack and implementation constraints specified
- [ ] **Integration Requirements**: API dependencies and service integrations identified
- [ ] **Performance Requirements**: Response time and quality expectations defined
### 2. Junior Engineer Readiness
#### Implementation Guidance
- [ ] **Approach Specified**: Clear implementation approach and sequence outlined
- [ ] **Technology Stack**: Specific frameworks and tools identified (Next.js/Nuxt.js/.NET Core)
- [ ] **Code Patterns**: References to established patterns and similar implementations
- [ ] **Common Pitfalls**: Known issues and resolution approaches documented
#### Resource Availability
- [ ] **Documentation Links**: References to Hubtel coding standards and guidelines
- [ ] **Code Examples**: Relevant code snippets and scaffolding provided
- [ ] **Similar Implementations**: Links to comparable existing implementations
- [ ] **Troubleshooting Guide**: Common problems and solutions documented
#### Task Sizing
- [ ] **1-Hour Window**: Task can be reasonably completed within 1 hour
- [ ] **Single Focus**: Task has one clear, focused objective
- [ ] **Atomic Deliverable**: Task delivers a complete, testable piece of functionality
- [ ] **Dependency Management**: External dependencies clearly identified and available
### 3. Acceptance Criteria Quality
#### Functional Criteria
- [ ] **Testable Conditions**: All criteria can be objectively verified
- [ ] **User Perspective**: Criteria written from user/system behavior perspective
- [ ] **Edge Cases**: Error conditions and boundary cases addressed
- [ ] **Given/When/Then**: Criteria follow clear behavioral specification format
#### Technical Criteria
- [ ] **Implementation Standards**: Technical requirements clearly specified
- [ ] **Performance Benchmarks**: Response time and throughput expectations defined
- [ ] **Security Requirements**: Authentication, authorization, and validation specified
- [ ] **Compatibility Requirements**: Browser, device, or service compatibility defined
#### Quality Criteria
- [ ] **Testing Coverage**: Unit and E2E testing requirements specified
- [ ] **Code Quality**: Coding standards and review requirements defined
- [ ] **Documentation**: Documentation update requirements included
- [ ] **Accessibility**: WCAG compliance requirements specified (if applicable)
### 4. Hubtel Standards Integration
#### Technology Stack Alignment
- [ ] **Frontend Framework**: Next.js or Nuxt.js properly specified
- [ ] **Backend Framework**: .NET Core patterns and practices referenced
- [ ] **Database Integration**: PostgreSQL or MongoDB usage properly defined
- [ ] **Testing Frameworks**: Vitest/Playwright or Karate appropriately specified
#### Development Standards
- [ ] **Coding Guidelines**: References to https://dev-docs.hubtel.com/introduction.html
- [ ] **Architectural Patterns**: SOLID principles and clean architecture applied
- [ ] **Security Practices**: Input validation and secure coding practices included
- [ ] **Observability**: OpenTelemetry logging requirements specified
#### Quality Practices
- [ ] **Code Review**: Review requirements and criteria clearly defined
- [ ] **Testing Strategy**: Comprehensive testing approach specified
- [ ] **Performance**: Response time and optimization requirements included
- [ ] **Documentation**: API documentation and code comment requirements defined
### 5. Testing Requirements
#### Unit Testing
- [ ] **Framework Specified**: Vitest (frontend) or NUnit (backend) clearly identified
- [ ] **Coverage Requirements**: Minimum 85% coverage requirement specified
- [ ] **Critical Path Coverage**: 100% coverage of business logic required
- [ ] **Test Categories**: Component, service, and integration test types defined
#### Integration Testing
- [ ] **E2E Framework**: Playwright or Karate framework appropriately specified
- [ ] **Scenario Coverage**: Critical user journeys identified and specified
- [ ] **API Testing**: Backend API endpoint testing requirements defined
- [ ] **Cross-Browser**: Browser compatibility testing requirements specified
#### Quality Validation
- [ ] **Accessibility Testing**: WCAG AA compliance validation specified
- [ ] **Performance Testing**: Load and response time validation defined
- [ ] **Security Testing**: Authentication and authorization validation included
- [ ] **Compatibility Testing**: Device and browser compatibility requirements defined
### 6. Coordination Requirements
#### Frontend/Backend Coordination
- [ ] **API Dependencies**: Backend API requirements clearly defined
- [ ] **Data Model Alignment**: Shared data structures and validation specified
- [ ] **Authentication Integration**: User session and security coordination defined
- [ ] **Timeline Coordination**: Development sequence and handoff points specified
#### Environment Coordination
- [ ] **Docker Updates**: Container and service configuration changes identified
- [ ] **Configuration Management**: Environment variable and secret updates specified
- [ ] **Database Changes**: Migration and schema change requirements defined
- [ ] **Deployment Sequence**: Service deployment order and dependencies specified
#### Communication Requirements
- [ ] **Team Notifications**: Teams communication requirements specified
- [ ] **Documentation Updates**: Swagger and Postman collection updates identified
- [ ] **Change Announcements**: Breaking change communication requirements defined
- [ ] **Escalation Procedures**: Issue resolution and support contact information included
### 7. Definition of Done
#### Implementation Completeness
- [ ] **Feature Complete**: All functional requirements implemented
- [ ] **Error Handling**: Comprehensive error handling and user feedback implemented
- [ ] **Performance**: Meets specified performance and quality benchmarks
- [ ] **Security**: Authentication, authorization, and validation implemented
#### Testing Completeness
- [ ] **Unit Tests**: All unit tests written and passing with required coverage
- [ ] **Integration Tests**: All integration and E2E tests written and passing
- [ ] **Manual Testing**: Manual testing scenarios executed and validated
- [ ] **Performance Tests**: Performance and load testing completed and validated
#### Quality Assurance
- [ ] **Code Review**: Code reviewed and approved by senior developer
- [ ] **Standards Compliance**: Code follows Hubtel coding standards and guidelines
- [ ] **Documentation**: All documentation updated (API docs, README, comments)
- [ ] **Deployment Ready**: Code committed, reviewed, and ready for deployment
### 8. Azure DevOps Integration
#### Work Item Structure
- [ ] **Proper Hierarchy**: Work item properly linked to parent epic/feature
- [ ] **Metadata Complete**: All required Azure DevOps fields populated
- [ ] **Tags Applied**: Appropriate tags for filtering and organization applied
- [ ] **Team Assignment**: Proper area path and team assignment specified
#### Tracking and Management
- [ ] **Effort Estimation**: Accurate time estimates for planning purposes
- [ ] **Priority Setting**: Appropriate priority level set based on business value
- [ ] **Iteration Assignment**: Proper sprint or iteration assignment specified
- [ ] **Status Tracking**: Clear status progression and completion criteria defined
## Checklist Scoring
### Quality Levels
- **90-100%**: Excellent - Ready for junior engineer implementation
- **80-89%**: Good - Minor improvements needed before assignment
- **70-79%**: Acceptable - Significant improvements required
- **Below 70%**: Insufficient - Major rework needed before implementation
### Critical Requirements
These items are mandatory and must be checked for task approval:
- Task can be completed within 1-hour window
- All acceptance criteria are testable and specific
- Technology stack and implementation approach clearly defined
- Testing requirements comprehensive and framework-specific
- Hubtel coding standards and documentation properly referenced
### Usage Instructions
1. **Initial Review**: Complete checklist during task creation or enhancement
2. **Quality Gate**: Use as approval criteria before task assignment to developers
3. **Continuous Improvement**: Track common checklist failures to improve task creation processes
4. **Training Tool**: Use checklist to train team members on Hubtel task quality standards
This checklist ensures that all tasks entering Hubtel's development workflow meet the high standards required for successful implementation by developers at all experience levels.