Requirements
Each use case, rule and quality requirement of ShopNexus has one ID, and the server's code and tests name the IDs they implement.
The IDs come from one file, docs/registry/requirements.yaml. The thesis report and these pages read it, and make trace in the umbrella repository checks the server’s code, tests and API spec against it.
IDs
| Kind | Form | Example |
|---|---|---|
| Use case | UC-<group>-nn | UC-DEAL-02 |
| Functional requirement | FR-<group>-nn | FR-DEAL-02 |
| Business rule | BR-<group>-nn | BR-DEAL-03 |
| Quality requirement | NFR-<quality>-nn | NFR-CONC-01 |
| Architecture decision | ADR-nnnn | ADR-0002 |
The groups are ACC accounts, LST listings, DSC discovery, DEAL chat and deals, TRS trust after the sale, MOD operations and SHR use cases that others include. A use case numbers its own flows: A1, A2 and on are alternate flows that still reach the goal, and E1, E2 and on are exception flows that end without it. An ID is never given twice; a dropped one is marked retired.
Coverage
| ID | Use case | Status | Code / tests | E flows tested |
|---|---|---|---|---|
UC-ACC-01 | Sign in by phone, email or Google | Not traced | ||
UC-ACC-02 | Manage sessions across devices | Not traced | ||
UC-ACC-04 | Set up COD (pickup address, GHTK/GHN link) | Not traced | ||
UC-ACC-05 | Block another user | Not traced | ||
UC-LST-01 | Post a listing with AI filling it in | Done | 42 / 26 | 8/8 |
UC-LST-02 | Manage listings | Done | 13 / 6 | 3/3 |
UC-LST-03 | Boost listings and seller plans | Planned | ||
UC-DSC-01 | Natural-language search with AI | Not traced | ||
UC-DSC-02 | Browse categories and filter | Not traced | ||
UC-DSC-03 | Save listings, follow searches, price-drop alerts | Not traced | ||
UC-DSC-04 | View a seller's profile | Not traced | ||
UC-DEAL-01 | Chat about a listing | Done | 2 / 2 | 0/2 |
UC-DEAL-02 | Negotiate a price | Done | 24 / 14 | 9/9 |
UC-DEAL-03 | Request cash on delivery | Done | 6 / 5 | 5/5 |
UC-DEAL-04 | Ship an order (GHTK/GHN waybill or a typed code) | Done | 16 / 13 | 7/8 |
UC-DEAL-05 | Track an order and inspect on delivery | Done | 11 / 11 | 3/3 |
UC-DEAL-06 | Cancel an order before it ships | Done | 11 / 10 | 1/1 |
UC-TRS-01 | Review the other side and reply to a review | Not traced | ||
UC-TRS-04 | View trust figures and limits | Not traced | ||
UC-MOD-01 | Report a violation | Not traced | ||
UC-MOD-02 | Handle reports and suspend accounts | Not traced | ||
UC-MOD-04 | Manage moderator accounts | Not traced | ||
UC-MOD-05 | Search the audit log | Not traced | ||
UC-MOD-06 | Handle a report case with the agent's proposal | Planned | ||
UC-MOD-07 | Answer a ticket with the agent's reply | Planned | ||
UC-MOD-08 | Ask the agent about a ticket, a report case or an account | In progress | 23 / 13 | |
UC-MOD-09 | Open a support ticket | Not traced | ||
UC-SHR-01 | Upload photos | Not traced | ||
UC-SHR-02 | Write the audit log | Not traced |
The counts come from registry/trace.json, which make trace writes from one commit of the server. A use case marked not traced has no tags in the code yet.