/home/techb158/balavpn.abdallabala.com/docs
Edit: /home/techb158/balavpn.abdallabala.com/docs/07-design-checklist.md (3256B)
# COSMIC AI-Risk Dashboard, Instructor Design Checklist
## 1. Required diagrams
| Required item | File | Status |
|---|---|---|
| UML Class Diagram | `01-uml-class-diagram.puml` | Complete |
| Use Case Diagram | `02-use-case-diagram.puml` | Complete |
| Sequence Diagrams | `03-sequence-diagrams.puml` | Complete |
| Database Entity Model | `04-database-entity-model.mmd` | Complete |
| Database schema | `05-database-schema.sql` | Complete |
## 2. Source traceability
| Requirement | Source basis | Implementation mapping |
|---|---|---|
| Quantify AI risk | COSMIC-Risk measurement objective | RiskScore, RiskScoringService, project risk score |
| Organizational, technical, human dimensions | AI Governance Triangle | Risk.dimension and dimension scores |
| ISO-style indicators | ISO 15939 and VIM measurement intent | Indicator and MeasurementRecord entities |
| Software prototype and API | COSMIC-Risk objectives and timeline | API controllers and service classes |
| PM tool integration | Methodology mentions PM tool integration | ProjectManagementIntegration, ExternalWorkItemMapping, and ProjectManagementIntegrationService |
| Risk profiles by project typology | COSMIC-Risk project typology | Project.projectType field |
## 3. Feature-to-design rule
Each feature must be implemented only after it maps to the design model.
| Feature | Use case | Class | Entity | API |
|---|---|---|---|---|
| Create risk | Register AI risk | Risk, RiskService | risks | POST /api/projects/{id}/risks |
| Score risk | Score risk | RiskScore, RiskScoringService | risk_scores | POST /api/projects/{id}/calculate-risk |
| Add mitigation | Add mitigation action | MitigationAction | mitigation_actions | POST /api/risks/{id}/mitigations |
| Record indicator | Record indicator measurement | Indicator, MeasurementRecord | indicators, measurement_records | POST /api/projects/{id}/measurements |
| Track experiment | Track experiment | Experiment, ModelMetric | experiments, model_metrics | POST /api/projects/{id}/experiments |
| Evaluate gate | Evaluate deployment gate | DeploymentGate, GateCriterion | deployment_gates, gate_criteria | POST /api/projects/{id}/gate/evaluate |
| Sync PM work item | Sync Trello/Jira/Asana work item | ProjectManagementIntegration, ExternalWorkItemMapping, ProjectManagementSyncRun | project_management_integrations, external_work_item_mappings, project_management_sync_runs | POST /api/integrations/{integrationId}/sync |
## 4. Development sequence after instructor approval
1. Confirm diagrams and database model.
2. Update JSON storage to match the entity model.
3. Add service layer files.
4. Add API endpoints by use case.
5. Add tests for scoring and gate decisions.
6. Connect UI screens to stable endpoints.
7. Add multi-PM synchronization only after local risk flow works.
## 5. Open decisions before coding
| Decision | Recommended answer |
|---|---|
| MVP database | Keep JSON storage during prototype, migrate to SQLite or PostgreSQL after diagrams are approved |
| User authentication | Use role model now, add login later |
| Risk scoring formula | Keep normalized score and residual score as implementation extension |
| Multi-PM integration | Implement after risk CRUD and gate evaluation are stable |
