add architecture documentation and testing strategy
Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
@@ -0,0 +1,21 @@
|
||||
# 10. Quality Requirements
|
||||
|
||||
This section contains all relevant quality requirements. The most important ones are already described in section 1.2 (Quality Goals), and should only be referenced here.
|
||||
|
||||
## Quality Requirements Overview
|
||||
|
||||
| Category | Quality Requirement |
|
||||
| --------------- | ----------------------------------------------------------------------- |
|
||||
| Availability | Service available ≥ 99.9% of the time |
|
||||
| Performance | Generation endpoints respond within 200 ms (excluding AI model latency) |
|
||||
| Security | All user data encrypted at rest and in transit; JWT-protected endpoints |
|
||||
| Maintainability | Test coverage > 80% on `app/`; CI pipeline enforced |
|
||||
| Portability | Runs on Windows and Linux without modification |
|
||||
|
||||
## Quality Scenarios
|
||||
|
||||
| Scenario ID | Source | Stimulus | Environment | Artifact | Response | Response Measure |
|
||||
| ----------- | --------- | ------------------------------- | ----------- | ------------ | ------------------------------- | ----------------------------------------- |
|
||||
| QS-01 | End user | Submits text generation request | Production | AI Service | Returns generated text | < 200 ms (excluding model latency) |
|
||||
| QS-02 | Attacker | Sends request without valid JWT | Production | Auth Service | Returns 401 Unauthorized | 100% of unauthenticated requests rejected |
|
||||
| QS-03 | Developer | Adds new API endpoint | Development | FastAPI app | Tests pass, coverage maintained | CI pipeline green |
|
||||
Reference in New Issue
Block a user