|
|
@@ -0,0 +1,36 @@
|
|
|
+# Domain Docs
|
|
|
+
|
|
|
+This repository uses a multi-context domain documentation layout.
|
|
|
+
|
|
|
+## Before exploring
|
|
|
+
|
|
|
+Read the root `CONTEXT-MAP.md`, then read the `CONTEXT.md` files for relevant
|
|
|
+Maven modules. Read system-wide ADRs under `docs/adr/` and module-specific ADRs
|
|
|
+under `<module>/docs/adr/`.
|
|
|
+
|
|
|
+If these files do not exist, proceed silently. Domain-modeling skills create
|
|
|
+them lazily when terminology or decisions are resolved.
|
|
|
+
|
|
|
+## Layout
|
|
|
+
|
|
|
+```text
|
|
|
+/
|
|
|
+|-- CONTEXT-MAP.md
|
|
|
+|-- docs/adr/
|
|
|
+|-- pipe-network-service/CONTEXT.md
|
|
|
+|-- environment-service/CONTEXT.md
|
|
|
+|-- zk-gateway/CONTEXT.md
|
|
|
+|-- zk-common/CONTEXT.md
|
|
|
+|-- zk-api-service/CONTEXT.md
|
|
|
+|-- manhole-service/CONTEXT.md
|
|
|
+|-- firefighting-pressure-service/CONTEXT.md
|
|
|
+|-- flammable-gas-service/CONTEXT.md
|
|
|
+|-- telemetry-service/CONTEXT.md
|
|
|
+|-- radar-service/CONTEXT.md
|
|
|
+|-- audio-service/CONTEXT.md
|
|
|
+`-- water-level-service/CONTEXT.md
|
|
|
+```
|
|
|
+
|
|
|
+Each module may store scoped decisions under `<module>/docs/adr/`. Use the
|
|
|
+terminology defined by the relevant context consistently. Explicitly flag any
|
|
|
+proposal that conflicts with an existing ADR.
|