DTLaudit — Guide utilisateur
Auditer et comparer vos projets en un seul coup d’œil.
À quoi ça sert ?
Quand on développe plusieurs projets en parallèle, il devient vite difficile de savoir ou chacun en est. Lequel à un dépôt Git ? Lequel a été publié sur GitHub ? Lequel n’a pas encore de documentation ? Lequel à des modifications locales non commitées ?
DTLaudit répond à toutes ces questions en une seule exécution. Il parcourt vos projets, collecte les informations pertinentes, et produit un rapport HTML clair que vous pouvez ouvrir dans n’importe quel navigateur.
Il ne modifie rien. Il ne commite pas, ne pousse pas, ne supprime rien. Il regarde et rapporte.
Ce que DTLaudit vérifie pour chaque projet
Démarrage
Avant de commencer
DTLaudit s’exécute directement depuis son répertoire, sans installation. Il suffit d’avoir Python 3.10 ou supérieur installé sur votre machine.
Git doit également être accessible dans votre PATH pour que les informations de dépôt soient collectées. Sans Git, l’audit se poursuit mais les colonnes Git seront vides.
Si vous souhaitez voir les informations GitHub (visibilité, dernière release, pull requests, issues), installéz et authentifiéz
gh depuis cli.github.com. Sans gh, l’audit fonctionne normalement, les colonnes GitHub restent vides.Version compilée (DTLaudit.exe)
Si vous utilisez la version compilée, aucun Python n’est nécessaire. Double-cliquez sur DTLaudit.exe ou lancez-le depuis un terminal. La fenêtre de sélection s’ouvre directement.
Premier lancement
Lancez DTLaudit sans argument. Une fenêtre s’ouvre :
DTLaudit_rapport.html est créé dans le répertoire de DTLaudit, pas dans le dossier audité.Scénarios courants
Faire le point sur toute la suite de projets
Vous avez un dossier outils\ contenant plusieurs projets et vous voulez savoir en un coup d’œil lesquels sont en ordre. Lancez DTLaudit en mode suite sur ce dossier. La table de synthèse vous donnera immédiatement une vision globale : Git, GitHub, README, documentation, release, modifications locales.
Vérifier un projet avant une release
Avant de publier une nouvelle version, utilisez le mode projet unique. Vérifiez que les quatre manuels sont présents, qu’il n’y a pas de modifications locales non commitées, et que le répertoire dist\ n’est pas suivi par Git.
Contrôler la couverture documentaire
Vous souhaitez savoir quels projets n’ont pas encore leur manuel de référence en anglais. Lancez l’audit sur la suite et consultez la colonne RF En dans la table de synthèse. Les observations listent également les projets concernés par document manquant.
Audit rapide sans accès Internet
En déplacement ou sur un réseau restreint, utilisez l’option --no-github en ligne de commande. L’audit s’exécute sans tenter d’interroger GitHub, ce qui évite les temps d’attente liés aux timeouts.
Exporter les données pour un autre outil
Utilisez l’option --json pour obtenir un fichier JSON structuré contenant toutes les données collectées. Ce fichier peut être lu par un script, importé dans un tableau de bord, ou archivé avec l’historique du projet.
Lire le rapport
La table de synthèse
C’est la première chose à regarder. Une ligne par projet, des colonnes colorées. Ce que signifient les colonnes importantes :
| Colonne | Signification |
|---|---|
| Modifs | Nombre de fichiers modifiés localement non commités. Zéro est la situation normale avant une release. |
| RF Fr / UG Fr / RF En / UG En | Les quatre documents normatifs attendus. Un Non indiqué un document manquant à produire. |
| Release | Non signifie qu’aucune release n’a été publiée sur GitHub, ou que GitHub n’a pas été interrogé. |
| Branche | Branche Git active. Un tiret indiqué l’absence de dépôt Git. |
Le détail par projet
Chaque projet dispose d’un bloc détaillé en dessous de la table. Consultez-le quand la table signale une anomalié et que vous souhaitez en connaître le contexte exact : branche, nombre de tags, URL du dépôt GitHub, etc.
Les observations remarquables
Cette section liste automatiquement les points d’attention : documents manquants par projet, répertoires générés observés, fichiers volumineux. C’est une liste d’actions potentielles, pas une liste d’erreurs.
La matrice de fichiers
Utile pour détecter les incohérences entre projets : un fichier de configuration présent dans huit projets sur dix mérite qu’on vérifie pourquoi les deux autrès ne l’ont pas.
Référence
Contrôle normatif
DTLaudit cherche quatre fichiers HTML dans chaque projet, reconnus par leur suffixe. La détection est insensible à la casse ; le préfixe (nom du projet) n’a pas d’importance.
| Colonne | Suffixe attendu |
|---|---|
| RF Fr | _Manuel_de_reference.html |
| UG Fr | _Guide_Utilisateur.html |
| RF En | _Reference_Manual.html |
| UG En | _User_Guide.html |
Interrogation GitHub
DTLaudit interroge GitHub automatiquement si gh est installé et authentifié. Pour vérifier :
gh auth statusSi la réponse indiqué Logged in to github.com, DTLaudit collectera les métadonnées GitHub automatiquement. Pour désactiver :
DTLaudit.py --suite ..\outils --no-githubFormats de sortie
DTLaudit_rapport.html.--textContenu identique en texte brut. Fichier : DTLaudit_rapport.txt.--jsonExport structuré de toutes les données. Fichier : DTLaudit_rapport.json.--html auditsudit-2026-06-12.html.Questions fréquentes
DTLaudit modifie-t-il mes projets ?
Non. DTLaudit est strictement en lecture seule. Il écrit uniquement ses propres rapports dans son propre répertoire.
Pourquoi un projet n’apparaît-il pas dans le rapport ?
En mode suite, un sous-répertoire est inclus seulement s’il contient au moins un fichier .py, .ps1, .bat, .cmd, .vbs, ou un fichier README*, ou un répertoire .git. Les répertoires cachés (commençant par .) sont ignorés.
La colonne GitHub affiché Non alors que mon projet est sur GitHub
Vérifiez que gh est installé et authentifié (gh auth status), et que le projet possède bien un remote pointant vers GitHub (git remote -v). Si --no-github a été utilisé, GitHub n’a volontairement pas été interrogé.
Comment conserver un historique des audits ?
Spécifiez un nom de fichier daté à chaque exécution :
DTLaudit.py --suite ..\outils --html auditsudit-2026-06-12.html