Data Dictionary Template

A one-page data dictionary template: meaning, identifier, relationships, rules and migrations.

Syntax

design-and-specify
# ENTITY NAME
Meaning:     one sentence, in the business's words
Identifier:  what people use to say "that one"

## Attributes        name (domain): meaning   [derived?]
## Relationships     both sentences, both directions
## Rules             each marked STATED or ASSUMED
## Used by           stories / requirements that need it
## Built by          migration file(s) that create or alter it
## Changes           dated note per change

Example

design-and-specify
# TOOL
Meaning:     A physical item the library lends, identified by its tag.
Identifier:  asset tag

## Attributes
- name (text): what members call it
- category (reference set): drill, saw, ladder, garden
- lending state (derived): from the latest open loan
- maintenance state: in service | awaiting repair | retired

## Relationships
- A tool has zero or more loans; every loan is for exactly one tool.

## Rules
- A retired tool cannot be lent. (STATED)

## Built by
- 20260901110000_create_tools.sql