Why documentation makes data discoverable in dbt - Challenge Your Understanding

Challenge - 5 Problems

🧠 Conceptual

intermediate

How does documentation improve data discoverability in dbt?

Which of the following best explains why documentation helps make data more discoverable in dbt projects?

A Documentation replaces the need for data testing, so users can trust data without verification.

B Documentation provides clear descriptions and context for data models, making it easier for users to find and understand data.

C Documentation encrypts data to protect it from unauthorized access, thus making it more discoverable.

D Documentation automatically cleans data, improving its quality and discoverability.

💡 Hint

Think about how clear explanations help people find and use data.

Documentation in dbt provides descriptions and context for data models and columns, which helps users understand what data is available and how to use it. This clarity makes data easier to discover.

❓ data_output

intermediate

Output of dbt docs generate command

What is the main output of running the command dbt docs generate in a dbt project?

A A JSON file with raw data from the models.

B A CSV file containing all data from the warehouse.

C JSON files (manifest.json and catalog.json) that power an HTML site with searchable documentation of models, sources, and tests.

D A SQL script that creates documentation tables in the database.

💡 Hint

Think about what kind of user-friendly output helps people explore data.

The dbt docs generate command generates manifest.json and catalog.json, which are used to create an HTML documentation site that users can browse to discover and understand data models and their relationships.

🔧 Debug

advanced

Why is some data not showing in dbt docs?

A user notices that some models are missing descriptions in the dbt docs site after running dbt docs generate. Which of the following is the most likely cause?

A The models have too many columns, causing docs to skip them.

B The dbt project was not compiled before generating docs.

C The database connection is offline during docs generation.

D The models do not have descriptions defined in their schema.yml files.

💡 Hint

Think about what information dbt docs uses to show descriptions.

dbt docs shows descriptions only if they are defined in the schema.yml files. Missing descriptions mean no text appears in the docs site.

🚀 Application

advanced

Using documentation to improve team collaboration

How can well-maintained documentation in dbt help a data team work better together?

A By providing a shared understanding of data definitions and lineage, reducing confusion and errors.

B By automatically fixing data quality issues without manual checks.

C By replacing the need for meetings and communication among team members.

D By hiding complex data transformations from the team to simplify workflows.

💡 Hint

Think about how clear information helps people coordinate their work.

Documentation clarifies what data means and how it flows, so team members can trust and use data consistently, improving collaboration.

❓ visualization

expert

Interpreting dbt docs lineage graph

In the dbt docs lineage graph, what does a direct arrow from model A to model B represent?

A Model B depends on model A as a source or upstream model.

B Model A and model B are unrelated and independent.

C Model A is a downstream model that uses data from model B.

D Model A and model B have identical data and definitions.

💡 Hint

Think about what dependency means in data pipelines.

An arrow from A to B means B uses data from A, so B depends on A. This shows data flow direction in the lineage graph.

Practice

1. Why is documentation important in dbt projects for data discoverability?

easy

A. It speeds up the data processing time.

B. It explains data clearly so users can find and understand it easily.

C. It automatically fixes errors in data models.

D. It encrypts data for security.

Solution

1. Step 1: Understand the purpose of documentation in dbt

   Documentation provides clear explanations about data models and columns.

2. Step 2: Connect documentation to data discoverability

   Clear explanations help users find and understand data easily, improving discoverability.

3. Final Answer:

   It explains data clearly so users can find and understand it easily. -> Option B

4. Quick Check:

   Documentation improves discoverability [OK]

Hint: Documentation means clear explanations for easy data finding [OK]

Common Mistakes:

• Confusing documentation with data processing speed
• Thinking documentation fixes data errors automatically
• Assuming documentation encrypts data

2. Which of the following is the correct way to add a description to a dbt model in YAML?

easy

A. models:
- name: sales
description: 'Contains sales data by region'

B. models:
name: sales
description: 'Contains sales data by region'

C. model:
- name: sales
description: 'Contains sales data by region'

D. models:
- sales:
description: 'Contains sales data by region'

Solution

1. Step 1: Recall YAML structure for dbt model descriptions

   The correct syntax uses 'models:' followed by a list with '- name:' and 'description:' keys.

2. Step 2: Identify the option matching this structure

   models: - name: sales description: 'Contains sales data by region' correctly uses a list item with 'name' and 'description' under 'models'.

3. Final Answer:

   models:\n - name: sales\n description: 'Contains sales data by region' -> Option A

4. Quick Check:

   Correct YAML list syntax [OK]

Hint: YAML lists use dash and indentation for model descriptions [OK]

Common Mistakes:

• Missing dash for list items
• Using singular 'model' instead of 'models'
• Incorrect indentation breaking YAML format

3. Given this YAML snippet in a dbt model file:

models:
  - name: customers
    description: 'Customer details including name and email'
  - name: orders
    description: 'Order records with dates and amounts'

What will dbt documentation show for the 'orders' model?

medium

A. Error loading description

B. Customer details including name and email

C. Order records with dates and amounts

D. No description available

Solution

1. Step 1: Locate the 'orders' model in the YAML snippet

   The 'orders' model is listed with a description: 'Order records with dates and amounts'.

2. Step 2: Understand dbt documentation usage

   dbt uses the description text to show model info in docs.

3. Final Answer:

   Order records with dates and amounts -> Option C

4. Quick Check:

   Model description matches YAML text [OK]

Hint: Match model name to its description in YAML [OK]

Common Mistakes:

• Mixing descriptions between models
• Assuming missing description means error
• Confusing model names

4. You wrote this YAML for a dbt model description but the docs show no description:

models:
  name: products
  description: 'Product catalog details'

What is the likely error?

medium

A. Missing dash (-) before 'name' to define list item

B. Incorrect key 'description' instead of 'desc'

C. YAML does not support descriptions

D. Model name should be uppercase

Solution

1. Step 1: Check YAML list syntax for models

   dbt expects 'models:' followed by a list indicated by '-'. Missing dash means no list item.

2. Step 2: Identify the missing dash before 'name'

   Without '-', YAML treats 'name' as a key under 'models', not a list item, so description is ignored.

3. Final Answer:

   Missing dash (-) before 'name' to define list item -> Option A

4. Quick Check:

   Dash defines list items in YAML [OK]

Hint: Always use dash for list items in YAML [OK]

Common Mistakes:

• Using wrong key names
• Thinking YAML disallows descriptions
• Ignoring YAML indentation rules

5. You want to improve data discoverability by adding descriptions to columns in a dbt model. Which YAML snippet correctly documents the 'customer_id' column with a description?

hard

A. models:
- name: customers
columns:
- name: customer_id
desc: 'Unique ID for each customer'

B. models:
- name: customers
columns:
customer_id: 'Unique ID for each customer'

C. models:
- name: customers
columns:
- customer_id: 'Unique ID for each customer'

D. models:
- name: customers
columns:
- name: customer_id
description: 'Unique ID for each customer'

Solution

1. Step 1: Recall correct YAML structure for column documentation in dbt

   Columns are listed as items with '- name:' and 'description:' keys.

2. Step 2: Identify the option matching this structure

   models: - name: customers columns: - name: customer_id description: 'Unique ID for each customer' correctly uses '- name: customer_id' and 'description' key.

3. Final Answer:

   models:\n - name: customers\n columns:\n - name: customer_id\n description: 'Unique ID for each customer' -> Option D

4. Quick Check:

   Correct column description syntax [OK]

Hint: Use '- name:' and 'description:' for columns in YAML [OK]

Common Mistakes:

• Using key-value pairs without dash for columns
• Using 'desc' instead of 'description'
• Incorrect indentation breaking YAML