31 lines
975 B
Markdown
31 lines
975 B
Markdown
# {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, account
|
|
|
|
## 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 don't belong.
|
|
- **Group terms under subheadings** when natural clusters emerge.
|
|
|
|
## Single vs multi-context repos
|
|
|
|
**Single context (most repos):** One `CONTEXT.md` at the repo root.
|
|
|
|
**Multiple contexts:** A `CONTEXT-MAP.md` at the repo root lists the contexts.
|