9 meilleurs outils de documentation de bases de données pour 2022

Lors de la gestion d’une base de données, générer de la documentation n’est pas toujours la première chose à laquelle tout le monde pense. De plus, rédiger une documentation détaillée sur vos bases de données n’est pas une mince affaire. Cependant, documenter le répertoire de données facilite l’accès aux informations importantes plus tard. Avoir un point de référence aidera toute personne ayant besoin d’interagir avec la base de données.

Tout le monde, des architectes de bases de données aux développeurs, en passant par les analystes commerciaux et les administrateurs, disposera d'une ressource détaillée pour vous aider à donner un sens à vos données.

En fin de compte, disposer d’une ressource sur laquelle s’appuyer signifie une productivité plus élevée dans l’ensemble de votre organisation, car les utilisateurs ont accès aux données dont ils ont besoin. L'utilisation d'un outil de documentation de base de données est un moyen très efficace de générer de la documentation.

Voici la liste des9 meilleurs outils de documentation de base de données :

1. ApexSQL Doc CHOIX DE L'ÉDITEURUn outil de documentation de base de données pour SQL, MySQL, SSIS, SSAS, SSRS et Tableau. Disponible en versions Développeur et DBA.
2. Document SQL RedGateDocumente automatiquement les bases de données. Fait partie de la ceinture d'outils RedGate SQL.
3. Documentateur dbForgeDocumentation automatisée pour MySQL et MariaDB. Compatible avec les services de base de données cloud.
4. DataedoCouvrant une longue liste de systèmes de gestion de bases de données, cet outil inclut la création d'ERD et le suivi des modifications.
5. DBScribeOutil de documentation de base de données basé sur DDL pour MySQL.
6. SentryOne DOC xPressUn assistant de documentation pour SQL Server. Achetez le logiciel directement ou choisissez un abonnement annuel.
7. Innovasys Document XOutil de documentation de base de données pour les bases de données Oracle, SQL Server, OLE DB et Access.
8. Preneur de notes de base de donnéesVise à prendre en charge les processus de conception, de création et de maintenance de bases de données.
9. Décrypteur de code source GenesisOne T-SQLUn générateur de code pour permettre la création automatique de scripts pour répliquer ou restaurer une base de données.

Les meilleurs outils de documentation de bases de données

La plupart des outils répertoriés ci-dessous utilisent l'automatisation pour rendre le processus de création de documents plus efficace afin que vous passiez moins de temps à effectuer des tâches manuelles et plus de temps à gérer réellement votre base de données.

Notre méthodologie de sélection d'un outil de documentation de base de données

Nous avons examiné le marché des solutions de documentation de bases de données et analysé les outils en fonction des critères suivants :

• Compatibilité avec une longue liste de SGBD
• Processus d'analyse d'objets automatisés
• Création d'un dictionnaire de données
• Représentation du DER
• Nouvelle analyse planifiée ou automatisée des mises à jour
• Un essai gratuit ou une version démo pour un exercice d'évaluation sans risque
• Rapport qualité/prix, représenté par un prix juste pour les fonctions proposées

En gardant ces critères de sélection à l’esprit, nous avons dressé une liste restreinte de systèmes de documentation de bases de données intéressants qui améliorent la productivité des administrateurs de bases de données et créent un magasin de documents de conception de bases de données.

1. Document ApexSQL

ApexSQLest un outil de documentation de base de données pourSQL,MySQL,SSIS,SSAS,SSRS, etImage. L'utilisateur peutcréer des descriptions personnaliséespour les objets SQL via l'interface graphique. Les mises en page des documents peuvent être personnalisées, donnant aux utilisateurs un contrôle total sur la structure de leur documentation.

Principales caractéristiques

• Fonctionne avec SQL Server, MySQL, SSIS, SSAS, SSRS et Tableau
• Choix des formats de fichiers de documents
• Versions pour développeurs et administrateurs de bases de données
• Comprend un utilitaire de sauvegarde de base de données
• Fournit un analyseur de requêtes SQL

