ai-qakit 1.0.0

package/templates/.claude/doc-templates/technical-documents.md

@@ -0,0 +1,127 @@
+# Technical Documents Template
+
+## System Overview Architecture
+
+- System summary
+
+// TODO:
+
+- Primary Stakeholders/Users
+
+// TODO:
+
+- Main features:
+
+// TODO:
+
+- Design:
+  The platform architecture is documented using the C4 model (Context, Containers, Components, Code), which provides a hierarchical set of diagrams for visualizing software architecture at different levels of abstraction.
+
+- C4 Model Levels:
+
+  - Level 1 (Context): System in scope and its relationships with users and external systems with pure business-oriented information
+
+  - Level 2 (Container): High-level technology choices and how containers communicate
+
+  - Level 3 (Component): Internal structure of containers, showing components and their responsibilities
+
+  - Level 4 (Code): Class-level details (deferred to implementation phase)
+
+- Design Principles:
+
+// TODO: Use drawio or mermaidjs to draw all of your C4 diagram
+
+### System Context Diagram
+
+```
+// TODO: Your C1 Business-oriented diagram here
+
+// Tips: Focus on major business context(s) of your system/platform
+```
+
+(![Sample C1 Diagram](image.png))
+
+// Explanation in words
+The System Context diagram shows the platform and its interactions with external actors and systems.
+
+#### Actors/Users
+
+// TODO: Describe main type of users interacting with the platform
+
+#### External Systems
+
+// TODO:
+
+### System Containers Diagram
+
+![Sample C2 Diagram](image-1.png)
+
+```
+// TODO: Your C2 Major containers diagram here ( BE, FE, ..) and how they are communicating to each other
+
+// Tips: can split into multiple diagrams for better and cleaner visualized information
+```
+
+The Container diagram decomposes the D-Risk AI system into applications, data stores, showing technology choices and inter-container communication.
+
+#### Frontend Containers
+
+// TODO: Frontend application description, technologies used
+
+#### Backend Containers
+
+// TODO: Backend application description, technologies used
+
+#### Container Communication
+
+// TODO:
+Protocol: HTTPS
+Format: GraphQL queries/mutations
+Authentication: JWT Bearer token
+API Server → AI Server (REST/HTTPS)
+SSL/TLS encryption
+Containers → Database (PostgreSQL Protocol)
+Asynchronous job queue
+Decouples services for background processing
+Messages: notification jobs, report generation, export
+Containers → Cache (Redis Protocol)
+Binary protocol (RESP)
+Connection pooling
+
+### System Component Diagram
+
+![alt text](image-2.png)
+
+```
+// TODO: Your C3 Components diagram here
+
+// Tips: Decompose your container diagram to all smaller components that reside in it, including their responsibilities and the technology/implementation details.
+```
+
+## Infrastructure and Deployment Diagram
+
+![Infrastructure diagram](image-3.png)
+
+![Deployment diagram](image-4.png)
+
+## Coding Convention
+
+- Follow [Company Common Coding Standards](https://gitlab.enouvo.com/development-team/team-standards/-/tree/main/sections/coding-conventions?ref_type=heads)
+- Project technical specific conventions
+
+## Development Setup
+
+- Acknowledged [Team Standards](https://gitlab.enouvo.com/development-team/team-standards)
+- Step-by-step checklist items to help new members catching up fast to start the project successfully
+
+// TODO: Sample steps
+
+- [] Prerequisites
+- [] Required Software
+- [] Verify Git installation
+- [] Verify Docker installation
+- [] Recommended IDEs installation
+- [] Required IDE Plugins/Extensions
+- [] Project Setup and started in local successfully
+- [] Roles and privileges ackowledged
+- [] Environment information acknowledged

package/templates/.claude/doc-templates/test-case-template.md

@@ -0,0 +1,198 @@
+# Test Case Template
+
+## Standard Test Case Format
+
+| Field | Description |
+|-------|-------------|
+| **Test Case ID** | Unique identifier using pattern: `[MODULE]-[FEATURE]-[NUMBER]` (e.g., WEB-LOGIN-001) |
+| **Test Case Title** | Short, action-oriented name using verb (e.g., Verify login with valid credentials) |
+| **Module / Feature** | Functional area under test (e.g., Authentication, Payment, User Management) |
+| **Priority** | Business priority: P0 (Critical) / P1 (High) / P2 (Medium) / P3 (Low) |
+| **Type** | Functional / Integration / E2E / Regression / Smoke |
+| **Automation Status** | Manual / Automated / To Be Automated |
+| **Preconditions** | Setup or data required before execution |
+| **Test Data** | Specific values used in the test |
+| **Steps to Execute** | Sequential actions to perform |
+| **Expected Result** | The correct system behavior upon completion |
+| **Actual Result** | Outcome observed after execution (filled during execution) |
+| **Status** | Pass / Fail / Blocked / Not Executed |
+| **Severity** | Impact if failed: Critical / Major / Minor / Low |
+| **Evidence** | Screenshots, logs, or video recording links |
+| **Comments / Notes** | Extra context, observations, or related bug IDs |
+
+---
+
+## Test Case Template
+
+```markdown
+# Test Case: [MODULE-FEATURE-XXX]
+
+## Overview
+
+| Field | Value |
+|-------|-------|
+| **Test Case ID** | [MODULE-FEATURE-XXX] |
+| **Title** | [Action-oriented title] |
+| **Module / Feature** | [Feature name] |
+| **Priority** | P0 / P1 / P2 / P3 |
+| **Type** | Functional / Integration / E2E |
+| **Automation Status** | Manual / Automated / To Be Automated |
+| **Requirement Reference** | [REQ-XXX or JIRA ticket] |
+
+## Preconditions
+
+1. [Precondition 1]
+2. [Precondition 2]
+
+## Test Data
+
+| Field | Value | Notes |
+|-------|-------|-------|
+| [Field name] | [Value] | [Notes] |
+
+## Test Steps
+
+| Step | Action | Expected Result |
+|------|--------|-----------------|
+| 1 | [Action description] | [Expected outcome] |
+| 2 | [Action description] | [Expected outcome] |
+| 3 | [Action description] | [Expected outcome] |
+
+## Execution Results
+
+| Field | Value |
+|-------|-------|
+| **Actual Result** | [To be filled after execution] |
+| **Status** | Pass / Fail / Blocked / Not Executed |
+| **Severity** | Critical / Major / Minor / Low |
+| **Evidence** | [Screenshot/video link] |
+
+## Postconditions / Cleanup
+
+- [Cleanup action 1]
+- [Cleanup action 2]
+
+## Notes
+
+- [Additional observations]
+- [Related bug IDs if any]
+```
+
+---
+
+## Example Test Case
+
+```markdown
+# Test Case: WEB-LOGIN-001
+
+## Overview
+
+| Field | Value |
+|-------|-------|
+| **Test Case ID** | WEB-LOGIN-001 |
+| **Title** | Verify login with valid credentials |
+| **Module / Feature** | Authentication |
+| **Priority** | P0 |
+| **Type** | Functional |
+| **Automation Status** | Automated |
+| **Requirement Reference** | AUTH-101 |
+
+## Preconditions
+
+1. User account must exist and be activated
+2. User is not currently logged in
+3. Test environment is accessible
+
+## Test Data
+
+| Field | Value | Notes |
+|-------|-------|-------|
+| Email | qa.user@example.com | Valid registered email |
+| Password | Example@123 | Valid password |
+
+## Test Steps
+
+| Step | Action | Expected Result |
+|------|--------|-----------------|
+| 1 | Navigate to https://staging.example.com/login | Login page is displayed with email and password fields |
+| 2 | Enter valid email: qa.user@example.com | Email field accepts input |
+| 3 | Enter valid password: Example@123 | Password field accepts input (masked) |
+| 4 | Click "Login" button | Loading indicator appears |
+| 5 | Wait for redirect | User is redirected to dashboard |
+
+## Execution Results
+
+| Field | Value |
+|-------|-------|
+| **Actual Result** | User successfully redirected to dashboard, username displayed at top right |
+| **Status** | Pass |
+| **Severity** | N/A |
+| **Evidence** | [login_success.png](./evidence/login_success.png) |
+
+## Postconditions / Cleanup
+
+- Log out the user after test completion
+- Clear browser cookies if needed
+
+## Notes
+
+- Test executed on Chrome 128.0 / Windows 11
+- Response time: 1.2 seconds
+```
+
+---
+
+## Tips for Writing Good Test Cases
+
+### DO's ✅
+
+- **Be concise and clear** - each test case should read like an instruction
+- **One test, one purpose** - do not mix multiple validations into one case
+- **Use action verbs** - Verify, Check, Ensure, Validate, Confirm
+- **Avoid ambiguity** - specify exact expected results and behavior
+- **Use reusable data placeholders** - parameterize when possible
+- **Link to requirements** - ensure traceability to user stories or requirements
+- **Include evidence** - screenshots or videos for test results
+- **Follow naming convention** - `[MODULE]-[FEATURE]-[NUMBER]`
+
+### DON'Ts ❌
+
+- Don't write vague steps like "Enter data" - be specific
+- Don't combine multiple test scenarios in one case
+- Don't assume preconditions - document them explicitly
+- Don't skip expected results - every step should have one
+- Don't use magic values - document test data clearly
+
+### Test Case ID Naming Convention
+
+```
+[MODULE]-[FEATURE]-[NUMBER]
+
+Examples:
+- WEB-LOGIN-001      → Web app, Login feature, test #1
+- API-USER-015       → API, User management, test #15
+- MOB-PAYMENT-003    → Mobile app, Payment feature, test #3
+- INT-AUTH-007       → Integration, Authentication, test #7
+```
+
+### Priority Definitions
+
+| Priority | Definition | Example |
+|----------|------------|---------|
+| **P0 (Critical)** | Core functionality, blocks release | Login, Payment processing |
+| **P1 (High)** | Important feature, major impact | User registration, Search |
+| **P2 (Medium)** | Standard functionality | Profile update, Filters |
+| **P3 (Low)** | Nice-to-have, cosmetic | UI animations, Tooltips |
+
+### Severity Definitions (for failures)
+
+| Severity | Definition | Example |
+|----------|------------|---------|
+| **Critical** | System crash, data loss, security breach | App crashes on login |
+| **Major** | Key feature broken, no workaround | Cannot complete checkout |
+| **Minor** | Feature issue with workaround | Filter doesn't persist |
+| **Low** | Cosmetic, typo, minor UI issue | Button misaligned |
+
+---
+
+_End of Test Case Template_

package/templates/.claude/doc-templates/test-plan-template.md

@@ -0,0 +1,366 @@
+# Test Plan Template
+
+## Standard Test Plan Format
+
+| Section | Description |
+|---------|-------------|
+| **Project Name** | Name of the product or feature under test |
+| **Version / Release** | Version number or sprint / release name |
+| **Prepared By** | QA owner(s) preparing the plan |
+| **Date** | Date of creation / last update |
+| **Objective / Purpose** | The main testing goal - what QA intends to validate |
+| **Scope** | What will be tested (features, modules, integrations) |
+| **Out of Scope** | Features, data, or areas excluded from testing |
+| **Test Approach / Strategy** | How testing will be executed (manual, automation, exploratory) |
+| **Test Levels** | Unit, Integration, System, UAT - which apply |
+| **Test Types** | Functional, Regression, Smoke, Compatibility, etc. |
+| **Test Deliverables** | Test Plan, Test Cases, Defect Reports, Test Summary |
+| **Test Environment** | URL, devices, browsers, data setup, configurations |
+| **Test Data Management** | Data sources and how they will be handled |
+| **Entry Criteria** | Preconditions to begin testing |
+| **Exit Criteria** | Conditions for completing testing |
+| **Roles & Responsibilities** | Who does what |
+| **Schedule / Timeline** | Planned testing period with milestones |
+| **Risks & Mitigation** | Known risks that could affect testing |
+| **Communication Plan** | How progress and issues will be reported |
+| **Approval / Sign-off** | For review and final approval |
+
+---
+
+## Test Plan Template
+
+```markdown
+# Test Plan: [Project/Feature Name]
+
+## 1. Document Information
+
+| Field | Value |
+|-------|-------|
+| **Project Name** | [Project name] |
+| **Version / Release** | [Version or Sprint name] |
+| **Prepared By** | [QA Lead name] |
+| **Date** | [Date] |
+| **Status** | Draft / In Review / Approved |
+
+---
+
+## 2. Objective / Purpose
+
+[Describe the main testing goal - what QA intends to validate in this test cycle]
+
+---
+
+## 3. Scope
+
+### 3.1 In Scope
+
+| Module / Feature | Description |
+|------------------|-------------|
+| [Feature 1] | [What will be tested] |
+| [Feature 2] | [What will be tested] |
+
+### 3.2 Out of Scope
+
+| Item | Reason |
+|------|--------|
+| [Feature/Area] | [Why excluded] |
+
+---
+
+## 4. Test Approach / Strategy
+
+### 4.1 Test Levels
+
+- [ ] Unit Testing
+- [ ] Integration Testing
+- [ ] System Testing
+- [ ] User Acceptance Testing (UAT)
+
+### 4.2 Test Types
+
+- [ ] Functional Testing
+- [ ] Regression Testing
+- [ ] Smoke Testing
+- [ ] Compatibility Testing
+- [ ] Performance Testing
+- [ ] Security Testing
+- [ ] Accessibility Testing
+
+### 4.3 Approach Description
+
+[Describe the overall approach - manual vs automation, exploratory testing, etc.]
+
+---
+
+## 5. Test Environment
+
+### 5.1 Environment Details
+
+| Environment | URL | Purpose |
+|-------------|-----|---------|
+| Staging | [URL] | Primary testing |
+| Production | [URL] | Smoke verification |
+
+### 5.2 Browser / Device Matrix
+
+| Browser/Device | Version | Priority |
+|----------------|---------|----------|
+| Chrome | Latest | P0 |
+| Firefox | Latest | P1 |
+| Safari | Latest | P1 |
+| Mobile iOS | Latest | P1 |
+| Mobile Android | Latest | P1 |
+
+### 5.3 Test Data Management
+
+| Data Type | Source | Handling |
+|-----------|--------|----------|
+| User accounts | Seeded test data | Auto-cleanup after execution |
+| Transaction data | Generated | Reset before each run |
+
+---
+
+## 6. Entry / Exit Criteria
+
+### 6.1 Entry Criteria
+
+- [ ] Build deployed to test environment
+- [ ] Environment stable and accessible
+- [ ] Test data prepared and verified
+- [ ] Test cases reviewed and approved
+- [ ] Smoke test passed
+
+### 6.2 Exit Criteria
+
+- [ ] All P0/P1 test cases executed
+- [ ] Test execution rate >= 95%
+- [ ] Pass rate >= 90%
+- [ ] No open Critical/Major defects
+- [ ] Test Summary Report completed
+
+---
+
+## 7. Test Deliverables
+
+| Deliverable | Description | Owner |
+|-------------|-------------|-------|
+| Test Plan | This document | QA Lead |
+| Test Cases | Detailed test scenarios | QA Team |
+| Defect Log | Bug reports | QA Team |
+| Daily QA Report | Progress updates | QA Lead |
+| Test Summary Report | Final results | QA Lead |
+
+---
+
+## 8. Roles & Responsibilities
+
+| Role | Name | Responsibilities |
+|------|------|------------------|
+| QA Lead | [Name] | Planning, reporting, sign-off |
+| QA Engineer | [Name] | Test execution, defect logging |
+| Developer | [Name] | Bug fixing, RCA |
+| PM/PO | [Name] | Requirement clarification, sign-off |
+| DevOps | [Name] | Environment support |
+
+---
+
+## 9. Schedule / Timeline
+
+| Phase | Start Date | End Date | Status |
+|-------|------------|----------|--------|
+| Test Planning | [Date] | [Date] | [Status] |
+| Test Design | [Date] | [Date] | [Status] |
+| Test Execution | [Date] | [Date] | [Status] |
+| Regression | [Date] | [Date] | [Status] |
+| Sign-off | [Date] | [Date] | [Status] |
+
+---
+
+## 10. Risks & Mitigation
+
+| Risk | Impact | Probability | Mitigation |
+|------|--------|-------------|------------|
+| Environment downtime | High | Medium | Notify DevOps immediately, retest after restart |
+| Late story delivery | Medium | Medium | Adjust test priority dynamically |
+| Unclear requirements | Medium | Low | Clarify with PM before test design |
+| Resource unavailability | Medium | Low | Cross-train team members |
+
+---
+
+## 11. Communication Plan
+
+| Communication Type | Frequency | Channel | Audience |
+|--------------------|-----------|---------|----------|
+| Daily QA Sync | Daily | Slack/Teams | QA Team |
+| Bug Review | As needed | Meeting | QA + Dev |
+| Progress Report | Weekly | Email | PM, Stakeholders |
+| Test Completion | End of cycle | Email | All |
+
+---
+
+## 12. Approval / Sign-off
+
+| Role | Name | Date | Signature |
+|------|------|------|-----------|
+| QA Lead | [Name] | [Date] | _________ |
+| PM/PO | [Name] | [Date] | _________ |
+| Tech Lead | [Name] | [Date] | _________ |
+```
+
+---
+
+## Example Test Plan
+
+```markdown
+# Test Plan: Example Web Portal - User Authentication
+
+## 1. Document Information
+
+| Field | Value |
+|-------|-------|
+| **Project Name** | Example Web Portal - User Authentication |
+| **Version / Release** | Sprint 12 - Login Feature Enhancements |
+| **Prepared By** | Jordan Lee (QA Lead) |
+| **Date** | Oct 25, 2025 |
+| **Status** | Approved |
+
+---
+
+## 2. Objective / Purpose
+
+Validate login, logout, and password reset functionalities for Web users, ensuring secure and reliable access flow.
+
+---
+
+## 3. Scope
+
+### 3.1 In Scope
+
+| Module / Feature | Description |
+|------------------|-------------|
+| Login | Valid/invalid credentials, error handling |
+| Logout | Session termination, redirect |
+| Password Reset | Email flow, token validation |
+| Remember Me | Session persistence |
+| Session Timeout | Auto-logout after inactivity |
+
+### 3.2 Out of Scope
+
+| Item | Reason |
+|------|--------|
+| Social Login (Google, Facebook) | Planned for Sprint 14 |
+| Mobile App Login | Separate test plan |
+| Two-Factor Authentication | Not implemented yet |
+
+---
+
+## 4. Test Approach / Strategy
+
+### 4.1 Test Levels
+
+- [x] Integration Testing
+- [x] System Testing
+- [x] User Acceptance Testing (UAT)
+
+### 4.2 Test Types
+
+- [x] Functional Testing
+- [x] Regression Testing
+- [x] Smoke Testing
+- [x] Usability Testing
+
+### 4.3 Approach Description
+
+- Functional and regression tests executed manually
+- Smoke suite validates deployments
+- Automation suite runs on stable builds
+- Exploratory testing for edge cases
+
+---
+
+## 5. Test Environment
+
+### 5.1 Environment Details
+
+| Environment | URL | Purpose |
+|-------------|-----|---------|
+| Staging | https://staging.example.com | Primary testing |
+| Production | https://example.com | Smoke verification |
+
+### 5.2 Browser / Device Matrix
+
+| Browser/Device | Version | Priority |
+|----------------|---------|----------|
+| Chrome | 128.0 | P0 |
+| Edge | 128.0 | P1 |
+| Firefox | Latest | P2 |
+
+### 5.3 Test Data Management
+
+| Data Type | Source | Handling |
+|-----------|--------|----------|
+| Test accounts | Seeded | Auto-cleanup after execution |
+| Invalid credentials | Generated | N/A |
+
+---
+
+## 6. Entry / Exit Criteria
+
+### 6.1 Entry Criteria
+
+- [x] Build v1.12.0 deployed to staging
+- [x] Test accounts active
+- [x] Smoke check passed
+
+### 6.2 Exit Criteria
+
+- [ ] 100% smoke coverage
+- [ ] >= 95% regression execution
+- [ ] No open Critical/Major bugs
+
+---
+
+## 9. Schedule / Timeline
+
+| Phase | Start Date | End Date | Status |
+|-------|------------|----------|--------|
+| Test Planning | Oct 24, 2025 | Oct 25, 2025 | Complete |
+| Test Execution | Oct 26, 2025 | Oct 30, 2025 | In Progress |
+| Regression | Oct 31, 2025 | Nov 1, 2025 | Not Started |
+| Sign-off | Nov 2, 2025 | Nov 2, 2025 | Not Started |
+
+---
+
+## 12. Approval / Sign-off
+
+| Role | Name | Date | Signature |
+|------|------|------|-----------|
+| QA Lead | Jordan Lee | Oct 25, 2025 | ✓ |
+| PM | Avery Chen | Oct 25, 2025 | ✓ |
+```
+
+---
+
+## Tips for a Strong Test Plan
+
+### DO's ✅
+
+- **Keep it traceable** - link stories or JIRA tickets for each module
+- **Balance scope** - list what is NOT tested to manage expectations
+- **Write in plain language** - anyone should understand it
+- **Review early** - share draft plans before build release
+- **Maintain version control** - treat as a living document
+- **Define clear criteria** - entry/exit criteria prevent ambiguity
+- **Identify risks early** - plan mitigations proactively
+
+### DON'Ts ❌
+
+- Don't create test plans after testing starts
+- Don't skip out-of-scope section
+- Don't leave criteria vague
+- Don't forget to update status
+- Don't ignore risks
+
+---
+
+_End of Test Plan Template_