40 lines
908 B
Markdown
40 lines
908 B
Markdown
# Domain Docs
|
|
|
|
How engineering skills should consume this repo's domain documentation.
|
|
|
|
## Before exploring, read these
|
|
|
|
- `CONTEXT.md` at the repo root
|
|
- Relevant ADRs under `docs/adr/`
|
|
|
|
If these files do not exist, proceed silently. The domain-modeling flow creates
|
|
them lazily when terms or decisions are resolved.
|
|
|
|
## File structure
|
|
|
|
This is a single-context repo:
|
|
|
|
```
|
|
/
|
|
├── CONTEXT.md
|
|
├── docs/
|
|
│ ├── adr/
|
|
│ ├── research/
|
|
│ └── specs/
|
|
├── cmd/
|
|
└── internal/
|
|
```
|
|
|
|
## Use the glossary's vocabulary
|
|
|
|
Use terms as defined in `CONTEXT.md`. Do not drift to synonyms the glossary
|
|
explicitly avoids.
|
|
|
|
If a needed concept is missing, reconsider whether new language is necessary or
|
|
note the gap for `/domain-modeling`.
|
|
|
|
## Flag ADR conflicts
|
|
|
|
If proposed work contradicts an existing ADR, surface the conflict explicitly
|
|
rather than silently overriding it.
|