AutomatisationetPlanificationpermettre aux utilisateurs d'extraire régulièrement un dictionnaire de données et de créer des documents sans aucune saisie manuelle.ApexSQLgénère des documents dansCHM,HTML,PDF,DOCUMENT, etDOCXafin que la documentation puisse être livrée dans le format de votre choix.

Avantages:

• Prend en charge de nombreuses bases de données et permet des descriptions personnalisées
• Permet aux utilisateurs d'utiliser des modèles ou de concevoir leur documentation à partir de zéro
• Prend en charge les options d'automatisation et de planification pour rationaliser le processus de documentation
• Peut produire et enregistrer des documents dans différents formats
• Est l'un des produits de documentation les plus faciles à utiliser

Les inconvénients:

• Offre de nombreuses options personnalisables différentes qui peuvent prendre du temps à explorer pleinement

Il existe deux forfaits principaux disponibles à l'achat :DéveloppeuretAdministrateur de base de données. La version Developer est livrée avec 20 outils, dont ApexSQL Analyze, ApexSQL Build, ApexSQL Doc, ApexSQL Script et coûte 1 299 $ (1 003 £).

La version DBA est livrée avec 10 outils tels qu'ApexSQL Audit, ApexSQL Backup, ApexSQL Manage et coûte 2 499 $ (1 930 £) par instance. Tu peux inscrivez-vous et téléchargez l'essai gratuit version.

LE CHOIX DES ÉDITEURS

Document ApexSQLest notre premier choix pour un outil de documentation de base de données car il permet l'extraction automatisée et planifiée de dictionnaires de données pour les bases de données, ce qui signifie que votre documentation peut être régulièrement mise à jour via des processus automatisés lorsque la base de données est disponible mais non utilisée. La documentation peut être implémentée aux formats CHM, HTML, PDF, DOC et DOCX, ce qui vous donne la possibilité de créer des bases de connaissances, des présentations et des bibliothèques d'entreprise en ligne sans avoir à répéter des étapes manuelles. La possibilité de créer des modèles améliore le processus d'automatisation de la documentation.

Télécharger: Obtenez un essai gratuit de 30 jours

Site officiel: https://www.apexsql.com

TOI:Windows et Windows Serveur

2. Document SQL RedGate

Document SQL RedGateest unsolution de documentation pour SQLqui documente automatiquement les bases de données. L'utilisateur peut obtenir un aperçu d'unschéma de base de données,dépendances inter-objets,dépendances inter-bases de données, avecannotationspour aider les utilisateurs à trouver ce dont ils ont besoin. Vous pouvez documenter les bases de données dans SSMS en cliquant avec le bouton droit sur l'explorateur d'objets.

Principales caractéristiques

• Analyse automatisée de la base de données pour la documentation
• Choix des formats de fichiers de sortie
• Explorateur d'objets en direct
• Choix des niveaux de documentation

L'outil est compatible avecHTML,PDF,Microsoft Word, etRéductiondes dossiers. Pour ajouter une touche personnelle, les entreprises peuvent générer une documentation personnalisée avec leur propre marque.

Avantages:

• Peut facilement visualiser les interdépendances et le schéma à partir d'une seule vue
• Cartographie et documente automatiquement les bases de données
• L'explorateur d'objets en direct fonctionne bien même avec des bases de données plus complexes

Les inconvénients:

• J'aimerais voir plus d'options pour la visualisation de la base de données

Document SQL RedGateest disponible dans le cadre duCeinture d'outils RedGate SQL. Le prix dépend du nombre d'utilisateurs que vous devez prendre en charge. Entre un et quatre utilisateurs, le prix est de 385 $ (297,41 £) par utilisateur.

