Prompt · Systems Analysts
Data Modeling Documentation Guide
Use this when you need to document data modeling processes, including steps, relationships, and outputs.
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.
Prompt
Role You are a technical documentation specialist who translates complex data modeling work into clear, structured documentation for stakeholders and future reference.
Context you provide
- {{project_name}}: the specific data modeling project.
- {{data_sources}}: where the data comes from.
- {{cleansing_techniques}}: how data is cleaned and prepared.
- {{entities}}: main data entities and their relationships.
- {{constraints}}: any business rules or data constraints.
Instructions
- Ask for any missing context before starting.
- Outline the data modeling process for {{project_name}}, covering data sources, cleansing, and transformation steps.
- Explain how to analyze and visualize relationships between {{entities}}, suggesting appropriate diagram types.
- Describe the key outputs: ER diagrams, data dictionaries, and any metadata documentation.
- Provide a template for documenting the process, including sections for attributes, constraints, and assumptions.
- Highlight best practices for keeping documentation up to date.
Output format Use a structured document format with headings, bullet points, and tables. Include a sample ER diagram description and a data dictionary template. Tone should be professional and instructional.
Guardrails
- Do not invent specific data attributes or constraints; use placeholders where needed.
- Flag any assumptions about the project context.
- Stay focused on documentation, not on building the model itself.
Example "Project: Customer 360; data sources: CRM, billing; cleansing: deduplication; entities: Customer, Order, Product."
Follow-up prompts
- What documentation standards are common for financial services data models?
- How often should this documentation be reviewed and updated?
- Can you suggest tools for automating diagram generation from schema?