You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Create a Single Source of Truth (SSOT) documentation registry in each project's docs/README.md, listing every document with its authoritative topic, status,
and location.
Why
With 54-85 documentation files per project, there is no central index showing
which document is the authoritative source for each topic. This leads to
duplicated or conflicting information across files. An SSOT registry provides a
machine-readable, human-navigable index that prevents documentation drift.
Where
Repository
File
Action
common_system
docs/README.md
Add SSOT registry
thread_system
docs/README.md
Add SSOT registry
logger_system
docs/README.md
Add SSOT registry
container_system
docs/README.md
Add SSOT registry
monitoring_system
docs/README.md
Add SSOT registry
database_system
docs/README.md
Add SSOT registry
network_system
docs/README.md
Add SSOT registry
pacs_system
docs/README.md
Add SSOT registry
How
Registry Format
Each docs/README.md should contain:
# Documentation Registry> **SSOT**: This file is the single source of truth for the documentation index> of {project_name}.## Document Index| # | doc_id | Topic | Authority Document | Section | Status ||---|--------|-------|-------------------|---------|--------|| 1 | THR-ARCH-001 | Thread Pool Architecture |[ARCHITECTURE.md](./ARCHITECTURE.md)| §2 | Released || 2 | THR-GUID-001 | Queue Selection Criteria |[QUEUE_SELECTION_GUIDE.md](./QUEUE_SELECTION_GUIDE.md)| — | Released || 3 | THR-PERF-001 | Performance Baselines |[BENCHMARKS.md](./BENCHMARKS.md)| §3 | Released |
SSOT Declaration Convention
Each authoritative document should include a declaration near its top:
> **SSOT**: This section is the single source of truth for {topic}.
What
Create a Single Source of Truth (SSOT) documentation registry in each project's
docs/README.md, listing every document with its authoritative topic, status,and location.
Why
With 54-85 documentation files per project, there is no central index showing
which document is the authoritative source for each topic. This leads to
duplicated or conflicting information across files. An SSOT registry provides a
machine-readable, human-navigable index that prevents documentation drift.
Where
docs/README.mddocs/README.mddocs/README.mddocs/README.mddocs/README.mddocs/README.mddocs/README.mddocs/README.mdHow
Registry Format
Each
docs/README.mdshould contain:SSOT Declaration Convention
Each authoritative document should include a declaration near its top:
> **SSOT**: This section is the single source of truth for {topic}.Implementation Steps
Acceptance Criteria
Related