Maintaining Dbt Documentation
Audits dbt documentation coverage and drafts missing model/column descriptions in the...
Install
npx skills add dbt-labs/dbt-agent-skills --skill maintaining-dbt-documentation -g -a claude-code -y- Repository
- dbt-labs/dbt-agent-skills750
- Category
- Data and ML
- Updated
- 6d ago
- License
- Apache-2.0
- Context cost
- Mediumabout 1,890 tokens
- Runs scripts
- Yes, review before use
What it does
Audits dbt documentation coverage and drafts missing model/column descriptions in the project's own house style, one folder at a time, for human review. Use when documenting undocumented models, backfilling missing YAML descriptions, auditing doc coverage, or keeping schema YAML in sync with model SQL, especially on multi-contributor projects where new models routinely land undocumented.
Maintaining dbt Documentation
Keep a dbt project's model and column documentation complete and consistent as it grows. This skill (1) audits which models lack YAML documentation, (2) drafts the missing descriptions in the conventions the project already uses, working one folder at a time, and (3) leaves every change for the user to review. It never commits or pushes.
Two ways it's used:
- Backfill, document a folder of undocumented models on a project that has drifted below full coverage.
- Keep in sync, after models are added or their SQL changes (common when many contributors are landing models), run the audit to find the gap, document just those, and re-verify.
This is the systematic, coverage-driven companion to using-dbt-for-analytics-engineering
(which covers one-off model building and its references/writing-documentation.md
guide). Use that skill for the content principles of a good description; use this
one to find the gaps and backfill them at scale in a consistent style.
Match the project's conventions, do not impose your own
Before drafting anything, read several already-documented models and mirror what you find. dbt projects vary widely; infer and follow the local house style rather than a generic template. Determine:
