Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.41 KB

domain.md

File metadata and controls

43 lines (27 loc) · 1.41 KB

Domain Docs

How the engineering skills should consume this repo's domain documentation when exploring the codebase.

Layout

This is a single-context repo.

  • Root context: CONTEXT.md
  • Root ADR directory: docs/adr/
  • No CONTEXT-MAP.md is currently used

Before exploring, read these

  • CONTEXT.md at the repo root
  • docs/adr/ for 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 producer skill (/grill-with-docs) creates them lazily when terms or decisions actually get resolved.

File structure

Single-context repo:

/
+-- CONTEXT.md
+-- docs/adr/
|   +-- 0001-event-sourced-orders.md
|   +-- 0002-postgres-for-write-model.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 /grill-with-docs).

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