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

Document	Referenced for	Source of reference
README.md	Repository overview; required by the repository structure (§5)	codex-implementation-specification.md §5
CHANGELOG.md	Version history; required by the repository structure (§5)	codex-implementation-specification.md §5

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).

Document	Referenced for	Priority
docs/protocol/aquacom.md	Authoritative AquaCom protocol knowledge base	High — blocks Phase 3+ implementation
docs/protocol/known-operations.md	Registry of verified AquaCom operations	High
docs/protocol/protocol-gaps.md	Protocol-gap registry. Every unresolved AquaCom protocol question shall be recorded here; the evidence rules in AGENTS.md and the implementation spec are not executable without it.	Highest — create first
docs/protocol/test-vectors.md	Approved protocol test vectors for implemented telegram types	High — required by every implemented telegram type

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

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 deserves priority: the architecture's evidence rules direct unresolved protocol questions into it, so its absence would leave the first such question with nowhere to go. Creating an empty registry with the entry template from codex-implementation-specification.md §17 is sufficient to start.
• ExecPlan directory contents are created on demand as substantial work begins; an empty directory is the normal state.