agentcache / docs /agents /domain.md
Yash030's picture
feat: setup agent skills configuration and fix route blueprint imports
a0d5274
|
Raw
History Blame Contribute Delete
2.05 kB
# 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, or
- **`CONTEXT-MAP.md`** at the repo root if it exists β€” it points at one `CONTEXT.md` per context. Read each one relevant to the topic.
- **`docs/adr/`** β€” read ADRs that touch the area you're about to work in. In multi-context repos, also check `src/<context>/docs/adr/` for context-scoped decisions.
If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved.
## File structure
Single-context repo (most repos):
```
/
β”œβ”€β”€ CONTEXT.md
β”œβ”€β”€ docs/adr/
β”‚ β”œβ”€β”€ 0001-event-sourced-orders.md
β”‚ └── 0002-postgres-for-write-model.md
└── src/
```
Multi-context repo (presence of `CONTEXT-MAP.md` at the root):
```
/
β”œβ”€β”€ CONTEXT-MAP.md
β”œβ”€β”€ docs/adr/ ← system-wide decisions
└── src/
β”œβ”€β”€ ordering/
β”‚ β”œβ”€β”€ CONTEXT.md
β”‚ └── docs/adr/ ← context-specific decisions
└── billing/
β”œβ”€β”€ CONTEXT.md
└── docs/adr/
```
## Use the glossary's vocabulary
When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids.
If the concept you need isn't in the glossary yet, that's a signal β€” either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`).
## Flag ADR conflicts
If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:
> _Contradicts ADR-0007 (event-sourced orders) β€” but worth reopening because…_