This folder contains the pre-development and reference documentation aligned with the functional and non-functional requirements for the Service Management System (SMS).
| Document | Purpose |
|---|---|
| SRS.md | Software Requirements Specification (purpose, scope, FR/NFR, assumptions, interfaces) |
| ARCHITECTURE.md | High-level and low-level system design |
| DATABASE_DESIGN.md | Collections/schema, keys, relationships, ER view |
| API_SPECIFICATION.md | REST endpoints, payloads, status codes, errors |
| USE_CASES_AND_UML.md | Use cases and UML diagrams (Mermaid) |
| TEST_PLAN.md | Unit, integration, load testing approach and sample cases |
| SECURITY_DESIGN.md | JWT, hashing, session, planned 2FA/CAPTCHA/lockout |
| TECH_STACK.md | Technology choices and rationale |
| PROJECT_PLAN.md | Sprints, milestones, timeline |
| DEPLOYMENT_PLAN.md | Hosting, database, HTTPS, optional CI/CD |
Start with SRS.md as the primary requirements reference, then DATABASE_DESIGN.md and API_SPECIFICATION.md before extending the backend.