Documentation Coverage Matrix
This matrix tracks which platform features are documented and their alignment with the codebase. Use this to identify documentation gaps and ensure docs stay current with code changes.
Coverage table
| Feature/Area | Doc Link | Code Owner Path(s) | Last Verified |
|---|---|---|---|
| Health endpoint | API Reference | server/routes.ts | 2025-12-29 |
| Document upload | Evidence Submission | server/routes.ts, server/lib/pipeline.ts | 2025-12-29 |
| Evidence processing | Evidence Submission | server/lib/evidenceStorage.ts, server/lib/pipeline.ts | 2025-12-29 |
| Assessment runs | Quickstart, Runs Concepts | server/lib/assessmentPipeline.ts, server/routes.ts | 2025-12-29 |
| Vector search | Architecture Overview, Testing & Debugging | server/lib/vectorStore.ts | 2025-12-29 |
| Tenant management | Roles and Tenancy | server/lib/packSafetyService.ts, shared/schema.ts | 2025-12-29 |
| Pack configuration | Roles and Tenancy | server/lib/packResolver.ts, shared/schema.ts | 2025-12-29 |
| Criteria import | Admin Workflow | server/lib/criteriaImportService.ts | 2025-12-29 |
| Corpus management | Admin Workflow | server/routes.ts (corpus endpoints) | 2025-12-29 |
| Audit logging | Admin Workflow | server/lib/auditService.ts | 2025-12-29 |
| Portal user workflow | Portal User Workflow | client/src/pages/ComplianceManager.tsx | 2025-12-29 |
| Reviewing results | Reviewing Results | client/src/components/cm/ | 2025-12-29 |
| Evidence data model | Evidence Concepts | shared/schema.ts:160-220 | 2025-12-29 |
| Architecture overview | Architecture Overview | server/, client/src/, shared/ | 2025-12-29 |
| Repository map | Repository Map | All directories | 2025-12-29 |
| Data model | Data Model | shared/schema.ts | 2025-12-29 |
| Determinism and replay | Determinism and Replay | server/lib/packResolver.ts, server/lib/replayGuard.ts | 2025-12-29 |
| Testing and debugging | Testing and Debugging | server/lib/tracing.ts, server/lib/adminService.ts | 2025-12-29 |
| Environments config | Environments & Configuration | shared/schema.ts:283-289, server/lib/packResolver.ts | 2025-12-29 |
| Database migrations | Database Migrations | drizzle.config.ts, shared/schema.ts | 2025-12-29 |
| Release process | Release Process | package.json, docs-site/package.json | 2025-12-29 |
| ADR template | ADR-0000: Template | N/A (process doc) | 2025-12-29 |
| Multi-tenant isolation ADR | ADR-0001: Multi-Tenant Isolation | server/routes.ts:107-161, server/lib/vectorStore.ts | 2025-12-29 |
| Run snapshots ADR | ADR-0002: Run Snapshots & Determinism | shared/schema.ts:306-359, server/lib/packSafetyService.ts | 2025-12-29 |
Route mapping
| Interface | Route in this repo |
|---|---|
| Portal | /cm |
| Admin Console | /admin |
How to use this matrix
When to update
Update this matrix when:
- New feature documented: Add a row with the doc link and code paths
- Code changes: Update "Last Verified" date after confirming docs match code
- Documentation added: Change "TBD" to actual doc links
- Code paths change: Update the code owner paths
Verification process
To verify documentation accuracy:
- Review the code at the listed paths
- Compare against the documented behavior
- Update documentation if needed
- Update "Last Verified" date
Finding code paths
If code paths are unknown:
# Search for feature implementation
grep -r "functionName" server/
# Find route handlers
grep -r "app.post\|app.get" server/routes.ts
Coverage targets
| Category | Target | Current |
|---|---|---|
| API endpoints | 100% | ~10% |
| User guides | 80% | 80% |
| Concepts | 80% | 60% |
| Developer docs | 80% | 100% |
| Ops docs | 80% | 100% |
| ADRs | Core decisions | 2 ADRs |
| Troubleshooting | 100% of guides | 100% |
Stale documentation threshold
Documentation is considered stale if:
- Last verified date is older than 90 days
- Associated code paths have changed since verification
- Feature behavior has materially changed
Run git log --since="90 days ago" -- <path> to check for recent changes.