hermes-trace/docs/agents/domain.md
XLion 503de042bc
docs: set up Agent skills domain docs for mattpocock engineering skills
- Add ## Agent skills / Domain docs block to AGENTS.md
- Create docs/agents/domain.md with consumer rules for CONTEXT.md and ADRs
2026-06-18 18:55:50 +08:00

52 lines
1.5 KiB
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 it exists)
- **`docs/adr/`** — architectural decision records
If any of these files don't exist, **proceed silently**. Don't flag their
absence; don't suggest creating them upfront.
## File structure
Single-context repo:
```
/
├── CONTEXT.md ← domain glossary (if it exists)
├── docs/
│ ├── adr/
│ │ ├── 0001-turn-type-always-main.md
│ │ └── 0002-store-full-payloads-without-truncation.md
│ ├── architecture.md
│ ├── database.md
│ ├── frontend.md
│ └── hooks.md
├── AGENTS.md
├── __init__.py
├── app.py
├── db.py
└── templates/
```
## 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-0001 (turn-type-always-main) — but worth reopening
> because…_