42 lines
1.8 KiB
Markdown
42 lines
1.8 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, 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.
|
|
- **`specs/06-Decision-Records/`** — read ADRs that touch the area you're about to work in. This repo uses `specs/` instead of `docs/` for all documentation.
|
|
|
|
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 (this repo):
|
|
|
|
```
|
|
/
|
|
├── CONTEXT.md (if it exists)
|
|
├── specs/
|
|
│ ├── 00-overview/
|
|
│ ├── 01-requirements/
|
|
│ ├── 02-architecture/
|
|
│ ├── 03-Data-and-Storage/
|
|
│ ├── 04-Infrastructure-OPS/
|
|
│ ├── 05-Engineering-Guidelines/
|
|
│ └── 06-Decision-Records/ ← ADRs live here
|
|
└── 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 `specs/00-overview/00-02-glossary.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 in `specs/06-Decision-Records/`, surface it explicitly rather than silently overriding:
|
|
|
|
> _Contradicts ADR-001 (unified workflow engine) — but worth reopening because…_
|