Cet article traite de la gestion des Step by step guideétape : les traduire dans d'autres langues, les cloner dans les espaces de travail, déséditer lorsque nécessaire, et exporter pour un usage hors ligne.
Quand utiliser chaque action
Action | Utilise quand... |
|---|---|
Traduire | Votre base de connaissances sert des lecteurs dans plusieurs langues, et vous voulez que le guide soit disponible dans leur langue de travail |
Clone | Il vous faut un guide presque identique pour un autre niveau, région ou espace de travail différent, plus rapide que de réenregistrer à partir de zéro |
Déséditer | Un guide traite d'une fonctionnalité qui a beaucoup changé, est temporairement indisponible ou a été publiée avant d'être prête |
Export en PDF | Un lecteur ou une équipe interne a besoin d'une version hors ligne ou imprimable du guide |
Traduction de guides étape par étape
Après la création d'un guide étape par étape dans la langue de l'espace de travail par défaut, il peut être traduit dans n'importe quelle langue secondaire activée. Maintenir les traductions à jour garantit que tous les utilisateurs, quelle que soit leur langue, ont accès à une documentation précise et cohérente.
Il existe trois méthodes permettant d'initier la traduction :
Méthode 1 : Extrait de la page All articles dans la langue par défaut
Méthode 2 : Extrait de la All articles en langue secondaire
Méthode 3 : À partir de l'intérieur du guide individuel étape par étape dans la langue secondaire
Traduisez depuis la page All articles dans la langue par défaut.
Utilisez cette méthode lorsque vous souhaitez traduire un ou plusieurs guides étape par étape en une ou plusieurs langues secondaires en une seule action. C'est l'approche la plus efficace pour les déploiements initiaux ou lorsque plusieurs guides doivent être localisés simultanément, car vous pouvez sélectionner et traduire plusieurs guides simultanément sans ouvrir chacun individuellement.
Naviguez jusqu' Documentation () dans la barre de navigation de gauche du Knowledge base portal.
Assurez-vous d'être dans le langage par défaut de l'espace de travail.
Dans le panneau de navigation de gauche, naviguez vers All articles ().
Dans la liste des articles, sélectionnez les cases à cocher à côté des guides étape par étape que vous souhaitez traduire.
Translate with Eddy AI ().
Sélectionnez les langues secondaires requises dans le panneau de traduction qui apparaît.
Cochez la case pour confirmer et poursuivre le processus de traduction
Cliquez sur Traduire.
Les guides étape par étape sélectionnés seront désormais traduits dans les langues choisies.
Traduire depuis la page All articles dans une langue secondaire
Utilisez cette méthode lorsqu'un guide traduit est déjà disponible dans une langue secondaire et est marqué comme Nécessite une traduction (🌐). Ce statut indique que le guide source original a été mis à jour depuis la dernière génération de la traduction, ce qui signifie que la version en langue seconde peut être obsolète. Cette méthode est idéale pour les revues périodiques de localisation ou pour gérer un retard de guides nécessitant une mise à jour dans un espace de travail linguistique spécifique.
Naviguez jusqu' Documentation () dans la barre de navigation de gauche du Knowledge base portal.
Passez à l'espace de travail de langue secondaire requis.
Dans la liste des articles, sélectionnez les cases à cocher à côté des guides étape par étape que vous souhaitez traduire. Filtrez les guides qui indiquent Nécessite une traduction (🌐), si nécessaire.
Translate with Eddy AI ().
Un indicateur de progression apparaîtra jusqu'à la fin de la traduction. Une fois terminé, le contenu sera traduit ; la mise en forme restera cohérente dans toutes les langues.
Traduisez depuis l'éditeur de guides étape par étape
Utilisez cette méthode lorsque vous souhaitez traduire un guide spécifique tout en le relisant ou en le modifiant dans l'éditeur. Elle convient parfaitement aux contributeurs qui travaillent sur un guide et souhaitent déclencher une traduction sans avoir à s'éloigner, tout en gardant leur flux de travail centré sur un seul contenu.
Naviguez jusqu'au guide étape par étape que vous souhaitez traduire.
Assurez-vous que le contenu approprié est disponible dans l'éditeur.
Cliquez sur l' Translate with Eddy AI ().
Cliquez sur Translate with Eddy AI pour commencer le processus de traduction.
Un indicateur de progression apparaîtra jusqu'à la fin de la traduction. Une fois terminé, le contenu sera traduit ; la mise en forme restera cohérente dans toutes les langues.
Les versions traduites affichent un statut Traduit ou Besoin de traduction , aidant les contributeurs à identifier rapidement les guides nécessitant des mises à jour de localisation.
NOTE
Lorsque des étapes sont ajoutées ou supprimées dans le guide linguistique par défaut, ces changements se reflètent dans les versions secondaires de l'éditeur en état de brouillon. Ces mises à jour ne sont pas visibles sur le Knowledge base site tant que le guide n'a pas été retraduit et publié dans la langue correspondante. Le nombre total d'étapes dans un guide reste cohérent dans toutes les langues, assurant un alignement structurel entre les versions source et traduite.
Statut de la traduction
Les guides traduits affichent un statut Traduit ou Besoin de traduction afin que les contributeurs puissent rapidement voir ce qui nécessite une attention.
Un guide est marqué Nécessite une traduction (🌐) lorsque :
Un nouveau guide est créé
Le guide source est mis à jour
Les étapes sont ajoutées, supprimées ou réorganisées dans la langue source
Les superpositions de texte à l'intérieur des images sont modifiées
Un nouveau langage d'espace de travail est ajouté
Lorsque le guide source est mis à jour, les versions traduites sont automatiquement marquées Nécessite une traduction. Les contributeurs choisissent quand retraduire.
NOTE
Lors de la retraduction, les crédits de traduction sont calculés pour l'ensemble du guide étape par étape, pas seulement pour les étapes modifiées.
Les crédits de traduction sont calculés en fonction des titres de pas, des descriptions et des superpositions de texte sur les images de pas. Des éléments visuels comme les surlignés, les zones de projecteur et les zones de flou ne consomment pas de crédits à moins d'inclure un texte modifiable.
Résolution de problèmes de traduction
Un guide traduit affiche le contenu dans la langue source au lieu de la traduction - Naviguez jusqu'au guide dans l'espace de travail de la langue seconde et vérifiez son statut. Essayez de publier depuis la langue secondaire. Si le guide est marqué comme Traduit, cliquez sur Marquer comme nécessitant la traduction, puis sélectionnez Translate with Eddy AI et retraduisez le guide.
Le bouton Traduire avec Eddy AI est grisé - Confirmez que la traduction Eddy AI est activée pour votre projet dans Paramètres > Paramètres IA > Paramètres Eddy AI. Vérifiez également que votre plan de projet inclut la suite de traduction IA, contactez le support si vous avez des doutes.
Les crédits de traduction ont été consommés plus que prévu - Les crédits sont facturés pour les titres de pas, les descriptions et les superpositions de texte. Si votre guide utilise de nombreuses superpositions d'annotation de texte (ajoutées via l'élément Texte dans l'éditeur), elles comptent toutes dans le total des crédits. Les éléments uniquement visuels comme les surlignes et le flou ne consomment pas de crédits.
Guides de clonage étape par étape
Le clonage, un Step by step guide étape crée une copie exacte du contenu original en tant que nouveau guide. Vous pouvez cloner des guides étape par étape dans le même espace de travail ou entre différents espaces de travail.
Il existe deux méthodes pour cloner un guide étape par étape dans le portail de la base de connaissances :
Méthode 1 : À partir du volet Categories & Articles .
Méthode 2 : À partir d'une catégorie spécifique de Dossier ou d'Index .
Depuis le volet Categories & Articles, vous pouvez cloner un guide étape par étape au sein ou entre les espaces de travail :
Naviguez jusqu' Documentation () dans la barre de navigation de gauche du portail de la base de connaissances.
Survolez le guide étape par étape souhaité dans le panneau de navigation de gauche.
L' More () apparaîtra.
Cliquez sur l'More () et sélectionnez l'Clone Cloner ().
Dans la boîte de dialogue Guide pas à pas Clone , effectuez ce qui suit :
Titre : Saisissez le nom du guide de clonage étape par étape.
Espace de travail : Sélectionnez l'espace de travail souhaité dans le menu déroulant. Cliquez sur Réinitialiser pour l'assigner sous l'espace de travail principal.
Catégorie : Sélectionnez une catégorie existante dans l'espace de travail sélectionné.
Mise à jour automatique des liens référencés : Sélectionnez cette case à cocher pour vous assurer que les liens dans le contenu du guide étape par étape sont mis à jour en fonction de l'espace de travail ou de la catégorie de destination.
Références croisées : Sélectionnez Mettre à jour pour cloner pour mettre à jour automatiquement les liens croisés afin qu'ils correspondent au nouvel espace de travail ou catégorie, ou sélectionnez Conserver l'original pour garder les liens pointant vers l'article original.
Clone.
Pour déplacer un guide étape par étape spécifique dans une catégorie de Dossier/Index spécifique :
Naviguez jusqu' Documentation () dans la barre de navigation de gauche du portail de la base de connaissances.
Allez dans la catégorie Dossier/Index souhaitée.
Passez la souris sur le guide étape par étape souhaité.
Cliquez sur l' More () et sélectionnez l'icône Clone ().
Dans la boîte de dialogue Guide pas à pas Clone , effectuez ce qui suit :
Nom : Saisissez le nom du guide de clonage étape par étape.
Espace de travail : Sélectionnez l'espace de travail souhaité dans le menu déroulant. Cliquez sur Réinitialiser pour l'assigner sous l'espace de travail principal.
Catégorie : Sélectionnez une catégorie existante dans l'espace de travail sélectionné.
Mise à jour automatique des liens référencés : Sélectionnez cette case à cocher pour vous assurer que les liens dans le contenu du guide étape par étape sont mis à jour en fonction de l'espace de travail ou de la catégorie de destination.
Clone.
Guide étape par étape pour dépublier
Comme pour déséditer un article ordinaire, vous pouvez aussi déspublier un guide étape par étape s'il n'est plus nécessaire ou nécessite des mises à jour.
Par exemple, si un guide a été créé pour une fonctionnalité encore en développement mais publiée par erreur, vous pouvez le dépublier jusqu'à ce que la fonctionnalité soit prête. Cela garantit que seules des informations exactes et finales apparaissent dans votre base de connaissances.
NOTE
Seuls les comptes d'équipe ayant les autorisations de publication peuvent annuler les articles.
Vous pouvez déspublier un guide étape par étape en utilisant l'une des méthodes suivantes :
Méthode 1 : Extrait de la sectionCategories & Articles
Méthode 2 : De la catégorie Dossier/Index
Méthode 3 : Extrait de la section All articles ( )
Méthode 4 : De l'éditeur de l'article
Méthode 1
Pour dépublier un guide étape par étape de la Categories & Articles :
Naviguez jusqu'à Documentation () dans la barre de navigation de gauche du portail de la base de connaissances.
Dans le volet Categories & Articles , survolez le guide publié étape par étape.
Cliquez sur l' More () et sélectionnez Unpublish ().
Le panel Confirmation de la désédition apparaîtra.
Voici la raison de la désédition. C'est un champ optionnel.
Cliquez sur Unpublish.
Pour éditer ou republier :
Cliquez sur Modifier pour effectuer des modifications.
Cliquez sur Publier pour republier sans modification.
Méthode 2 :
Pour dépublier un guide étape par étape de la catégorie Dossier/Index :
Naviguez vers la catégorie souhaitée dans la Documentation ().
Passez la souris sur le guide pas à pas publié dans le panneau de navigation de gauche et cliquez sur l'More ().
Sélectionnez Unpublish ().
Sinon, pour dépublier plusieurs guides, sélectionnez les guides publiés souhaités et cliquez Unpublish ( ) en haut.
Le panel Confirmation de la désédition apparaîtra.
Voici la raison de la désédition. C'est un champ optionnel.
Cliquez sur Unpublish.
Pour éditer ou republier :
Cliquez sur Modifier pour effectuer des modifications.
Cliquez sur Publier pour republier sans modification.
Méthode 3 :
Pour déspublier plusieurs guides étape par étape de la section All articles :
Naviguez jusqu'à Documentation () dans la barre de navigation de gauche du portail de la base de connaissances.
Dans le panneau de navigation de gauche, naviguez vers All articles ().
Sélectionnez un ou plusieurs guides publiés.
Cliquez sur Unpublish ( ) en haut.
Le panel Confirmation de la désédition apparaîtra.
Voici la raison de la désédition. C'est un champ optionnel.
Cliquez sur Unpublish.
Pour republier ou éditer :
Cliquez sur Modifier pour effectuer des modifications.
Cliquez sur Publier pour republier sans modification.
Méthode 4 :
Pour déspublier un guide étape par étape du rédacteur de l'article :
Naviguez jusqu'à Documentation () dans la barre de navigation de gauche du portail de la base de connaissances.
Ouvrez le guide étape par étape publié souhaité et cliquez sur l' More () en haut à droite.
Sélectionnez Unpublish ().
Le panel Confirmation de la désédition apparaîtra.
Voici la raison de la désédition. C'est un champ optionnel.
Cliquez sur Unpublish.
Pour republier ou éditer :
Cliquez sur Modifier pour effectuer des modifications.
Cliquez sur Publier pour republier sans modification.
NOTE
Une fois qu'un guide étape par étape n'est pas publié :
La désédition d'un guide étape par étape change son statut de Publié à Brouillon.
Tous les liens associés vont se rompre.
Le guide sera caché du site de la base de connaissances.
Dans le portail de la base de connaissances, le statut apparaîtra comme Non publié et l'icône de statut du guide étape par étape apparaîtra en gris ().
Exporter un guide étape par étape en PDF
Vous pouvez exporter n'importe quel guide étape par étape en PDF, utile pour partager hors ligne, attacher à des tickets de support ou imprimer pour une formation en présentiel.
Extrait du site de la base de connaissances
Consultez le guide étape par étape publié sur le site de la base de connaissances.
Dans l'en-tête de l'article, cliquez sur l' icône Plus ().
Sélectionnez Exporter en PDF.
Le PDF se télécharge automatiquement. Choisissez un emplacement de sauvegarde dans votre explorateur de fichiers et cliquez sur Enregistrer.
Depuis le portail de la base de connaissances
Naviguez vers le guide (brouillon ou publié) dans le portail de la base de connaissances.
Cliquez sur l' icône Plus () près de l'option Partager .
Sélectionnez Exporter en PDF.
Une version PDF bien formatée du guide est téléchargée sur votre ordinateur.
FAQ
Puis-je créer des guides dans toutes les langues ?
Les guides étape par étape ne peuvent être créés que dans la langue de travail par défaut. Par la suite, ils peuvent ensuite être traduits dans des langues secondaires activées. Jusqu'à ce qu'une traduction existe, les lecteurs consultent la version par défaut en langue.
Eddy AI utilise-t-il du contenu issu des guides étape par étape ?
Oui. Eddy AI récupère le titre, la description et le texte du corps à partir des guides publiés lors de la réponse aux recherches. Les réponses incluent une citation renvoyant directement au guide source.
Comment puis-je voir les contributeurs ?
Cliquez sur l'icône Informations près du badge de statut. Un panneau affiche la liste des contributeurs, le nombre de pas, la date de dernière mise à jour et les détails de création.
Comment effectuer des opérations en bloc pour les guides étape par étape ?
Les guides étape par étape fonctionnent de manière similaire aux articles et sont affichés dans la section Tous les articles . Ici, vous pouvez les gérer, les rechercher et les organiser aux côtés des autres articles de votre projet. Dans la section Tous les articles , vous pouvez utiliser des filtres pour trier les guides par statut (par exemple, Brouillon, Publié, Nouveau), catégorie, tags ou date de modification.
Comment configurer le titre SEO et la description pour un guide étape par étape ?
Pour configurer le SEO pour un guide étape par étape :
Naviguez vers le guide souhaité dans le portail de la base de connaissances.
Cliquez sur More () et sélectionnez SEO.
Dans la boîte Article settings , mettez à jour le méta-titre, le slug et la description.
Cliquez sur Enregistrer pour appliquer les modifications.
Pour plus d'informations, lisez l'article sur Article SEO.
Comment puis-je suivre les événements d'activité pour des guides étape par étape ?
Pour suivre les événements d'activité dans le guide étape par étape :
Naviguez dans () > Knowledge base portal > audits de l'équipe dans le portail de la base de connaissances.
Dans l'onglet Audit de l'équipe , vous trouverez des mises à jour sur les changements de vizibilité, les mises à jour des titres et les modifications des contributeurs pour chaque guide.
Pour plus d'informations, lisez l'article sur l'audit d'équipe.
Comment puis-je activer la table des matières pour mon guide étape par étape ?
Chaque étape d'un guide peut apparaître dans une table des matières sur le site de la base de connaissances. Pour permettre la table des matières :
Naviguez dans () > Knowledge base portal > Article settings & SEO dans le portail de la base de connaissances.
Dans l'onglet Paramètres de l'article , dépliez l'accordéon droit de l'article .
Activez le bouton Afficher la table des matières .