documenting-dbt-models
CommunityWrite dbt schema.yml docs that clarify meaning.
Data & Analytics#dbt#business rules#schema.yml#data documentation#model grain#column descriptions#dbt docs
Authormiptah21
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This skill helps you document dbt models and columns in schema.yml so your team understands the dataset’s grain, business rules, and caveats—not just the technical structure.
Core Features & Use Cases
- Matches existing project documentation patterns by first inspecting existing schema.yml files and copying their style and depth.
- Turns model SQL into clear documentation by reading the relevant model SQL to identify grain and logic worth documenting.
- Improves discoverability for dbt docs by producing consistent model and column descriptions that support dbt docs generation and easier navigation.
- Use case: When you add a new model or update a business-critical metric, document the model and its key columns in schema.yml so analytics consumers trust how the data is defined and calculated.
Quick Start
Use the documenting-dbt-models skill to update models/marts/schema.yml by adding a model description and business-focused column definitions for a dbt model you are working on.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 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: documenting-dbt-models Download link: https://github.com/miptah21/skills/archive/main.zip#documenting-dbt-models Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.