Skip to main content
Version: 3.0.1

SDS Master Index

Quick navigation for the Software Design Specification (34 documents)

By Concern

Authentication & Security

TopicDocumentSection
Native login flowsds-05-security-architecture.md§2
SAML/SSO federationsds-05-security-architecture.md§2.5
MFA enrollmentdomains/sds-domain-usermgmt.md§5
Role-based accesssds-05-security-architecture.md§3
Session managementsds-05-security-architecture.md§4
Audit loggingdomains/sds-domain-audit.md§5

Data Processing & Analysis

TopicDocumentSection
Run file importdomains/sds-domain-fileimport.md§5
Rule execution pipelinedomains/sds-domain-analytics.md§5
Combined outcomesrules/sds-rules-combine-outcomes.md§4
Westgard QCrules/sds-rules-qc.md§4
Error code generationdomains/sds-domain-audit.md§3

Configuration

TopicDocumentSection
Kit configurationdomains/sds-domain-kitcfg.md§3-5
Client settingsreference/sds-ref-config.md§2
Environment variablesreference/sds-ref-config.md§5
Feature togglesdomains/sds-domain-kitcfg.md§5.5

Rules Engine

TopicDocumentSection
Rule frameworkrules/sds-rules-engine.md§2-4
Classification rulesrules/sds-rules-classification.md§4
Inhibition rulesrules/sds-rules-inhibition.md§4
Quantification rulesrules/sds-rules-quantification.md§4
QC/Westgard rulesrules/sds-rules-qc.md§4

Reporting

TopicDocumentSection
Trends reportsdomains/sds-domain-reports.md§5.2
Run reportsdomains/sds-domain-runrpt.md§5
LIMS exportdomains/sds-domain-reports.md§5

User Interface

TopicDocumentSection
Global UI patternsdomains/sds-domain-globalui.md§5
Tables & filteringdomains/sds-domain-tables.md§5
Notificationsdomains/sds-domain-notif.md§5

By Document Tier

Tier 1: System-Level (6 documents)

DocumentPurpose
sds-01-introduction.mdTemplate, conventions, domain boundaries
sds-02-system-context.mdExternal actors, integration points
sds-03-architecture-overview.mdLayer diagram, tech stack, patterns
sds-04-data-architecture.mdDatabase strategy, entity model
sds-05-security-architecture.mdAuth, authz, audit
sds-06-cross-cutting.mdLogging, errors, caching, queues

Tier 2: Domain Design (14 documents)

DocumentDomains CoveredCharacter
domains/sds-domain-analytics.mdANALYTICS, ANALYZER, PROGRESSStateful
domains/sds-domain-audit.mdAUDIT, ERRORCODESConfig-heavy
domains/sds-domain-configio.mdCONFIGIOIntegration
domains/sds-domain-fileimport.mdFILEIMPORT, UPLOADIntegration
domains/sds-domain-globalui.mdGLOBALUI, UI, KEYBOARDThin orchestration
domains/sds-domain-kitcfg.mdKITCFGConfig-heavy
domains/sds-domain-notif.mdNOTIFThin orchestration
domains/sds-domain-reanalyze.mdREANALYZE, HELPAlgorithmic
domains/sds-domain-reports.mdREPORTS, PRINTThin orchestration
domains/sds-domain-runfile.mdRUNFILEThin orchestration
domains/sds-domain-runrpt.mdRUNRPT, COMMENTSStateful
domains/sds-domain-settings.mdSITE, CLIENTCFG, USERSETConfig-heavy
domains/sds-domain-tables.mdTABLES, FILTERSThin orchestration
domains/sds-domain-usermgmt.mdUSERMGMTStateful

Tier 2: Rule Design (8 documents)

DocumentRules Covered
rules/sds-rules-engine.mdFramework, orchestration
rules/sds-rules-classification.mdWDCLS, WDCT, AMB, THRESHOLD
rules/sds-rules-combine-outcomes.mdCOMBOUT, multi-mix
rules/sds-rules-inhibition.mdINH, PICQUAL, SYSTEMIC
rules/sds-rules-outcome.mdSigmoid, NEC, BPEC, CC
rules/sds-rules-qc.mdWestgard, Fluorescence
rules/sds-rules-quantification.mdRQUANT, STDQT, RQUAL
rules/sds-rules-specialized.mdWC (deprecated), WT, ADJ, RWAC

Tier 3: Reference (4 documents)

DocumentContent
reference/sds-ref-api.mdHTTP endpoint catalog
reference/sds-ref-config.mdConfiguration options, env vars
reference/sds-ref-database.mdTable dictionary, relationships
reference/sds-ref-glossary.mdTerminology definitions

Tier 4: Traceability

DocumentContent
Traceability MatrixREQ → SDS → STD → Code → Tests mapping (auto-generated, top-level)
DocumentLocationPurpose
SRSoutput/srs/Software Requirements Specification
STDoutput/std/Software Test Documentation
Ops Guideoutput/guides/ops-deployment-guide.mdDeployment procedures
Dev Guideoutput/guides/dev-testing-guide.mdTesting framework