Documentation Map

Documentation map

Every document below lives in the repository and is reviewed through pull requests.

Which document wins?

When two sources disagree, use this order (from docs/manuals/00-index.md):

1. decisions-register.md: binding product and domain decisions (D1–D4, R1…).
2. Current code, migrations, Compose overlays and the generated API contract: shipped behavior.
3. The manuals and operator runbooks: how to use that shipped behavior.
4. Numbered specification docs 01–18: intended architecture and design. Implementation-status notes mark designed-but-unshipped parts.
5. current-status.md is the dated execution snapshot, open-residuals.md is the current residual ledger, and slice-history.md preserves shipped evidence.

When a security or data-protection rule conflicts, keep the stricter one and ask the owner (AGENTS.md).

Coordination and history

Document	Use it for
current-status.md	Latest shipped baseline, test counts, CI topology
open-residuals.md	Every current deferred item, as a stable RES-* record with a closure contract
slice-history.md	Dated narrative and evidence for each shipped slice
decisions-register.md	Locked decisions and numbered resolutions
dev-workflow.md	Toolchain, local loops, operator notes, API quick reference

Specification (00–18)

#	Document
00	Master Specification (Overview & Front Door)
01	Vision & Scope
02	ISO 9001:2015 Domain Model & Information Architecture
03	System Architecture & Technology Stack
04	Document Control & The Controlled Vault
05	Revision / Change Management & Document Drift Prevention
06	Records & Evidence Management
07	Authorization Model — Hybrid RBAC + ABAC
08	First-Run Setup, Onboarding & Administration
09	Ingestion / Import / Auto-Organization Engine
10	Workflows, Approvals, Tasks & Notifications
11	UI/UX & Design System
12	Security, Audit Trail, Integrity & Data Protection
13	Search, Navigation & Reporting / Dashboards
14	Consolidated Data Model / ERD
15	API Design
16	Phased Delivery Roadmap
17	Gaps, Contradictions, Risks & Open Questions — Completeness & Consistency Audit
18	MVP Implementation Plan (for approval)

Manuals and runbooks

Document	Audience
Installation guide	Installer / infrastructure owner
User manual	QMS users
Administrator & IT manual	System administrators and IT operations
Runbook index	Operators: install, backup/restore, key rotation, drift scan, integrity, SPOF restart, NFR budgets
GitHub repository setup	Maintainers: rulesets, Actions, Dependabot, security settings

Architecture decision records

ADR	Decision
0001	Centralize effective URL-view classification
0002	Use native primary controls for table actions
0003	Use Playwright for responsive browser evidence
0004	Modernize the Records list contract in place
0005	Provision the first administrator in the setup wizard

Working archives (historical, not updated after shipping)

Location	Contents
docs/superpowers/	Per-slice design specs and implementation plans for the web track
docs/debt/	Dated technical-debt notes behind specific ADRs and slices
docs/review-2026-07-22.md, audit-2026-06-17.md, documentation-audit-2026-07-30.md	Dated reviews and audits