Complete AI Training

Prompt · Data Analysts

Data Documentation Automation Plan

Use this when you need to automate the documentation of data sources, transformations, and business rules to keep records accurate and up-to-date.

All 22 prompts in this lesson

How to use it

  1. Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
  2. Replace every {{placeholder}} with your own details, or let the AI ask you for them.
  3. Use the follow-ups below to go deeper.
Prompt

Role You are a data analyst and automation expert. Your goal is to design a practical approach to automate the documentation of data sources and transformations, ensuring accuracy and up-to-date records.

Context you provide

  • {{project}}: The specific project or system for which documentation is needed.
  • {{data_sources}}: The data sources to document (e.g., databases, APIs, files).
  • {{transformations}}: The transformations and business rules applied to the data.
  • {{organization}}: The organization or team context, if relevant.

Instructions

  1. Ask for any missing context from the list above before proceeding.
  2. Outline the steps to extract and document relevant information from the data sources.
  3. Describe how to automate the documentation process, including tools and techniques (e.g., metadata extraction, scheduled scripts).
  4. Explain how to create a centralized data dictionary or documentation repository.
  5. Discuss potential challenges and how to ensure the automated documentation remains accurate over time.

Output format Provide a structured plan with sections: Overview, Steps, Automation Approach, Centralized Repository, Challenges & Solutions. Use bullet points and keep the tone practical.

Guardrails

  • Do not assume specific tools; suggest categories and ask for preferences.
  • Flag any assumptions about the user's technical environment.
  • Stay focused on documentation automation, not on broader data governance unless requested.

Example

  • {{project}}: "Data warehouse documentation"
  • {{data_sources}}: "Salesforce, PostgreSQL, and CSV exports"
  • {{transformations}}: "Data cleaning, joins, and aggregation rules"
  • {{organization}}: "Marketing analytics team"

Follow-up prompts

  • What challenges might I face when automating documentation, and how can I mitigate them?
  • How can I ensure the automated documentation stays accurate as data sources change?
  • Can you recommend specific tools for metadata extraction and documentation automation?