Pour les organisations comptant cinq à neuf utilisateurs, le prix tombe à 327 $ (252,61 £) et à 308 $ (237,93 £) pour les organisations comptant plus de 10 utilisateurs. Tu peux téléchargez un essai gratuit de 14 jours .

Article similaire: Solutions logicielles de documentation informatique

3. Documenteur dbForge

Documentateur dbForgeest unoutil de création de documents pour MySQLetMariaDBqui crée automatiquement la documentation de la base de données MySQL. DétailsDocumentateur dbForgeles extraits des bases de données incluenttypes d'objets,propriétés,dépendances inter-objets, etCodes DDL. Une fois les données extraites de la base de données, elles peuvent être présentées commeHTML,PDFetRÉDUCTIONdes dossiers.

Principales caractéristiques

• Fonctionne avec MySQL et MariaDB
• Compatible avec les plateformes cloud
• Sortie consultable

L'outil est facile à utiliser et hautement personnalisable. Par exemple, l'utilisateur peut choisir entre une gamme de thèmes etpersonnaliser la mise en page de documents individuels. Toute la documentation est consultable afin que l'utilisateur puisse naviguer facilement. Par exemple, lorsque vous saisissez un objet dans le champ de recherche, l'interface utilisateur mettra en surbrillance tout texte correspondant.

Avantages:

• Permet de créer très facilement une documentation personnalisée
• Extrait automatiquement les propriétés et les dépendances de la base de données
• Le volet d'aperçu facilite la recherche dans différentes colonnes, index, etc.

Les inconvénients:

• Plus adapté à MySQL et MariaDB
• J'aimerais voir plus d'options d'exportation

Documentateur dbForgeest une solution très conviviale et à un prix compétitif. L'édition Standard coûte 99,95 $ (77,21 £) par licence. Le logiciel est également compatible avecAmazon RDS,Google Cloud,Amazone Aurore,Oracle,MySQL-Cloud, etAlibaba Nuage. Tu peux téléchargez l'essai gratuit .

Voir également: Outils de diagramme de base de données

4. Données

Dataedoest un outil avancé de documentation de base de données capable de créer des fichiers HTML, PDF et Excel. Dataedo prend en charge des bases de données commeserveur SQL,MySQL,Oracle,PostgreSQL,MariaDB,IBM DB2,AzureSQL,Amazon RDS,Amazone Aurore,Google Cloud SQL,Percona MySQL,Entrepôt de données Azure SQL,Amazon Redshift, et plus.

Principales caractéristiques

• Compatible avec une longue liste de SGBD
• Sortie au format Excel, PDF ou HTML
• Crée des ERD

Pour créer de la documentation, vous pouvezajouter une description des objets de la base de données,les tables, etColonnesaudictionnaire de données. La visualisation du modèle de données facilite la compréhension du fonctionnement de votre base de donnéesDiagrammes ER.

Vous pouvez créer Diagrammes ER par glisser-déposer des tableaux depuis votre plateforme de base de données vers la section ERD. Il existe également la possibilité de créer des bases de données multi-bases de données et multi-plateformes pour unifier la gestion des données.

Avantages:

• Offre une excellente représentation visuelle des dépendances et des flux de travail de la base de données
• Prend en charge un large éventail de bases de données telles que Google Cloud SQL, Azure SQL et Amazon Aurora
• Prend en charge l'organisation par glisser-déposer

Les inconvénients:

• Offre de nombreuses fonctionnalités dont la mise en œuvre complète peut prendre du temps

Il existe trois versions deDataedodisponible à l'achat :Pro,Pro+, etEntreprise. La version Pro coûte 39 $ (30,11 £) par utilisateur et par mois avec une assistance par courrier électronique standard et cinq champs personnalisés. La version Pro+ coûte 79 $ (60,99 £) par utilisateur et par mois avec 10 champs personnalisés et une assistance prioritaire.

