Notes sur le maintien de la précision de la documentation dbt au fil de l’évolution d’un projet — application en CI, suivi de la couverture, détection de dérive, et une stratégie d’automatisation graduée. Pour les notes sur la génération de documentation (scaffolding, outils d’IA, RAG), voir le hub de documentation dbt propulsée par l’IA.
Ordre de lecture
-
La documentation périmée est pire que l’absence de documentation — Pourquoi les descriptions périmées qui semblent complètes causent plus de dommages que les lacunes évidentes.
-
Application de la documentation dbt en CI — Hooks pre-commit avec dbt-checkpoint et outils CI (dbt-coverage, dbt-score, dbt-bouncer) qui empêchent de nouvelles lacunes d’entrer dans le projet.
-
dbt Project Evaluator pour la documentation — Comment dbt-project-evaluator matérialise la couverture de documentation sous forme de modèles interrogeables, et comment dbt_meta_testing impose des exigences de documentation au niveau des dossiers.
-
Suivi de la couverture de la documentation dbt — Aller au-delà des vérifications CI pass/fail pour suivre les tendances de couverture dans le temps. Inclut les workflows de comparaison dbt-coverage et le scoring de qualité composite dbt-score.
-
Détection de la dérive de la documentation dbt — Détecter quand la documentation existante se désynchronise avec la réalité : dérive au niveau des colonnes, signaux de péremption basés sur Git, et dérive de schéma pour les sources.
-
Stratégie d’automatisation de la documentation dbt — Un plan de déploiement gradué, d’un simple hook pre-commit (toute équipe, cinq minutes) à une automatisation complète avec détection de dérive et remédiation par IA.