MDietermann
01e02b30b0
Die Engineering-Skills (wayfinder, triage, to-tickets, to-spec) erwarten pro Repo eine Tracker-Beschreibung. Hier ist das Gitea, nicht GitHub oder GitLab - der Host heisst zwar gitlab.hive-brain.de, spricht aber die Gitea-API, also tea statt glab. Issue-Dependencies und Sub-Issues kann tea 0.15 nicht abbilden; beides ist in der Doku als ungeprueft bzw. mit Body-Konvention als Fallback vermerkt, damit keine Session sich auf ungetestete Kommandos verlaesst.
52 lines
2.0 KiB
Markdown
52 lines
2.0 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.
|
|
- **`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
|
|
|
|
This repo is **single-context**:
|
|
|
|
```
|
|
/
|
|
├── CONTEXT.md
|
|
├── docs/adr/
|
|
│ ├── 0001-....md
|
|
│ └── 0002-....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…_
|