Plans supporting content reuse
| Professional | Business | Enterprise |
|---|---|---|
Vous pouvez réutiliser des variables lorsque vous utilisez le même contenu textuel à plusieurs endroits qui peuvent changer au fil du temps (tels que les noms de champs, les numéros de contact, les adresses, les clauses de non-responsabilité, etc.). Une variable dans Document360 est un élément réutilisable qui permet de maintenir la cohérence et l’efficacité entre les différentes sections de la documentation. En utilisant des variables, les contributeurs à vos articles peuvent facilement mettre à jour les informations en un seul endroit, et celles-ci se reflètent automatiquement dans l’ensemble de la documentation, garantissant ainsi l’exactitude et réduisant les efforts redondants.
Par exemple, vous souhaitez ajouter vos informations de contact à plusieurs reprises, qui peuvent changer au fil du temps. Dans ce cas, vous pouvez ajouter une variable pour les informations de contact. Si une modification est requise, vous pouvez mettre à jour la variable seule au lieu de la mettre à jour dans tous les cas.
(Contact : +1 897564231/support@serverless.com)
Création d’une variable
Pour créer une variable, procédez comme suit :
Accédez à Documentation () > Content tools > Réutilisation du contenu > Variables dans le portail de la base de connaissances.
La page Variables s’affiche. Si vous avez ajouté des variables auparavant, vous pouvez les voir répertoriées ici.
Cliquez sur Créer une variable en haut pour sélectionner les variables spécifiques à la langue (Global, anglais, français, etc.) ajoutées à votre projet.
Entrez le nom de votre variable.
NOTE
Le nom de la variable peut inclure des lettres, des chiffres, des traits d’union et des traits de soulignement, avec une longueur maximale de 30 caractères.
La valeur du code de fusion sera le nom de la variable qui apparaît avec la balise de variable dans votre éditeur.
Par exemple, si le nom de votre variable est Disclaimer, la valeur de votre code de fusion sera {{variable. Avis de non-responsabilité}}.
Dans la liste déroulante Sélection de la langue , la sélection par défaut est Globale (disponible dans toutes les langues). Toutefois, si nécessaire, vous pouvez choisir une langue disponible souhaitée pour créer une variable spécifique à la langue.
Dans le champ Contenu , entrez le contenu de la variable.
NOTE
La limite de caractères du contenu variable est de 100 caractères avec espaces. Si vous souhaitez ajouter des textes, des expressions, des médias, des tableaux ou des blocs de code plus longs, utilisez des extraits. Pour plus d’informations, consultez l’article sur Snippet.
Options de formatage
Utilisez les options de mise en forme de texte suivantes pour styliser votre contenu variable
un. Mise en forme de base du texte :
• Audacieux
• Italique
• Barré
• Souligner
• Taille de la police (8 à 36)
b. Mise en forme supplémentaire :
Cliquez sur l’icône Plus de texte pour accéder à :
• Famille de polices (choisissez dans la liste des polices)
• Couleur du texte (sélecteur de couleurs ou code HEX)
• Couleur d’arrière-plan (sélecteur de couleurs ou code HEX)
• Indice
• Exposant
• Mise en forme claire
c. Insérer un lien - Pour ajouter un lien hypertexte.
Cliquez sur l’icône Insérer un lien .
Saisissez l’URL et ajoutez du texte au lien.
Si nécessaire, sélectionnez Ouvrir dans un nouvel onglet.
Cliquez sur Insérer.
Cliquez sur le bouton Créer une variable .
La variable nouvellement créée apparaîtra sur la page Variables , où elle peut être modifiée ou supprimée selon les besoins.
Utilisation d’une variable dans une page d’article/catégorie
Vous pouvez ajouter une variable à votre page d’article/catégorie en utilisant deux méthodes.
Méthode 1 : Utilisation de la syntaxe (éditeur Markdown)
Dans l’éditeur Markdown, tapez une variable. MergeCodeValue entre accolades doubles fermées.
Exemple : {{variable. Avis de non-responsabilité}}
Vous devez connaître la valeur exacte du code de fusion pour ajouter la variable souhaitée. La variable ne fonctionnera pas même si une seule lettre change.
NOTE
Saisie de la variable. Merge_Code_Value ne fonctionnera que dans l’éditeur Markdown. Si vous utilisez Advanced WYSIWYG editor, vous pouvez insérer une variable à l’aide de la barre d’outils.
Méthode 2 : à partir de la barre d’outils (Markdown, WYSIWYG et WYSIWYG avancé)
Cliquez sur l’icône Réutilisation du contenu () pour l’éditeur Markdown et WYSIWYG.
(ou)
Dans l’éditeur WYSIWYG avancé, cliquez sur Insérer > variables ou utilisez la barre oblique « / » pour accéder aux variables.Sélectionnez la variable ou utilisez la barre Rechercher des variables pour affiner le nom de la variable.
Dans l’éditeur WYSIWYG avancé, le volet Variables s’affiche à droite pour la sélection des variables. Placez le pointeur sur le nom de la variable pour prévisualiser son contenu.
Sélectionnez la variable à insérer.
NOTE
Dans l’éditeur Markdown et WYSIWYG, vous pouvez sélectionner plusieurs variables en une seule fois.
Page de présentation des variables
Vous pouvez afficher, modifier ou supprimer une variable sur la page Variables .
Accédez à Documentation () > Outils de contenu > Réutilisation du contenu > Variables dans le portail de la base de connaissances.
La page Variables s’affiche et vous permet de trouver la liste des variables que vous avez déjà ajoutées.
Langues : pour filtrer les variables dans Global ou dans une langue spécifique.
Variable de recherche : recherche dans la liste des variables en fonction du nom.
Utilisé dans : Si aucune variable n’est ajoutée à une page d’article/catégorie, le statut est
-. Si une variable est ajoutée à une page d’article/catégorie, vous pouvez cliquer sur le bouton Afficher pour voir la liste des pages d’articles/catégories contenant la variable.Langue : La langue souhaitée de chaque variable.
Dernière modification : la dernière fois que le contenu de la variable a été mis à jour.
Aperçu : cliquez sur le nom de la variable et vous pouvez afficher le contenu de la variable.
Progression : cliquez sur l’icône en forme de globe pour afficher la progression de la variable dans plusieurs langues.
Icône Modifier () : pour modifier le contenu de la variable.
Icône Supprimer () : pour supprimer la variable.
Afficher la dépendance de la page article/catégorie
Dans la page Variables , vous pouvez trouver la colonne Utilisé dans .
Dans la colonne Utilisé en , cliquez sur le bouton Afficher .
Le panneau Afficher les références apparaîtra, où vous pourrez afficher la liste des pages d’articles/catégories auxquelles la variable a été ajoutée.
Cliquez sur l’article pour agrandir la section.
Vous pouvez trouver les informations suivantes :
La version de l’article.
L’espace de travail et la langue du projet.
Le nom du compte d’équipe et la photo de profil qui a ajouté la variable.
L’article indique (Publié, Brouillon, Nouvel article).
Les informations d’heure/date lorsque la variable a été insérée dans la page de l’article/de la catégorie.
Modifier une variable existante
Accédez à Documentation () > Outils de contenu > Réutilisation du contenu > Variables dans le portail de la base de connaissances.
La page Variables s’affiche. Vous pouvez trouver la liste des variables que vous avez déjà ajoutées.
Passez la souris sur la variable souhaitée et cliquez sur l’icône Modifier ().
Vous pouvez modifier le contenu de la variable. Le nom et la valeur du code de fusion ne peuvent pas être modifiés.
NOTE
Modifier un lien ajouté dans une variable
Cliquez sur le lien et vous trouverez les options suivantes :
Ouvrir le lien () : Le lien s’ouvrira dans l’onglet. Cela permet de vérifier le lien.
Style () : Le style a deux options.
Vert : pour changer la couleur du texte du lien en vert.
Épais : pour augmenter l’épaisseur du texte du lien.
Modifier () : Pour modifier l’URL, le texte du lien et modifier l’option ouvrir dans le nouvel onglet.
Dissocier () : Pour dissocier l’URL et la remplacer par du texte standard. L’URL sera dissociée et seul le texte de l’URL apparaîtra.
Une fois que vous avez terminé la modification du contenu, cliquez sur le bouton Mettre à jour .
NOTE
Lorsque vous modifiez le contenu d’une variable existante dans la bibliothèque, la modification de contenu sera répercutée dans tous les articles/pages de catégories contenant la variable respective.
Suppression d’une variable
Accédez à Documentation () > Outils de contenu > Réutilisation du contenu > Variables dans le portail de la base de connaissances.
La page Variables s’affiche. Vous pouvez trouver la liste des variables que vous avez déjà ajoutées.
Passez la souris sur la variable souhaitée et cliquez sur l’icône Supprimer ().
Cliquez sur Oui dans l’invite de confirmation.
Pour supprimer en bloc plusieurs variables
Sélectionnez plusieurs variables prévues dans la page Variables et cliquez sur l’option Supprimer en haut de la liste.
Traduction de variables
Vous pouvez créer et gérer des variables dans plusieurs langues. Cela garantit que lorsque vos articles sont traduits, les variables correspondent à la langue de l’article, offrant ainsi une expérience utilisateur cohérente et localisée.
Traduction de nouvelles variables
Accédez à la documentation () > Outils de contenu > Réutilisation du contenu > Variables dans le portail de la base de connaissances.
Cliquez sur Créer une variable.
Dans la liste déroulante Langue , sélectionnez la langue souhaitée (sauf globale).
Entrez le nom de la variable et le contenu de la variable en anglais (ou dans votre langue par défaut).
Pour traduire le contenu dans d’autres langues, cliquez sur le menu déroulant Traduire dans d’autres langues .
Sélectionnez la ou les langues souhaitées dans le menu déroulant et cliquez sur Traduire.
NOTE
La langue par défaut sera marquée comme Main.
Les langues traduites seront indiquées par une coche verte pour indiquer que la traduction est terminée. Si nécessaire, vous pouvez accéder aux langues non traduites et terminer leur traduction.
Une fois les traductions terminées, cliquez sur Créer une variable pour enregistrer la variable avec ses traductions.
Par exemple, si vous créez une variable pour un message de bienvenue en anglais, vous pouvez utiliser la fonction de traduction pour ajouter le même message en français, espagnol, allemand, etc.
Traduction de variables existantes
NOTE
Les variables globales ne peuvent pas être traduites.
Cliquez sur la variable existante que vous souhaitez traduire.
Accédez à Traduire dans d’autres langues et sélectionnez la langue souhaitée pour la traduction de la variable.
Cliquez sur Traduire.
Si nécessaire, vous pouvez naviguer vers d’autres langues et les traduire.
Pour retraduire le contenu, cliquez à nouveau sur Traduire, ce qui remplacera la traduction existante par la nouvelle.
Si vous devez supprimer la variable traduite pour une langue spécifique, cliquez sur Supprimer la langue.
Vous pouvez retraduire le contenu à tout moment si nécessaire.
Foire aux questions
Comment fonctionnent les variables ?
Les variables vous permettent de définir des éléments de contenu spécifiques, tels que des noms de produits ou des numéros de version, à un seul endroit. La mise à jour de la variable reflète automatiquement le changement dans toutes les sections pertinentes lorsque ce contenu change, ce qui garantit l’uniformité.
Quel est l’avantage d’utiliser des variables dans ma documentation ?
En utilisant des variables, vous assurez la cohérence de votre documentation tout en minimisant le besoin de mises à jour manuelles. Cela permet de gagner du temps, de réduire les erreurs et de maintenir l’exactitude, en particulier lorsqu’il s’agit d’informations qui changent fréquemment.
Puis-je créer mes variables dans Document360 ?
Document360 vous permet de créer des variables personnalisées adaptées à vos besoins en matière de documentation. Cela vous permet d’adapter la fonctionnalité à la terminologie spécifique et aux éléments pertinents pour votre contenu.
Comment utiliser les variables dans mes articles ?
Insérez la variable dans le contenu de l’article à l’aide de la barre d’outils de l’éditeur ou de la valeur du code de fusion, et elle extraira dynamiquement les informations que vous avez définies, garantissant ainsi l’uniformité de votre documentation.
Les variables peuvent-elles être mises à jour sur plusieurs articles à la fois ?
Lorsque vous mettez à jour une variable, la modification est automatiquement répercutée dans toutes les instances où cette variable est utilisée, ce qui facilite le maintien d’informations cohérentes dans l’ensemble de votre base de connaissances.
Les variables sont-elles limitées à des types de contenu spécifiques ?
Oui, les variables peuvent être utilisées pour du contenu textuel, numérique ou basé sur des liens, qu’il s’agisse de noms de produits, de numéros de version, d’URL ou d’informations de contact.
Comment les variables améliorent-elles la collaboration entre les membres de l’équipe ?
Les variables simplifient le processus de collaboration en garantissant que tout le monde utilise les mêmes informations précises. Les modifications apportées à une variable sont instantanément mises à jour dans tous les articles, ce qui permet d’éviter les divergences.
L’utilisation des variables est-elle une bonne pratique en matière de documentation technique ?
L’utilisation de variables est une bonne pratique qui améliore l’efficacité, la cohérence et la précision de la documentation technique. Il est particulièrement utile lorsque vous travaillez avec des informations dynamiques qui nécessitent des mises à jour fréquentes.
Puis-je traduire des variables dans n’importe quelle langue ?
Vous pouvez traduire des variables dans n’importe quelle langue de votre projet.
La définition d’un terme variable créé dans le site de la base de connaissances est-elle indexée dans les recherches et par Google ?
Oui, la définition d’un terme variable créée dans le site de la base de connaissances est indexée à la fois dans la recherche du site et par Google. Une fois le terme ajouté, il devient consultable sur le site Web et sera également exploré et indexé par Google.