30 lines
985 B
Markdown
30 lines
985 B
Markdown
# Domain Docs
|
|
|
|
How the engineering skills should consume this repo's domain documentation when exploring the codebase.
|
|
|
|
## Before exploring, read these
|
|
|
|
- `CONTEXT.md` at the repo root. If `CONTEXT-MAP.md` exists, use it to find the relevant context docs.
|
|
- `docs/adr/`: read ADRs that touch the area you're about to work in.
|
|
|
|
If any of these files don't exist, proceed silently. Don't flag their absence or suggest creating them upfront; `/domain-modeling` creates them when terms or decisions are resolved.
|
|
|
|
## File structure
|
|
|
|
This repo uses the single-context layout:
|
|
|
|
```text
|
|
/
|
|
├── CONTEXT.md
|
|
├── docs/adr/
|
|
└── src/
|
|
```
|
|
|
|
## Use the glossary's vocabulary
|
|
|
|
When your output names a domain concept, use the term as defined in `CONTEXT.md`. If a needed concept isn't there, reconsider the terminology or note the gap for `/domain-modeling`.
|
|
|
|
## Flag ADR conflicts
|
|
|
|
If your output contradicts an existing ADR, surface it explicitly rather than silently overriding it.
|