How do I install the Dbt Docs skill?

Run npx skillmds@latest add altimateai-altimate-code/dbt-docs in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Dbt Docs safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Dbt Docs?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Dbt Docs free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Dbt Docs?

AltimateAI (@altimateai-altimate-code) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Dbt Docs by altimateai-altimate-code

Name: Dbt Docs
Rating: 4.2 (5 reviews)
Author: AltimateAI

File contents

dbt Documentation

Requirements

Agent: builder or migrator (requires file write access) Tools used: bash (runs altimate-dbt commands), read, glob, write, edit

When to Use This Skill

Use when the user wants to:

Add or improve model descriptions in schema.yml
Write column-level descriptions with business context
Create shared doc blocks for reusable definitions
Improve dbt docs site content

Do NOT use for:

Adding tests → use dbt-test
Creating new models → use dbt-develop
Generating sources.yml from scratch → use dbt-develop

Workflow

1. Understand the Model

altimate-dbt columns --model <name>                    # what columns exist
altimate-dbt parents --model <name>                    # what feeds this model
altimate-dbt children --model <name>                   # who consumes it
altimate-dbt compile --model <name>                    # see the rendered SQL

Read the model SQL to understand the transformations:

glob models/**/<name>.sql
read <model_file>

2. Read Existing Documentation

Check what's already documented:

glob models/**/*schema*.yml models/**/*_models.yml
read <yaml_file>

3. Write Documentation

See references/documentation-standards.md for quality guidelines.

Model-Level Description

Cover: What (business entity), Why (use case), How (key transforms), When (materialization).

- name: fct_daily_revenue
  description: >
    Daily revenue aggregation by product category. Joins staged orders with
    product dimensions and calculates gross/net revenue. Materialized as
    incremental with unique key on (date_day, category_id). Used by the
    finance team for daily P&L reporting.

Column-Level Description

Describe business meaning, derivation formula, and caveats:

columns:
  - name: net_revenue
    description: >
      Total revenue minus refunds and discounts for the day.
      Formula: gross_revenue - refund_amount - discount_amount.
      Can be negative if refunds exceed sales.

4. Validate

altimate-dbt compile --model <name>    # ensure YAML is valid

Common Mistakes

Mistake	Fix
Restating the column name as the description	`"order_id: The order ID"` → describe business meaning
Empty descriptions	Every column should have a description. If unsure, describe the source.
Not reading the SQL before documenting	Read the model to understand derivation logic
Duplicating descriptions across models	Use doc blocks for shared definitions
Writing implementation details instead of business context	Describe what it means to the business, not how it's computed

Reference Guides

Guide	Use When
references/altimate-dbt-commands.md	Need the full CLI reference
references/documentation-standards.md	Writing high-quality descriptions

---name: dbt-docsdescription: Document dbt models and columns in schema.yml with business context — model descriptions, column definitions, and doc blocks. Use when adding or improving documentation for discoverability. Powered by altimate-dbt.---# dbt Documentation## Requirements**Agent:** builder or migrator (requires file write access)**Tools used:** bash (runs `altimate-dbt` commands), read, glob, write, edit## When to Use This Skill**Use when the user wants to:**- Add or improve model descriptions in schema.yml- Write column-level descriptions with business context- Create shared doc blocks for reusable definitions- Improve dbt docs site content**Do NOT use for:**- Adding tests → use `dbt-test`- Creating new models → use `dbt-develop`- Generating sources.yml from scratch → use `dbt-develop`## Workflow### 1. Understand the Model```bashaltimate-dbt columns --model <name> # what columns existaltimate-dbt parents --model <name> # what feeds this modelaltimate-dbt children --model <name> # who consumes italtimate-dbt compile --model <name> # see the rendered SQL```Read the model SQL to understand the transformations:```bashglob models/**/<name>.sqlread <model_file>```### 2. Read Existing DocumentationCheck what's already documented:```bashglob models/**/*schema*.yml models/**/*_models.ymlread <yaml_file>```### 3. Write DocumentationSee [references/documentation-standards.md](references/documentation-standards.md) for quality guidelines.#### Model-Level DescriptionCover: **What** (business entity), **Why** (use case), **How** (key transforms), **When** (materialization).```yaml- name: fct_daily_revenue description: > Daily revenue aggregation by product category. Joins staged orders with product dimensions and calculates gross/net revenue. Materialized as incremental with unique key on (date_day, category_id). Used by the finance team for daily P&L reporting.```#### Column-Level DescriptionDescribe business meaning, derivation formula, and caveats:```yamlcolumns: - name: net_revenue description: > Total revenue minus refunds and discounts for the day. Formula: gross_revenue - refund_amount - discount_amount. Can be negative if refunds exceed sales.```### 4. Validate```bashaltimate-dbt compile --model <name> # ensure YAML is valid```## Common Mistakes| Mistake | Fix ||---------|-----|| Restating the column name as the description | `"order_id: The order ID"` → describe business meaning || Empty descriptions | Every column should have a description. If unsure, describe the source. || Not reading the SQL before documenting | Read the model to understand derivation logic || Duplicating descriptions across models | Use doc blocks for shared definitions || Writing implementation details instead of business context | Describe what it means to the business, not how it's computed |## Reference Guides| Guide | Use When ||-------|----------|| [references/altimate-dbt-commands.md](references/altimate-dbt-commands.md) | Need the full CLI reference || [references/documentation-standards.md](references/documentation-standards.md) | Writing high-quality descriptions |

Frequently asked questions

Dbt Docs