SDS Master Index
Quick navigation for the Software Design Specification (34 documents)
By Concern
Authentication & Security
| Topic | Document | Section |
|---|---|---|
| Native login flow | sds-05-security-architecture.md | §2 |
| SAML/SSO federation | sds-05-security-architecture.md | §2.5 |
| MFA enrollment | domains/sds-domain-usermgmt.md | §5 |
| Role-based access | sds-05-security-architecture.md | §3 |
| Session management | sds-05-security-architecture.md | §4 |
| Audit logging | domains/sds-domain-audit.md | §5 |
Data Processing & Analysis
| Topic | Document | Section |
|---|---|---|
| Run file import | domains/sds-domain-fileimport.md | §5 |
| Rule execution pipeline | domains/sds-domain-analytics.md | §5 |
| Combined outcomes | rules/sds-rules-combine-outcomes.md | §4 |
| Westgard QC | rules/sds-rules-qc.md | §4 |
| Error code generation | domains/sds-domain-audit.md | §3 |
Configuration
| Topic | Document | Section |
|---|---|---|
| Kit configuration | domains/sds-domain-kitcfg.md | §3-5 |
| Client settings | reference/sds-ref-config.md | §2 |
| Environment variables | reference/sds-ref-config.md | §5 |
| Feature toggles | domains/sds-domain-kitcfg.md | §5.5 |
Rules Engine
| Topic | Document | Section |
|---|---|---|
| Rule framework | rules/sds-rules-engine.md | §2-4 |
| Classification rules | rules/sds-rules-classification.md | §4 |
| Inhibition rules | rules/sds-rules-inhibition.md | §4 |
| Quantification rules | rules/sds-rules-quantification.md | §4 |
| QC/Westgard rules | rules/sds-rules-qc.md | §4 |
Reporting
| Topic | Document | Section |
|---|---|---|
| Trends reports | domains/sds-domain-reports.md | §5.2 |
| Run reports | domains/sds-domain-runrpt.md | §5 |
| LIMS export | domains/sds-domain-reports.md | §5 |
User Interface
| Topic | Document | Section |
|---|---|---|
| Global UI patterns | domains/sds-domain-globalui.md | §5 |
| Tables & filtering | domains/sds-domain-tables.md | §5 |
| Notifications | domains/sds-domain-notif.md | §5 |
By Document Tier
Tier 1: System-Level (6 documents)
| Document | Purpose |
|---|---|
| sds-01-introduction.md | Template, conventions, domain boundaries |
| sds-02-system-context.md | External actors, integration points |
| sds-03-architecture-overview.md | Layer diagram, tech stack, patterns |
| sds-04-data-architecture.md | Database strategy, entity model |
| sds-05-security-architecture.md | Auth, authz, audit |
| sds-06-cross-cutting.md | Logging, errors, caching, queues |
Tier 2: Domain Design (14 documents)
| Document | Domains Covered | Character |
|---|---|---|
| domains/sds-domain-analytics.md | ANALYTICS, ANALYZER, PROGRESS | Stateful |
| domains/sds-domain-audit.md | AUDIT, ERRORCODES | Config-heavy |
| domains/sds-domain-configio.md | CONFIGIO | Integration |
| domains/sds-domain-fileimport.md | FILEIMPORT, UPLOAD | Integration |
| domains/sds-domain-globalui.md | GLOBALUI, UI, KEYBOARD | Thin orchestration |
| domains/sds-domain-kitcfg.md | KITCFG | Config-heavy |
| domains/sds-domain-notif.md | NOTIF | Thin orchestration |
| domains/sds-domain-reanalyze.md | REANALYZE, HELP | Algorithmic |
| domains/sds-domain-reports.md | REPORTS, PRINT | Thin orchestration |
| domains/sds-domain-runfile.md | RUNFILE | Thin orchestration |
| domains/sds-domain-runrpt.md | RUNRPT, COMMENTS | Stateful |
| domains/sds-domain-settings.md | SITE, CLIENTCFG, USERSET | Config-heavy |
| domains/sds-domain-tables.md | TABLES, FILTERS | Thin orchestration |
| domains/sds-domain-usermgmt.md | USERMGMT | Stateful |
Tier 2: Rule Design (8 documents)
| Document | Rules Covered |
|---|---|
| rules/sds-rules-engine.md | Framework, orchestration |
| rules/sds-rules-classification.md | WDCLS, WDCT, AMB, THRESHOLD |
| rules/sds-rules-combine-outcomes.md | COMBOUT, multi-mix |
| rules/sds-rules-inhibition.md | INH, PICQUAL, SYSTEMIC |
| rules/sds-rules-outcome.md | Sigmoid, NEC, BPEC, CC |
| rules/sds-rules-qc.md | Westgard, Fluorescence |
| rules/sds-rules-quantification.md | RQUANT, STDQT, RQUAL |
| rules/sds-rules-specialized.md |
Tier 3: Reference (4 documents)
| Document | Content |
|---|---|
| reference/sds-ref-api.md | HTTP endpoint catalog |
| reference/sds-ref-config.md | Configuration options, env vars |
| reference/sds-ref-database.md | Table dictionary, relationships |
| reference/sds-ref-glossary.md | Terminology definitions |
Tier 4: Traceability
| Document | Content |
|---|---|
| Traceability Matrix | REQ → SDS → STD → Code → Tests mapping (auto-generated, top-level) |
Related Documents
| Document | Location | Purpose |
|---|---|---|
| SRS | output/srs/ | Software Requirements Specification |
| STD | output/std/ | Software Test Documentation |
| Ops Guide | output/guides/ops-deployment-guide.md | Deployment procedures |
| Dev Guide | output/guides/dev-testing-guide.md | Testing framework |