Files
LLM-Server/docs/agents/domain.md
T
haylanandClaude Bot e27f5c03b6 docs(agents): add writing-docs guide and new-term procedure
docs/agents/writing-docs.md holds the doc/comment rules and done-check,
reached via a pointer in CLAUDE.md (AGENTS.md and QWEN.md import it).
docs/agents/domain.md gains the procedure for new or conflicting terms.

Refs #55 (agent guide #62)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-24 21:52:19 +02:00

2.0 KiB

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/ — 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; 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 (this repo):

/
├── CONTEXT.md
├── docs/adr/
│   ├── 0001-....md
│   └── 0002-....md
└── src/

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).

New or conflicting terms

When you meet a term that isn't in CONTEXT.md:

  • A synonym of an existing term (e.g. "proxy" for gateway): use the canonical term. There's nothing to edit or ask.
  • A genuinely new concept: add it to CONTEXT.md in the same change, as the term, a one- or two-sentence definition and an Avoid list, with no values or config. Name the new term in your final message so the user can veto it.
  • A conflict with an existing definition (the code or the user uses a term differently than CONTEXT.md defines it): stop and ask the user. Redefining a term is their decision.

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…