Lesson Overview

In this lesson we will:

  • Learn about DBTs documentation feature.

What Is The DBT Documentation Feature

DBTs documentation feature allows us to embed commentary and documentation alongside our model code, and automatically create a consumable documentation website which colleagues can use to understand the project.

Video: DBT - Documentation

Why Is This needed?

As with any code we write, having good clear documentation brings many advantages.

Historically, data engineering and ETL activity has suffered from poor quality documentation. This can lead to slow delivery time or quality issues as developers do not understand the code they are working with.

Part of this can be blamed on the tools data engineers have traditionally used. GUI based ETL tools had any documentation trapped inside

This is another practice which data and analytics engineers are looking to adopt from developers, who have historically used more commenting and documentation for their code as a collaboration tool.

Summary

In this lesson we learnt about DBTs documentation feature.

We considered how historically, tools in the data engineering and ETL space have not had great features for documentation and collaboration.

We explained how DBT improves this situation by adding the ability to the project inline, then generate a simple website which can be used to aid communication with the business and other stakeholders.

Next Lesson

Description of next lesson here

Hands-On Training For The Modern Data Stack

Timeflow Academy is an online, hands-on platform for learning about Data Engineering and Modern Cloud-Native Database management using tools such as DBT, Snowflake, Kafka, Spark and Airflow...

Sign Up

Already A Member? Log In

Next Lesson:

Introduction To Apache Druid

Prev Lesson:

Sources and Exposures

© 2022 Timeflow Academy.