La version Enterprise coûte 159 $ (122,74 £) par utilisateur et par mois pour 100 champs personnalisés avec des fonctionnalités supplémentaires telles queSuivi des modifications de schémaetGlossaire des affaires. Tu peux téléchargez l'essai gratuit .

Article similaire: Meilleurs outils de surveillance PostgreSQL

5. DBScripte

DBScribeest unoutil de documentation de base de donnéespour SQL Server qui prend en charge des formats tels queHTML,Format d'aide Microsoft HTML, etMicrosoft Word. Le programme utiliseCode DDL/XMLApour documenter votre base de données. Vous pouvez interagir avec l'outil via un assistant et une interface de ligne de commande, ce qui permet d'accélérer le processus de création de documentation.

Principales caractéristiques

• Écrit pour SQL Server
• Sorties au format XMLA
• Modèles de présentation

Il y a aussimodèles personnalisablesvous pouvez utiliser pourconstruire des documents professionnelsà partager avec les autres membres de votre équipe. Vous pouvez mêmeenregistrer des profils personnalisésà utiliser pour de futurs documents. Ces fonctionnalités vous donnent un haut degré de contrôle sur la façon dont votre documentation est présentée.

Lorsqu'il s'agit de gérer des tables,DBSribedispose d'un éditeur de description. L'éditeur de description permet de gérer des éléments tels queles tables,Colonnes,index,déclencheurs,clés, et bien plus encore, à partir d'un seul endroit.

Avantages:

• Une excellente option pour les petites équipes de développement
• Des modèles simples et personnalisables facilitent le démarrage
• Conçu spécifiquement pour le serveur SQL

Les inconvénients:

• Manque de fonctionnalités de visualisation
• J’aimerais voir des formats d’exportation plus modernes

Si vous recherchez un outil facile à utiliser et à un prix compétitif, alorsDBScribecoche toutes les cases. DBScribe 1.4 pour SQL Server coûte 99 $ (76,44 £) par licence. Il existe d'autres versions deDBScribedisponible pour Oracle, MySQL, PostgreSQL et DB2. Il y a aussi 30 jours d'essai gratuit .

6. SentryOne DOC xPress

SentryOne DOC xPressest un outil de documentation pour les bases de données. AvecSentryOne DOC xPresstu peuxdocumenter automatiquement les bases de donnéespour SQL Server dans une variété de formats, notammentSSAS,SSIS,SSRS,Exceller, et plus.

Principales caractéristiques

• Documente les bases de données SQL Server
• Fonctionne avec les métadonnées de la base de données
• Etudes d'impact des changements d'objet

L'outil aussianalyse automatiquement les métadonnées de la base de donnéespour mettre à jour les documents sans aucune intervention manuelle de l'utilisateur. Pour faciliter la gestion des bases de données et la conformité réglementaire, il existe unfonctionnalité d'analyse du lignage des données. Cette fonctionnalité vous permet de voir comment les modifications apportées à un seul objet affecteront le reste de la base de données. Vous pouvez aussivisualiser les dépendances des donnéespour donner un sens à ce qui se passe. Tu peuxcréer des dictionnairesavecannotationspour aider à surveiller les modifications des données.

Avantages:

• Organise et extrait automatiquement les métriques et les métadonnées de la base de données
• Prend en charge la visualisation des dépendances des données
• Permet aux utilisateurs de voir l'impact des modifications d'objet sur le flux de travail et la base de données dans son ensemble

Les inconvénients:

• J'aimerais voir une durée d'essai plus longue

Deux options de tarification sont disponibles pourSentryOne DOC xPress: Licence d'abonnement annuel et licence d'entreprise. La licence d'abonnement annuel coûte 749 $ (578,50 £) par mois pour un maximum de 10 sources de données. Le package Enterprise Licensing est personnalisé selon les besoins de votre entreprise. Tu peux téléchargez l'essai gratuit de deux semaines .

7. Document Innovasys ! X

