Current section
Files
Jump to
Current section
Files
priv/toolchain/canon/docs/goals-README.md
# Goals
Externally sourced contracts: what the system commits to do for users,
sourced from product authority, customer requests, regulatory
requirements, or domain experts.
Format and authority specified in
[`../conventions.md` §2](../conventions.md#2-goals-docsgoals); meta-rules
in [`../principles.md`](../principles.md). The headline rule:
> **Code is the source of truth for what the system does. Goals exist
> for the *why*.**
A goal block carries the verbatim source quote and any sourced
clarifications that resolved ambiguity. No `Requirements:` list — the
code is the requirements list, and `Realization:` / `Verified-by:`
trailers point readers at it.
## Naming
Files are grouped by **area** of the product, not per goal. Multiple
goals share a file:
```
docs/goals/<area>.md
```
Areas are stable as the product evolves; roles get renamed, features
come and go.
## Authority
Product (and the external authority that signed off on each goal) via
`.github/CODEOWNERS`.
## Adding a goal
1. Confirm the goal derives from external authority. If the answer to
*"who outside engineering authorized this?"* is "nobody," it's not
a goal.
2. Identify the area file (`<area>.md`). Create one if no existing
area fits.
3. Add a `## Goal:` block with the Source quote, any Clarified-by
line, and the trailer pointers (Domain / ADR / Realization /
Verified-by). See [`../conventions.md` §2](../conventions.md#2-goals-docsgoals).