Skip to content

Traceability

sree edited this page May 11, 2025 · 1 revision

This document maps each Functional Requirement (FR) to one or more Use Cases (UC) that fulfill or validate the requirement.

Functional Requirement Coverage

FR ID Requirement Description Linked Use Case(s)
TH-FR-001 The system shall allow users to register using email and password. TH-UC-001
TH-FR-002 The system shall allow users to log in and receive a JWT token. TH-UC-002
TH-FR-003 The system shall allow users to create notes. TH-UC-003
TH-FR-004 The system shall allow users to edit notes. TH-UC-004
TH-FR-005 The system shall allow users to delete their notes. TH-UC-005
TH-FR-006 The system shall allow users to archive/unarchive notes. TH-UC-006
TH-FR-007 The system shall allow users to pin/unpin notes. TH-UC-007
TH-FR-008 The system shall allow users to create labels. TH-UC-008
TH-FR-009 The system shall allow users to assign labels to notes. TH-UC-009
TH-FR-010 The system shall allow users to view notes by label. TH-UC-010

Non-Functional Requirement Traceability

NFR ID Requirement Description Validation/Linked Artifacts
TH-NFR-001 System must use containerized microservices. docker-compose.yml, service Dockerfiles
TH-NFR-002 One-command bootstrap (docker-compose up --build) without prompts. bootstrap.sh, root README
TH-NFR-003 Automated test suite must run during startup or CI. GitHub Actions, run-tests.sh, test logs
TH-NFR-004 Microservices must be independently deployable. Separate folders, Dockerfiles, CI jobs
TH-NFR-005 Logs and health checks must be exposed for observability. /health endpoints, logging middlewares
TH-NFR-006 JWT-based auth must secure APIs. AuthService code, API specs, Postman scripts
TH-NFR-007 CI must verify services with tests before pushing. .github/workflows/dev.yml
TH-NFR-008 Services must support horizontal scaling and be load-balanced via NGINX. nginx.conf, docker-compose.yml
TH-NFR-009 95% of responses under 300ms under normal load. K6 load test reports, benchmark.md

Clone this wiki locally