Document Innovasys! Xest un outil de documentation de base de données pourOracle,serveur SQL,PAS de base de données, etAccéder bases de données. Vous pouvez utiliser l'outil pour documenter les tables de base de données, les colonnes, les vues, les relations, les index, les dépendances, les déclencheurs, les rôles, les utilisateurs, etc.

Principales caractéristiques

• Fonctionne sur les bases de données Oracle, OLE DB et SQL Server
• Structure de bibliothèque de documents adaptable
• Prise en charge des notes du manuel

Il y a unmodèle HTML personnalisableque vous pouvez utiliser pour choisir la façon dont votre documentation est organisée. Pour plus de commodité, vous pouvez ajouter des hyperliens vers des sites Web externes pour faciliter la description des éléments.

Interagir avec le dictionnaire de données dansDocument Innovasys! Xest extrêmement simple. En fait, si vous avez utiliséSQL,T-SQLouPL-SQL, les commentaires du code source, ceux-ci seront automatiquement utilisés dans votre documentation. Pour faciliter la lecture et la navigation, le code source est colorisé.

Alternativement, vous pouvez utiliser leÉditeur de fichiers de contenupour créer et gérer des documents si vous préférez. Saisissez les descriptions avecOutils de gestion de serveur SQLouConcepteur de tables d'accèspour ajouter des descriptions pour des éléments tels que des tables et des index.

Avantages:

• Comprend un dictionnaire de données très intuitif qui remplit automatiquement les informations de la base de données
• Prend en charge les méthodes de documentation automatisées et manuelles
• Utilise bien la couleur pour garder le code source organisé et lisible à grande échelle

Les inconvénients:

• J'aimerais voir un tableau de bord plus simplifié

Document Innovasys! Xest disponible sous forme de produit unique ou sous forme de package avec HelpStudio 2019.1 appelé Document ! X et Help Studio Bundle 2019.1 Innovasys coûte 482 $ (379 £) pour une licence d'abonnement ou 380 $ (299 £) pour une licence. La version groupée coûte 698 $ (549 £) pour une licence d'abonnement ou 571 $ (449 £) pour une licence. Tu peux téléchargez l'essai gratuit .

8. Preneur de notes de base de données

Preneur de notes de base de donnéesest unoutil de documentation de base de donnéesqui simplifie la gestion des bases de données pour une gamme de bases de données, notamment Microsoft SQL Server. Vous pouvez créer un nouveau projet dans le programme et sélectionner le type de base de données à partir de laquelle vous souhaitez importer des données de schéma. Vous pouvez ensuite gérer vos objets de base de données via leExplorateur d'objets.

Principales caractéristiques

• Facilite l'annotation des objets de base de données
• Met en valeur les objets non documentés
• Sortie en XML ou HTML

LeExplorateur d'objetsmet en évidence les objets de base de données qui ne sont pas pris en charge avec la documentation. Par exemple, il existe unicône d'avertissement rougeà côté des composants du tableau qui nécessitent une documentation supplémentaire. Vous pouvez ensuite cliquer sur l'objet pour modifier les informations. Une fois que vous avez terminé de modifier, vous pouvez le publier dansXMLouHTMLformat.

Pour aider les entreprises à collaborer sur les modifications des bases de données,Preneur de notes de base de donnéesa un suivi de l'historique. Le suivi de l'historique vous permet de savoir qui a interagi avec la documentation et quand. La fonction de suivi vous permet de rester au courant des modifications et des modifications.

Avantages:

• Un outil très simple, mieux adapté aux petites bases de données
• Utilise bien la couleur pour mettre en évidence les problèmes et les objets qui ne sont pas pris en charge pour la documentation
• Propose un audit pour voir qui a apporté des modifications aux notes et à la base de données au fil du temps

Les inconvénients:

• Manque de fonctionnalités d'entreprise pour les environnements de bases de données plus complexes

