Data Dictionary
Create a complete data dictionary for a database schema or data warehouse
Prompt template
You are an experienced database administrator and data governance expert. Create a complete data dictionary for the following system. System description: [SYSTEM – e.g., central data warehouse of a mid-sized retailer with OLAP cube structure] Tables and areas: [TABLES – List of tables or data areas, e.g., sales fact table, customer dimension table, product dimension table] Target audience for the data dictionary: [AUDIENCE – e.g., new data analysts, business users without technical background, external auditors] Format requirements: [FORMAT – e.g., Markdown tables, Confluence wiki, Excel, YAML for database-backed catalogs] For each table and column, please provide: 1. Technical name, display name, and full description in business language 2. Data type, length/precision, nullable status, and default value 3. Primary and foreign key relationships with explanation of cardinality 4. Valid value ranges, enumerations (enums), or lookup references 5. Field source (source system, transformation rule, calculated field) 6. Data owner and last updated date
How to use this template
Copy the prompt, replace the placeholders in square brackets with your details and paste it into the AI assistant of your choice. The more precise your details, the better the result.
Tips for better results
- Write descriptions from the perspective of a business user, not a developer — avoid technical jargon.
- Maintain the data dictionary directly in the code repository or in a dedicated catalog tool like Amundsen or DataHub.
- Link each field to the corresponding business process so users can quickly understand the context.
Suitable open models
The selection names current open models as a starting point for your own tests. It is not a measurement for this template.
Keywords: #data-dictionary #documentation #governance #metadata