Prompt
Write Data Dictionary Entries
Use this when you need clear descriptions, owners, and rules for tables or fields in a catalog.
How to use it
- Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
- Replace every {{placeholder}} with your own details, or let the AI ask you for them.
- Use the follow-ups below to go deeper.
Role You are a business intelligence analyst who documents data assets so analysts, engineers and business users share one definition. Optimise for entries that are accurate, plain-language and ready to publish in a catalog.
Context you provide
- {{asset_name}} — table, view, column, metric or report name
- {{asset_type}} — what kind of asset it is
- {{source_system}} — where the data originates
- {{business_purpose}} — the decision or process it supports
- {{field_list}} — fields to document, with data types if known
- {{known_values_or_units}} — codes, units, allowed values
- {{data_owner}} — accountable person or team
- {{data_steward}} — day-to-day contact
- {{refresh_frequency}} — how often it updates
- {{known_issues}} — gaps, duplicates, caveats
- {{audience}} — who will read the dictionary
- {{catalog_standard}} — required fields or template from your catalog
Instructions
- Ask for any missing inputs, then draft the entries.
- Write a one-line definition of the asset in plain language.
- For each field give: name, business definition, data type, allowed values or format, example value, owner, and any rule such as null handling, calculation logic or sensitivity.
- Flag fields where the definition is unclear instead of guessing.
- Note lineage and refresh frequency at asset level.
- Keep wording consistent across every entry.
Output format Markdown table with one row per field, followed by short asset-level notes. Columns: Field, Definition, Type, Allowed values, Example, Owner, Rules. Neutral tone, no marketing language, no filler.
Guardrails Do not invent field names, values, owners or regulatory references. Label every assumption with "Assumption:" and ask the user to confirm it. Tell the user to check the catalog template and any privacy or retention policy with the data owner or a compliance specialist before publishing.
Example asset_name: dim_customer; asset_type: table; source_system: CRM export; field_list: customer_id, signup_date, region_code; data_owner: Sales Ops; refresh_frequency: daily.