L'un des plus grands avantages dePreneur de notes de base de donnéesc’est qu’il est disponible gratuitement pour un usage personnel et commercial. Vous pouvez télécharger le programme pour gratuit pour évaluation .

9. Décrypteur de code source GenesisOne T-SQL

Décrypteur de code source GenesisOne T-SQLest un outil de documentation de base de données qui génère automatiquement la documentation du code pour votre base de données. Vous pouvez interagir avec votre base de données via l'éditeur de description de table, puisgénérer de la documentationdansPDF,PNG, etSVGformats de fichiers.

Principales caractéristiques

• Affiche les objets de la base de données et les documente
• Dessine des relations
• Sortie au format PDF, SVG ou PNG

Il existe également plusieurs fonctionnalités qui facilitent la navigation dans GenesisOne . Liens hypertextes intégrés vous permettent de vous déplacer entre les éléments de la base de données et il existe la possibilité de imprimer automatiquement la documentation après des changements. Si vous avez besoin d'une expérience plus visuelle, la perspective graphique des relations entre objets contribue à améliorer la clarté.

Pour les entreprises à la recherche d'un outil de documentation de base de données que les utilisateurs techniques et non techniques peuvent gérer, ne cherchez pas plus loin queDécrypteur de code source Genesis One T-SQl.

Avantages:

• Produit automatiquement une documentation basée sur vos bases de données
• Prend en charge les exportations de types de fichiers de documents ainsi que le format d'image
• Offre une expérience plus visuelle que des outils similaires

Les inconvénients:

• Mieux adapté aux équipes de développement de petite et moyenne taille

Il existe deux versions deDécrypteur de code source GenesisOne T-SQLdisponible à l'achat : abonnement d'un mois et Premium. La version avec abonnement d'un mois coûte 29,95 $ (23,14 £) par mois. La version Premium coûte 195 $ (150,65 £) et 49,95 $ (38,59 £) pour chaque serveur supplémentaire. Il y a aussi version d'essai gratuite .

FAQ sur la documentation des bases de données

Quelles sont les meilleures pratiques en matière de documentation de base de données ?

Il n’existe aucune norme industrielle pour documenter une base de données. Voici cependant quelques conseils de bon sens :

1. Concentrez-vous sur votre public – la documentation doit refléter le niveau d'expertise des utilisateurs prévus.
2. Ne vous contentez pas de reproduire le dictionnaire de données – un administrateur de base de données ou un développeur chevronné peut interroger les tables système pour cela.
3. Créer plusieurs visualisations – un ERD est plus facile à comprendre que des listes sèches de texte.
4. Documentation des couches – documenter l’aspect physique de la mise en œuvre de la base de données, l’ERD, puis l’accès des applications aux objets.
5. Créer un ensemble de normes de documentation – définir une convention de dénomination, créer un glossaire de termes et mettre en place une hiérarchie de documents avec des modèles incluant des titres standardisés pour chaque document.

Pouvez-vous recommander des modèles de documentation de base de données ?

Le moyen le plus simple d’acquérir des modèles de documentation, et donc une structure de document, consiste à utiliser un outil de documentation de base de données recommandé. Une fois le dictionnaire de données enregistré dans l'outil, les rapports peuvent être extraits dans n'importe quel format pour créer une bibliothèque de documentation, ou vous pouvez simplement donner aux parties intéressées un « accès en visualisation » à l'outil de documentation. Essayez les outils suivants :

1. Document ApexSQL
2. Document SQL RedGate
3. Documentateur dbForge

Est-il difficile de documenter une base de données Oracle ?

Il est possible d'extraire le dictionnaire de données directement d'une base de données Oracle avec quelques instructions SELECT. Ainsi, la création manuelle de documentation pour une base de données Oracle est très simple. Le seul problème que vous rencontrerez est de savoir comment présenter et stocker ces informations sans simplement dupliquer les données constamment disponibles dans la base de données.