Skills › Skills For Real Engineers › domain-modeling › GLOSSARY-FORMAT.md
GLOSSARY-FORMAT.md
60 lines · skills/engineering/domain-modeling/GLOSSARY-FORMAT.md at 4ae2317
GLOSSARY.md Format
Raw lines 1 to 23## Structure
5```md
6# {Context Name}
8{One or two sentence description of what this context is and why it exists.}
10## Language
12**Order**:
13{A one or two sentence description of the term}
14_Avoid_: Purchase, transaction
16**Invoice**:
17A request for payment sent to a customer after delivery.
18_Avoid_: Bill, payment request
20**Customer**:
21A person or organization that places orders.
22_Avoid_: Client, buyer, account
23```
Structure
# {Context Name}
{One or two sentence description of what this context is and why it exists.}
## Language
**Order**:
{A one or two sentence description of the term}
_Avoid_: Purchase, transaction
**Invoice**:
A request for payment sent to a customer after delivery.
_Avoid_: Bill, payment request
**Customer**:
A person or organization that places orders.
_Avoid_: Client, buyer, accountRaw lines 3 to 2425## Rules
27- **Be opinionated.** When multiple words exist for the same concept, pick the best one and list the others under `_Avoid_`.
28- **Keep definitions tight.** One or two sentences max. Define what it IS, not what it does.
29- **Only include terms specific to this project's context.** General programming concepts (timeouts, error types, utility patterns) don't belong even if the project uses them extensively. Before adding a term, ask: is this a concept unique to this context, or a general programming concept? Only the former belongs.
30- **Group terms under subheadings** when natural clusters emerge. If all terms belong to a single cohesive area, a flat list is fine.
Rules
- Be opinionated. When multiple words exist for the same concept, pick the best one and list the others under
_Avoid_. - Keep definitions tight. One or two sentences max. Define what it IS, not what it does.
- Only include terms specific to this project's context. General programming concepts (timeouts, error types, utility patterns) don't belong even if the project uses them extensively. Before adding a term, ask: is this a concept unique to this context, or a general programming concept? Only the former belongs.
- Group terms under subheadings when natural clusters emerge. If all terms belong to a single cohesive area, a flat list is fine.
32## Single vs multi-context repos
34**Single context (most repos):** One `GLOSSARY.md` at the repo root.
36**Multiple contexts:** A `GLOSSARY-MAP.md` at the repo root lists the contexts, where they live, and how they relate to each other:
38```md
39# Glossary Map
41## Contexts
43- [Ordering](./src/ordering/GLOSSARY.md): receives and tracks customer orders
44- [Billing](./src/billing/GLOSSARY.md): generates invoices and processes payments
45- [Fulfillment](./src/fulfillment/GLOSSARY.md): manages warehouse picking and shipping
47## Relationships
49- **Ordering → Fulfillment**: Ordering emits `OrderPlaced` events; Fulfillment consumes them to start picking
50- **Fulfillment → Billing**: Fulfillment emits `ShipmentDispatched` events; Billing consumes them to generate invoices
51- **Ordering ↔ Billing**: Shared types for `CustomerId` and `Money`
52```
54The skill infers which structure applies:
56- If `GLOSSARY-MAP.md` exists, read it to find contexts
57- If only a root `GLOSSARY.md` exists, single context
58- If neither exists, create a root `GLOSSARY.md` lazily when the first term is resolved
60When multiple contexts exist, infer which one the current topic relates to. If unclear, ask.
Single vs multi-context repos
Single context (most repos): One GLOSSARY.md at the repo root.
Multiple contexts: A GLOSSARY-MAP.md at the repo root lists the contexts, where they live, and how they relate to each other:
# Glossary Map
## Contexts
- [Ordering](./src/ordering/GLOSSARY.md): receives and tracks customer orders
- [Billing](./src/billing/GLOSSARY.md): generates invoices and processes payments
- [Fulfillment](./src/fulfillment/GLOSSARY.md): manages warehouse picking and shipping
## Relationships
- **Ordering → Fulfillment**: Ordering emits `OrderPlaced` events; Fulfillment consumes them to start picking
- **Fulfillment → Billing**: Fulfillment emits `ShipmentDispatched` events; Billing consumes them to generate invoices
- **Ordering ↔ Billing**: Shared types for `CustomerId` and `Money`The skill infers which structure applies:
- If
GLOSSARY-MAP.mdexists, read it to find contexts - If only a root
GLOSSARY.mdexists, single context - If neither exists, create a root
GLOSSARY.mdlazily when the first term is resolved
When multiple contexts exist, infer which one the current topic relates to. If unclear, ask.
Raw lines 32 to 60