Le glossaire de Document360 est une collection unique à l’échelle du projet de termes définis que vous créez une seule fois et réutilisez dans tous les articles et pages de catégories. Les termes du glossaire apparaissent avec un soulignement pointillé dans votre contenu. Les lecteurs peuvent survoler n’importe quel terme pour en voir la définition sans avoir à s’éloigner de la page.
Par exemple, en ajoutant l’acronyme RGPD, vous pouvez le définir comme « Règlement général sur la protection des données », et le terme sera utilisé de manière cohérente dans tous les articles concernés. Document360 prend en charge un glossaire par projet. Tous les termes sont stockés de manière centralisée et disponibles dans tous les espaces de travail et langues de ce projet.
Les termes du glossaire sont disponibles à la fois dans la base de connaissances et dans le widget de la base de connaissances.
Pourquoi ajouter un glossaire à votre base de connaissances
- Meilleure lisibilité : Les termes du glossaire permettent aux lecteurs d’obtenir instantanément des définitions complexes sans quitter la page, réduisant ainsi la confusion et améliorant la compréhension.
- Régularité : Une fois qu’un terme est ajouté au glossaire, il peut être réutilisé dans plusieurs articles, garantissant ainsi une définition cohérente de la terminologie dans l’ensemble de votre base de connaissances.
- Gagner du temps pour les écrivains : Les rédacteurs techniques n’ont plus à définir des termes dans chaque article individuel, ce qui réduit la redondance et accélère la création de contenu.
- Éducation spécifique aux produits : Utilisez le glossaire pour définir des termes spécifiques au produit ou du jargon sectoriel, aidant ainsi les lecteurs à se familiariser avec votre terminologie et à approfondir leur compréhension de votre produit.
Ajouter des termes spécifiques à votre secteur à votre glossaire améliore également le SEO de votre base de connaissances. Les termes du glossaire augmentent la pertinence de votre documentation dans les résultats des moteurs de recherche en associant les définitions aux mots-clés.
La page du glossaire
Naviguez vers les outils de contenu () > ressources de contenu > Glossaire pour accéder et gérer vos termes de glossaire.
| Élément | Description |
|---|---|
| Utilisez Eddy AI pour la génération de glossaires | Utilise Eddy AI pour scanner votre contenu et suggérer automatiquement des termes de glossaire pour les mots-clés et les acronymes. |
| Créer | Crée un nouveau terme de glossaire. |
| Glossaire d’importation | Importe plusieurs termes de glossaire depuis un fichier CSV. |
| Langues | Filtre le glossaire par Global ou par langage spécifique. |
| Glossaire de recherche | Recherche un terme de glossaire par nom. |
| CSV à l’exportation | Les exportations sélectionnent des termes de glossaire sous forme de fichier CSV pour sauvegarde ou utilisation externe. |
| Aperçu | Cliquez sur un nom de terme de glossaire pour en prévisualiser le contenu. |
| Utilisé dans | Affiche un tiret si le terme n’est pas utilisé. Si utilisé, cliquez sur Voir pour voir la liste des articles et des pages de catégories où il est référencé, ainsi que l’espace de travail, la langue, le statut de l’article, la version, les détails du contributeur et la date de dernière mise à jour. |
| Langue | Affiche la langue assignée à chaque terme du glossaire. |
| Dernière modification | Affiche la date et l’heure de la dernière mise à jour du terme. |
Commencez avec le glossaire
Générateur de glossaires IA
Utilisez Eddy AI pour scanner automatiquement le contenu de votre base de connaissances et générer des suggestions de termes glossaires pour les mots-clés et les acronymes.
En savoir plus →Ajouter de nouveaux termes de glossaire
Créez des termes de glossaire individuellement ou importez plusieurs termes à la fois à partir d’un fichier CSV, avec des options de mise en forme pour les définitions.
En savoir plus →Gérer et traduire les termes du glossaire
Modifier, traduire, supprimer et exporter les termes du glossaire à travers votre projet et vos langues.
En savoir plus →Insérer le terme du glossaire dans l’article
Ajoutez des termes de glossaire à vos articles en utilisant deux méthodes dans l’éditeur Markdown ou la commande slash dans l’éditeur WYSIWYG avancé.
En savoir plus →Ajoutez le glossaire à votre site de base de connaissances
Faites apparaître le glossaire aux lecteurs en ajoutant un lien vers l’en-tête, le pied de page ou la navigation secondaire de votre site.
En savoir plus →Meilleures pratiques
- Définissez les termes au bon niveau de détail. Rédigez des définitions pour vos lecteurs les moins techniques. Si un terme est évident pour votre public, il n’a pas besoin d’une entrée dans le glossaire. Si cela risque de dérouter ne serait-ce qu’un seul lecteur, ajoutez-le.
- Utilisez le champ Nom comme identifiant stable. Gardez le champ Nom minuscule et sans espaces, par exemple
api_keyougdpr. Cela reste cohérent entre les langues même lorsque le texte visible du Term change selon la région. - Définissez la portée globale pour les termes qui ne sont pas traduits. Utilisez Global pour des termes tels que les noms de produits ou les acronymes identiques dans toutes les langues. Utilisez un champ d’application linguistique spécifique uniquement lorsque le terme diffère selon la localité.
- Vérifiez l’utilisation avant de supprimer. Supprimer un terme de glossaire supprime l’infobulle de tous les articles où il a été utilisé. Utilisez la Vue dans la colonne Utilisé dans pour vérifier l’impact avant de supprimer un terme largement utilisé.
- Utilisez Eddy AI pour semer votre glossaire. Pour un projet nouveau ou de grande envergure, utilisez le générateur de glossaires IA pour obtenir un premier ensemble de suggestions basées sur votre contenu existant, puis relisez et affinez chacune avant de publier.
FAQ
Que se passe-t-il si je supprime un terme de glossaire ?
Lorsqu’un terme de glossaire est supprimé, il est supprimé de tous les articles où il a été utilisé. Le terme ne sera plus utilisé comme une infobulle pour les lecteurs.
Puis-je importer plusieurs termes de glossaire en même temps ?
Oui. Utilisez l’option Importer le glossaire sur la page du glossaire pour importer en masse des termes depuis un fichier CSV. C’est utile pour les grands projets où plusieurs termes doivent être ajoutés rapidement.
Les termes du glossaire peuvent-ils être filtrés par langue ?
Oui. Utilisez le menu déroulant Langues sur la page du glossaire pour filtrer les termes par langue. Les termes marqués comme Global sont disponibles dans toutes les langues de votre base de connaissances.
Le glossaire change-t-il lorsque je change d’espace de travail ?
Non. Le glossaire est configuré au niveau du projet, pas au niveau de l’espace de travail. Tous les termes sont stockés dans un glossaire à l’échelle du projet et apparaissent sur l’ensemble du site de la base de connaissances. Passer d’un espace de travail à l’autre ne modifie pas le glossaire ni la configuration des autres outils de contenu.
Comment puis-je ajouter un terme de glossaire à mes articles ?
Naviguez vers outils de contenu () > ressources de contenu > glossaire et créez un nouveau terme. Une fois ajouté, le terme peut être inséré dans vos articles et les lecteurs peuvent survoler la définition pour en consulter la définition.