aquacom-gateway-suite/missing_docs.md

Missing documentation

Documents referenced by this repository's guidance that do not yet exist. They are planned content, not stale references — do not delete the references; create the documents as their subject matter becomes established.

Referenced from: AGENTS.md, ARCHITECTURE.md, docs/product/codex-implementation-specification.md, docs/product/software-specification.md, docs/configuration/configuration-reference.md.

Root

Status 2026-10-06: all root documents exist (README.md, CHANGELOG.md). No root documents are missing.

docs/architecture/

Referenced by ARCHITECTURE.md (§1) and the repository structure (§5).

Document	Referenced for
docs/architecture/overview.md	Detailed architecture overview
docs/architecture/data-flow.md	Detailed data-flow description
docs/architecture/live-data.md	Detailed live-data architecture
docs/architecture/historical-data.md	Detailed historical-data architecture
docs/architecture/opcua.md	Detailed OPC UA architecture
docs/architecture/storage.md	Detailed storage architecture
docs/architecture/security.md	Detailed security architecture

docs/protocol/

Referenced by AGENTS.md (protocol-evidence and uncertainty rules), ARCHITECTURE.md (§54), software-specification.md (§5.1), and the repository structure (§5).

Status 2026-10-05: The authoritative source is present (AquaCom_RTU_1_6_eng.pdf + markdown conversion), and the gap registry (protocol-gaps.md), operations registry (known-operations.md), and test-vector catalogue (test-vectors.md) have been created from it. Only the curated knowledge base remains:

Document	Referenced for	Priority
docs/protocol/aquacom.md	Curated AquaCom protocol knowledge base — to be derived from AquaCom_RTU_1_6_eng.md (framing, checksum, timeout, transport and encoding rules currently live in the other three files and the source document)	Medium — consolidation work, no longer an evidence blocker

docs/operations/

Referenced by the repository structure (§5) and Phase 14 (production hardening).

Document	Referenced for
docs/operations/deployment.md	Deployment and operations documentation (Phase 14; DoD item 14)
docs/operations/diagnostics.md	Operator diagnostics guide
docs/operations/backup-recovery.md	Backup and recovery procedures (Phase 14; DoD item 14)
docs/operations/troubleshooting.md	Troubleshooting guide

docs/exec-plans/

Referenced by AGENTS.md and codex-implementation-specification.md §59.

Path	Referenced for
docs/exec-plans/active/	Active ExecPlans for substantial work
docs/exec-plans/completed/	Completed ExecPlans

Status 2026-10-06: docs/exec-plans/active/001-implementation-roadmap.md exists (umbrella roadmap: phases 0–14, gates, gap-consumption schedule, decisions log). Child ExecPlans are spawned from it per §59 as substantial work begins; completed/ is created when the first plan finishes.

Schemas

Referenced by configuration-reference.md §1 and the repository structure (§5). Extensions depend on the configuration format chosen during technology selection.

Path	Referenced for
schemas/gateway-config.schema.*	Machine-readable configuration schema
schemas/station-config.schema.*	Station configuration schema
schemas/point-config.schema.*	Point configuration schema
schemas/storage-config.schema.*	Storage configuration schema (configuration-reference.md §84)

---

Notes

• The directories docs/architecture/ and docs/protocol/ already exist but are empty; docs/operations/, docs/exec-plans/ and schemas/ do not exist yet.
• protocol-gaps.md now exists and is seeded (10 entries: 1 conversion-fidelity VERIFY, 9 OPEN). Unresolved AquaCom protocol questions continue to be recorded there; closing an entry requires evidence and a dated resolution note.
• ExecPlan directory contents are created on demand as substantial work begins; an empty directory is the normal state.