DATA BUILD TOOL
11/10/2024
Documentation data build toolPhoto de Marie de Vesvrotte
Marie de Vesvrotte
Responsable Marketing

Générer une documentation automatisée avec Data Build Tool

Gouvernance des données : l’importance de la documentation 

Si la gouvernance des données ne se résume pas uniquement à la documentation, celle-ci doit vous servir de guide pour établir le cadre de gouvernance des données. 

La gouvernance des données dicte les processus, tandis que la documentation se concentre sur la capture, l'organisation et la maintenance des informations relatives aux données elles-mêmes. Elle sert de référence pour comprendre la structure, l'origine et l'utilisation des données au sein d'une organisation. 

Cette documentation doit aborder plusieurs aspects de la gouvernance des données, de la qualité à l’utilisation des données. Elle fournit des directives sur la manière de collecter, stocker, traiter et partager les données de manière sécurisée. 

Générer une documentation automatisée grâce à Data Build Tool

Parmi ses avantages, l’outil Data Build Tool permet de créer une documentation complète et à jour des transformations effectuées sur l’ensemble de vos données. 

Cette documentation est générée automatiquement à partir du code et des métadonnées de votre projet DBT, ce qui garantit que toute modification apportée au modèle de données est immédiatement reflétée dans la documentation. Cela élimine le besoin de mise à jour manuelle de la documentation, réduisant ainsi le risque d'erreurs ou d'incohérences.

Cette documentation permet de renseigner des critères comme le nom exact de la table, le code SQL, les descriptions des colonnes, les dépendances entre les modèles, les tests effectués sur les données, et les performances des requêtes.

DBT Documentation : comment ça fonctionne ? 

La documentation générée par DBT transforme la manière dont les équipes interagissent avec leurs données. 

Cette documentation fonctionne en 3 étapes : 

  • Extraction de métadonnées : DBT extrait les métadonnées à partir des modèles, des tests, des descriptions, des annotations des utilisateurs, et des configurations spécifiées dans les fichiers de projet. Ces métadonnées servent de fondation à la documentation, en fournissant une vue d'ensemble complète des processus et structures de données. 
  • Génération de la documentation : à l'aide de ces métadonnées, DBT génère une documentation web interactive qui décrit les modèles de données, les relations entre eux, les tests appliqués, et d'autres informations pertinentes. Les utilisateurs peuvent facilement explorer les dépendances entre les tables et les vues, comprendre les flux de données, et accéder aux informations critiques pour le débogage et l'optimisation des performances.
Documentation Data Build Tool

  • Mise à jour automatique : chaque fois que le projet DBT est exécuté et que des modifications sont apportées, la documentation est mise à jour pour refléter les derniers changements, assurant ainsi que la documentation reste synchronisée avec l'état actuel de l'entrepôt de données.

Caractéristiques principales de la documentation DBT 

La documentation générée par Data Build Tool présente plusieurs avantages : 

  • Graphique de dépendance : la documentation inclut des graphiques visuels montrant les dépendances entre les modèles, facilitant la compréhension des flux de données et des impacts des modifications.
Graphique de dépendance Data Build Tool

  • Catalogue de données : elle fournit un catalogue de toutes les colonnes dans les modèles, y compris les types de données, les descriptions, et les résultats des tests, aidant à comprendre la structure et la qualité des données. Ce catalogue permet de garantir l'intégrité des données en fournissant une vue d'ensemble claire de la composition des données et de leur conformité aux attentes et aux standards de qualité.
Catalogue de données Data Build Tool

  • Recherche et navigation : la documentation web est facilement navigable et rechargeable, permettant aux utilisateurs de trouver rapidement les informations dont ils ont besoin. Que ce soit pour localiser un modèle spécifique, comprendre les dépendances ou vérifier les résultats des tests, la fonctionnalité de recherche améliore considérablement l'efficacité et l'accessibilité des informations.
  • Personnalisation : les utilisateurs peuvent ajouter des descriptions personnalisées aux modèles, colonnes, et tests dans les fichiers YAML, qui sont ensuite intégrés dans la documentation générée.
Personnalisation Data Build Tool

  • Sécurité et conformité : la documentation générée par DBT peut également inclure des informations sur la sécurité et la conformité des données, telles que les rôles d'accès et les politiques de confidentialité appliquées. Cela aide les organisations à s'assurer que leurs pratiques de gestion des données respectent les normes réglementaires et les meilleures pratiques.
Rond violet avec fleche vers le haut