this repo has no description
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

at main 46 lines 2.0 kB view raw view rendered
1# Domain Docs 2 3How the engineering skills should consume this repo's domain documentation when exploring the codebase. 4 5## Before exploring, read these 6 7- **`CONTEXT.md`** at the repo root for project domain language and codebase concepts. 8- **`docs/adr/`** for ADRs that touch the area you're about to work in. 9- **`PRODUCT.md`** and **`DESIGN.md`** through the `impeccable` workflow when the task involves product, brand, UX, or UI design. 10 11If 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 domain docs lazily when terms or decisions actually get resolved. The `impeccable` skill owns product and design context. 12 13## File structure 14 15Single-context repo: 16 17``` 18/ 19├── CONTEXT.md 20├── PRODUCT.md 21├── DESIGN.md 22├── docs/adr/ 23│ ├── 0001-example-decision.md 24│ └── 0002-example-decision.md 25└── src/ 26``` 27 28## Use each source for its job 29 30Use `CONTEXT.md` for domain terms, architectural vocabulary, invariants, and codebase concepts. Do not duplicate product strategy or visual design guidance into it. 31 32Use `PRODUCT.md` for product intent, users, brand, tone, anti-references, and strategic principles. 33 34Use `DESIGN.md` for visual system details, UI conventions, styling decisions, components, typography, color, and interaction patterns. 35 36## Use the glossary's vocabulary 37 38When 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. 39 40If 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`). 41 42## Flag ADR conflicts 43 44If your output contradicts an existing ADR, surface it explicitly rather than silently overriding: 45 46> _Contradicts ADR-0007 (event-sourced orders) — but worth reopening because..._