The short answer
dbt can build a static documentation site from your project: model descriptions, columns, tests, and the lineage .
dbt docs generate
- 1Introspects the warehouse (optional catalog) and project manifest.
- 2Writes
target/manifest.json,target/catalog.json, and related artifacts. - 3Produces the docs site assets under
target/.
dbt docs generatedbt docs serve
Starts a local web server so you can browse the docs UI (search models, click lineage).
dbt docs serveWhat good docs look like
YAML descriptions on models/columns, plus {{ doc('order_status') }} blocks for longer markdown:
models:
- name: fct_orders
description: 1 row per completed order at order grain.
columns:
- name: order_id
description: Primary key from the orders system.Mental model
YAML descriptions + tests + refs
|
dbt docs generate
|
static site + lineage graph
|
dbt docs serve / hosted docsInterview tip: Docs are not optional fluff. Interviewers like hearing that you document grain, keys, and caveats so analysts stop reverse-engineering SQL.