[Product/Component Name] — Data Dictionary¶
Documents the entities and fields a product or component works with. Keep it precise enough to be the single source of truth for field names, types, and meaning — implementation and documentation should both defer to this file, not drift from it independently.
Entity: [Entity Name]¶
| Field | Type | Required | Description | Notes |
|---|---|---|---|---|
[field_name] |
[string/number/boolean/date/enum/...] | yes/no | [What it represents] | [Constraints, valid values, units] |
Relationships¶
[How entities relate to each other, if there is more than one.]
Enumerated values¶
[field_name] allowed values¶
[value_1]— [meaning][value_2]— [meaning]
Data sensitivity notes¶
[Note any personally identifiable, financial, or otherwise sensitive fields, and any handling requirements.]
Change log¶
[Track material changes to this dictionary over time, since downstream implementations depend on it.]
- [version] — [change description]