Documenter un produit de données

Vous pouvez trouver deux types de documentation pour chacun de vos produits de données.

• La documentation générale qui récapitule votre produit de données, comme les jeux de données, l'actualisation des données, la qualité des données, etc.
• La section Lisez-moi, qui contient toutes les informations que le gestionnaire du produit de données souhaite partager sur le produit de données.

Vous pouvez également ajouter des contacts clés à vos produits de données et associer des glossaires métier pour rendre les définitions métier standardisées disponibles aux consommateurs.

Génération de la documentation générale d'un produit de données

Vous pouvez générer, consulter et télécharger la documentation d'un produit de données afin de rassembler toutes les informations le concernant dans un seul fichier, telles que la qualité des données, le nombre de jeux de données, la qualité de chaque jeu de données, les champs de chaque jeu de données, etc.

La génération de la documentation générale d'un produit de données peut également être effectuée via l'API publique Qlik correspondante.

Vous pouvez télécharger la documentation au format markdown (.md).

Lorsqu'un jeu de données du produit de données se trouve dans un espace auquel vous n'avez pas accès, vous pouvez tout de même générer et télécharger la documentation, mais le jeu de données et ses données ne seront pas inclus dans la documentation.

1. Ouvrez le produit de données à partir du menu Catalogue ou Produits de données.
2. À droite, cliquez sur  > Ouvrir la documentation. La fenêtre Documentation s'ouvre.
3. Pour télécharger au format MD, cliquez sur Télécharger.

   Vous pouvez également télécharger au format PDF à partir de votre navigateur. Cliquez-droit sur la documentation > Imprimer....

Modification de la section Lisez-moi

En tant que gestionnaire de produits de données, vous pouvez modifier la section Lisez-moi autant que nécessaire. Le format de texte enrichi vous permet de structurer la section pour la rendre aussi claire que possible.

1. Assurez-vous d'avoir les rôles ou autorisations suivants :
   • Le rôle Gestionnaire des produits de données ou l'autorisation Gérer les produits de données.
   • L'autorisation de modifier l'espace.
2. Ouvrez le produit de données à partir du menu Catalogue ou Produits de données.
3. Sélectionnez l'onglet Documentation.
4. Cliquez sur Modifier dans la section Lisez-moi.
5. Saisissez les informations et cliquez sur Enregistrer.

Vous pouvez également modifier la section Lisez-moi en cliquant sur  > Documentation à droite.

Ajout de contacts clés

Ajoutez des contacts clés pour spécifier les personnes que les consommateurs peuvent contacter pour toute question ou tout problème relatif/ve au produit de données.

1. Assurez-vous d'avoir les rôles ou autorisations suivants :
   • Le rôle Gestionnaire des produits de données ou l'autorisation Gérer les produits de données.
   • L'autorisation de modifier l'espace.
2. Ouvrez le produit de données à partir du menu Catalogue ou Produits de données.
3. Sélectionnez l'onglet Documentation.
4. Cliquez sur Modifier dans la section Contacts.
5. Saisissez les contacts clés et cliquez sur Enregistrer.

Vous pouvez également modifier les contacts clés en cliquant sur  > Documentation > Contacts clés à droite.

Affichage des glossaires métier associés

Les produits de données peuvent inclure des glossaires métier associés qui fournissent des définitions métier standardisées du contenu des produits de données. Les glossaires sont affichés dans l'onglet Documentation à côté de la section Lisez-moi et des contacts clés.

En tant que gestionnaire de produits de données

Vous pouvez afficher et gérer les glossaires associés :

1. Ouvrez le produit de données à partir du menu Catalogue ou Produits de données.
2. Sélectionnez l'onglet Documentation.
3. Faites défiler jusqu'à la section Glossaires pour voir les glossaires associés.
4. Cliquez sur Modifier pour ajouter, remplacer ou supprimer des glossaires. Pour des instructions détaillées, consultez Ajouter des glossaires métier à un produit de données.

En tant que consommateur de produits de données

Vous pouvez consulter les glossaires métier associés aux produits de données auxquels vous avez accès :

1. Ouvrez le produit de données à partir du Catalogue.
2. Sélectionnez l'onglet Documentation.
3. Consultez la section Glossaires pour afficher les définitions métier correspondant au produit de données.

Seuls les glossaires auxquels vous avez un accès en lecture sont affichés. Si vous ne voyez pas de glossaire dans l'onglet Documentation, contactez votre administrateur ou le gestionnaire du produit de données pour demander l'accès.