Back to Library

Data Pipeline Documenter

NotebooksNotebooks●●●Advanceddata pipelineETLdocumentationdata engineering

Prompt

Document this data pipeline thoroughly so another engineer (or future me) can maintain it.

Pipeline name: [PIPELINE NAME]
Owner / team: [OWNER]
Run schedule: [e.g. nightly at 2am UTC]
Critical downstream consumers: [WHO / WHAT DEPENDS ON THIS OUTPUT]

Please produce:
1. **Data Flow Diagram** (ASCII/text format showing: source → transforms → destination)
2. **Input Sources** table (name, type, location, expected schema, update frequency)
3. **Output / Destination** table (name, type, location, schema changes from input)
4. **Transform Inventory** (list each transformation with plain-English description)
5. **Business Logic** (document any non-obvious rules or calculations)
6. **Failure Modes** (what breaks and how to detect it)
7. **Runbook** (step-by-step: how to run, how to re-run failed jobs, how to backfill)
8. **Change Log template** (date | change | author | impact)

Pipeline code:
```python
[PASTE YOUR PIPELINE CODE]
```
Generate sample demo data

Sample sales pipeline with stage, owner, ARR, probability, and notes.

Related Prompts

Notebooks

Machine Learning Model Card Writer

Write a Model Card for my machine learning model. Model name: [MODEL NAME] Model type: [e.g. Random Forest classifier, LSTM, XGBoost regressor] Task: [WHAT THE...
Notebooks●●●AdvancedSkill-readyWorkflow-ready
Notebooks

Python Script to Notebook Converter

Convert this Python script into a well-structured Jupyter notebook. Script purpose: [WHAT THIS SCRIPT DOES] Target audience: [WHO WILL USE / READ THIS NOTEBOOK...
Notebooks●●●AdvancedWorkflow-ready
Notebooks

Jupyter Notebook Explainer

I have a Jupyter notebook I need explained. Break it down cell by cell and give me a plain-English summary. Context: [WHAT THIS NOTEBOOK IS FOR / WHO WROTE IT]...
Notebooks●●IntermediateWorkflow-ready
Notebooks

Data Cleaning Notebook Builder

Write a complete, ready-to-run Jupyter notebook for cleaning and validating my dataset. Dataset description: [DESCRIBE YOUR DATA, e.g. 'CSV of sales transactio...
Notebooks●●●AdvancedSkill-readyWorkflow-ready
Back to Library