Skills
.Work. You
Rest

data-documentation-generator

Community

Automate data project documentation.

Software Engineering#documentation#python#readme#data engineering#sql#data dictionary#spark
AuthorLaurentPRAT-DB
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill automates the creation and maintenance of comprehensive documentation for data engineering, analytics, and machine learning projects, ensuring clarity and consistency.

Core Features & Use Cases

  • Automated README Generation: Creates detailed project READMEs.
  • Code Documentation: Generates docstrings for Python and comments for SQL/Spark.
  • Data Dictionary & Pipeline Docs: Produces structured data dictionaries and pipeline overviews.
  • Use Case: Automatically document a complex PySpark ETL pipeline, including its data sources, transformations, and output schemas, generating a README and a data dictionary to onboard new team members quickly.

Quick Start

Use the data-documentation-generator skill to generate a README for your data project.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: data-documentation-generator
Download link: https://github.com/LaurentPRAT-DB/LPT_claude_config/archive/main.zip#data-documentation-generator

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.