manoel freitas
70d19a7c55
All checks were successful
Banda de modalidades passa a abrir wa.me com mensagem distinta (fallback /briefing). Glossário canônico vive em SPEC.md §8.0. Co-authored-by: Cursor <cursoragent@cursor.com>
29 lines
1.4 KiB
Markdown
29 lines
1.4 KiB
Markdown
# Domain Docs
|
||
|
||
How engineering skills should consume this repo's domain documentation.
|
||
|
||
## Single source of truth
|
||
|
||
**`SPEC.md` §8** (especially **§8.0 Linguagem ubíqua**) is the glossary and domain model for Amare. There is no root `CONTEXT.md` on purpose — do not create one. Prefer `SPEC.md` over Linear copy or OpenSpec prose when terms conflict.
|
||
|
||
Also useful:
|
||
|
||
- **`PRODUCT.md`** — positioning and audience (not the glossary)
|
||
- **`openspec/specs/`** — current capability contracts
|
||
- **`docs/adr/README.md`** — index only; ADR-001–010 live in `SPEC.md` §21
|
||
|
||
## Before exploring
|
||
|
||
1. Read `SPEC.md` §8.0 for vocabulary; skim §5.1 for public routes and §8.2+ for persistence shape when relevant.
|
||
2. If a skill expects `CONTEXT.md` / `CONTEXT-MAP.md` and finds neither, **proceed using `SPEC.md` §8** — do not invent a parallel glossary file.
|
||
|
||
## Use the glossary's vocabulary
|
||
|
||
When output names a domain concept (issue title, refactor, hypothesis, test name), use the term as defined in `SPEC.md` §8.0. Don't drift to synonyms the glossary explicitly avoids (`_Avoid_`).
|
||
|
||
If the concept isn't in §8.0 yet, either you're inventing language the project doesn't use (reconsider) or there's a real gap — resolve it by updating `SPEC.md` §8.0 via `/grill-with-docs` / domain-modeling, not by adding `CONTEXT.md`.
|
||
|
||
## Flag ADR conflicts
|
||
|
||
If output contradicts an ADR in `SPEC.md` §21, surface it explicitly rather than silently overriding.
|