De nombreuses entreprises SaaS rencontrent des difficultés dans le processus de développement et de distribution de leur documentation produit (manuels utilisateur, guides et/ou tutoriels) à leurs clients.
Souvent, cela résulte d'un manque de connaissances ou de processus concernant la gestion et la production des manuels, ou même sur la question de savoir qui en est responsable.
Tant qu'il existera des outils et des logiciels dans ce monde, nous aurons besoin d'une communication efficace pour expliquer aux autres l'utilisation, le développement, le fonctionnement et l'architecture de ces produits. Si vous vous demandez pourquoi, la réponse est simple. Les compétences en communication technique sont essentielles pour recueillir des informations et permettre au public de mieux comprendre un produit ou une technologie.
Alors que la communication dans le monde réel passe par la parole, le langage corporel et les expressions émotionnelles, dans le monde virtuel, la communication technique s'effectue via la documentation technique du produit !
Le seul objectif de la documentation produit est de faciliter la compréhension par l'utilisateur de la dynamique de fonctionnement et de l'architecture d'un produit et d'une technologie. C'est comme un "mode d'emploi" pour vos nouveaux employés, utilisateurs/clients et toute personne qui doit connaître les méthodes de travail, une description détaillée des rouages d'un produit !
Il incombe au chef de produit de prendre la responsabilité de développer une équipe pour créer, gérer, publier et maintenir une documentation produit soignée.
Je suis certain que chaque chef de produit a dit ou entendu dans son service : "La documentation produit fait partie des obligations du Product Owner" ; "Chaque équipe de développement devrait documenter ses propres applications" ; "la fonctionnalité a été déployée, le manuel a-t-il été mis à jour ?" ou, pire encore, "il y a une erreur dans la documentation technique."
La documentation technique du produit peut être déroutante, aussi simple qu'elle paraisse ! Pendant que les individus tentent de résoudre ou de débattre des lignes du paragraphe précédent, les manuels et tutoriels se dégradent, ce qui nuit à l'image de votre "produit/entreprise".
Pour aider ceux qui rencontrent des problèmes similaires, voici quelques procédures à mettre en place pour optimiser votre documentation produit.
Quel est l'objectif de la documentation produit ?¶
Lorsque vous parlez de documentation produit pour un produit ou service technologique, vous parlez des informations qui le décrivent et des données qui s'y rapportent.
La documentation technique, ou documentation produit, vise à aider votre audience et vos clients à utiliser, lire et comprendre votre produit. La plupart des documentations produit sont produites dans divers domaines comme l'ingénierie, la médecine, l'informatique et le marketing.
Une excellente documentation technique aide votre audience à naviguer dans votre produit et leur permet de l'utiliser sans complications.
Il faut également considérer que la documentation technique est essentielle pour l'assistance client et contribue significativement à l'image de marque et à la confiance en votre entreprise. Les utilisateurs recherchent la documentation technique quand ils en ont le plus besoin. Ils utilisent votre produit pour apprendre les processus et résoudre les problèmes.
Cela signifie qu'avoir une documentation produit complète et dynamique avec des capacités de recherche est très important.
Quels sont les différents types de documentation produit ?¶
Cette section vous permet de voir quel type de documentation produit vous devez créer pour vos clients.
Il existe plusieurs types de documentation produit qui répondent à différents cas d'utilisation et besoins des utilisateurs :
Documentation utilisateur du produit : Elle comprend les manuels utilisateur, guides pratiques, tutoriels, FAQ, notes de version, manuels de formation et procédures d'exploitation.
Documentation d'entreprise : Des études montrent que plus de 8 entreprises sur 10, sur 1000 entreprises interrogées, utilisent des manuels formels de politiques et procédures.
Il existe de nombreux autres types de documentation d'entreprise qui comprennent les politiques et procédures, les manuels d'instruction, les pratiques techniques, la documentation sur le comportement et l'éthique, ainsi que la documentation juridique qui peut être protégée par mot de passe. S'y ajoutent les structures d'entreprise, les meilleures pratiques et les manuels d'entretien.
Documentation pour développeurs : ce type de documentation fournit des instructions pour le développement de produits logiciels, des spécifications fonctionnelles et techniques, de la documentation et des outils pour faciliter le flux de travail des développeurs.
Maintenant que nous comprenons mieux les différents types de documentation technique et produit, discutons des premières étapes d'une gestion solide du processus de développement de la documentation produit.
Désigner un responsable du développement de la documentation produit¶
Un problème très courant est de déterminer qui devrait être responsable de la documentation produit, non pas en tant que simple rédacteur, mais en tant que responsable de la qualité et du succès du produit.
Certaines entreprises estiment que chaque product owner et/ou chef de produit est responsable de la documentation, tandis que d'autres services comme le développement et le support peuvent également être chargés de maintenir les manuels utilisateur, guides et tous les aspects de la documentation produit à jour et efficaces.
Le développement de la documentation produit comporte de nombreux éléments, mais nous en soulignerons deux :
-
Qui comprend comment le produit fonctionne à tous les niveaux (cela inclut également les équipes de développement et de spécifications).
-
Ceux qui reçoivent les commentaires des clients qui parcourent la documentation et écoutent leurs difficultés, feedbacks et préoccupations concernant la compréhension de la documentation.
La première partie nous aide à créer la documentation avec les connaissances disponibles, qui est ensuite envoyée au client. En retour, celui-ci donne son feedback et initie le deuxième processus qui aide à optimiser la documentation.
Parfois, ces deux points ne sont pas parfaitement en place, ce qui crée des situations où la documentation ne reçoit jamais l'attention nécessaire.
Une approche consiste à désigner une personne responsable de la "performance" de la documentation, des manuels et des guides. Imaginez un responsable qui a "Documentation Produit" comme produit. Il est chargé de parcourir toutes les équipes de l'entreprise, d'esquisser comment chaque produit génère ses guides et d'identifier les défis associés à ce processus.
L'intention n'est pas que ce product owner et chef de produit soit entièrement responsable de la génération et de la modification des manuels, mais d'aider les individus au sein de chaque équipe avec la gestion des documents.
Cette personne devrait étudier comment les utilisateurs interagissent avec les documents, proposer des moyens de rendre les mises à jour plus fluides et recueillir des commentaires pour déterminer comment améliorer chaque documentation et explication pour son public cible.
Avoir quelqu'un en charge de tous les aspects de la documentation produit, gérant le flux de travail et les différents départements nécessaires pour compléter cette documentation, augmentera la productivité au sein de l'entreprise, sensibilisera et éduquera les clients grâce à des portails de connaissances sur le produit, et rationalisera la compréhension du produit.
Considérer votre documentation produit comme un produit en soi¶
Les produits existent pour apporter une valeur qui répond ou dépasse les attentes d'un client. Selon les statistiques générées par D2WorldWide, 73,7 % des personnes considèrent la documentation plus utile que les vidéos, l'emballage ou les vendeurs lorsqu'elles recherchent des informations sur des produits qu'elles envisagent d'acheter.
Réfléchissez aux facteurs qui contribuent à l'attractivité d'un produit. Plusieurs facteurs peuvent influencer l'attractivité d'un produit, mais pour cet article, nous nous concentrerons sur trois : ils dépassent les attentes en termes de valeur, leur utilisation génère de la satisfaction, et ils sont compétitifs.
Les mêmes concepts s'appliquent à une bonne documentation produit en ligne. Les documents qui vont "au-delà de la valeur attendue" illustrent non seulement comment utiliser le produit, mais offrent également des solutions que le client ignore ou ne pense pas possibles. Il est toujours nécessaire d'observer comment d'autres entreprises élaborent leur documentation pour apprendre de leurs succès et de leurs erreurs.
Il est inutile d'avoir une entreprise qui développe des logiciels uniques et de haute qualité, en avance sur la concurrence, si les développeurs et les clients qui intègrent vos documents techniques ne peuvent pas les comprendre.
Considérez que la personne qui lit la documentation peut ne pas connaître l'éventail des solutions possibles offertes par le produit ou le marché (comme c'est souvent le cas avec les produits SaaS techniques), et doit donc être "éduquée" sur ces solutions et les différentes options liées au produit.
Les documents dont "l'utilisation génère de la satisfaction" suivent un schéma de lecture logique adapté à leur public cible. Il ne sert à rien d'avoir le manuel le plus complet au monde s'il s'agit d'un PDF de 500 pages, ne comprend pas d'exemple de code et n'est pas créé dynamiquement avec des capacités de recherche et d'autres fonctions. Recueillez les commentaires des utilisateurs de votre documentation et de votre équipe d'assistance. Ils détermineront les principales zones de stress liées aux données rapportées.
Une documentation compétitive est celle qui est constamment mise à jour en utilisant les techniques d'échange d'informations les plus efficaces. Elle possède des fonctionnalités impressionnantes comme la recherche intégrée, les traductions, différentes versions, des images, des vidéos et bien plus encore !
Même si votre guide d'intégration est le mieux rédigé de toutes les entreprises technologiques, il manquera d'attrait sans vidéo ajoutée, images et codes qui peuvent être copiés-collés pour faciliter l'utilisation par vos clients technophiles qui achètent vos produits SaaS techniques.
Il est toujours nécessaire d'observer comment d'autres entreprises élaborent leurs documents pour apprendre de leurs succès et de leurs erreurs.
Il est inutile d'avoir une entreprise qui développe des logiciels uniques et de haute qualité, en avance sur la concurrence, si les développeurs et les clients qui intègrent vos documents ne peuvent pas les comprendre dans leur intégralité.
Feedback sur la documentation produit
Une documentation technique efficace améliore l'expérience utilisateur en facilitant la compréhension des produits et en diagnostiquant les problèmes avec des solutions écrites facilement accessibles. Lorsque les clients font confiance à vos produits et comprennent comment les utiliser, ils sont susceptibles de revenir vers vous à l'avenir.
Une nouvelle recherche menée par SDL montre que le rôle de la documentation sur les marchés mondiaux augmente. L'étude révèle qu'environ 53 % des acheteurs effectuent leurs achats en utilisant la documentation technique avant même d'essayer le produit. De plus, 94 % des acheteurs estiment qu'avoir toutes les informations sur un produit en un seul endroit est utile. Pour cette raison, chaque entreprise accorde aujourd'hui autant d'importance à la documentation qu'au développement ou aux tests.
Même si la documentation a un propriétaire désigné qui gère l'équipe, qu'elle a été révisée et évaluée pour une meilleure utilisabilité, et qu'elle a été correctement mise à jour, vous continuez à avoir du mal à faire comprendre vos produits techniques à vos utilisateurs et clients. Cela peut résulter de l'incapacité des utilisateurs/lecteurs à comprendre comment votre documentation est lue ou les questions qu'ils se posent réellement. Un des aspects les plus difficiles de la rédaction de documents est de se mettre à la place du lecteur. Après tout, quiconque produit la documentation devrait avoir une solide compréhension du produit.
Cette expertise peut amener l'auteur à négliger des éléments qui ne sont pas évidents pour l'utilisateur moyen. Généralement, cela se produit lorsque quelque chose qui est évident pour les créateurs du produit n'est pas clair pour ceux qui l'achètent et l'utilisent.
Cela peut se manifester de différentes façons :
Structure ou forme d'écriture : Bien que cela puisse sembler subjectif, même la manière dont un manuel est rédigé peut créer de la confusion. Il est essentiel d'identifier le type de lecteur qui consulte la documentation ; sinon, des remarques comme "Les développeurs préfèrent des exemples plutôt que du texte descriptif" ou "Notre documentation n'est pas claire malgré la présence d'exemples et de visuels" peuvent survenir.
Organisation des sujets dans les manuels : Parfois, les entreprises opérant sur le même marché développent un format de documentation standardisé. Si les guides de votre entreprise ne s'y conforment pas, le lecteur peut avoir une impression d'étrangeté.
Usage excessif de termes implicites : Appliquées à un manuel, les abréviations peuvent avoir peu de sens, même si les phrases ne sont pas des acronymes. C'est difficile à percevoir, mais certains mots comme "statut", "id", "identifiants" contiennent une signification implicite déguisée en explicite. Utilisez des désignations spécifiques, comme "UserID", plutôt que "UID".
Traduction valide : la traduction est un aspect majeur de la portée mondiale. Souvent, les entreprises créent des manuels utilisateur et des documentations produit mal traduits qui ne correspondent pas à la culture de certaines nations ou dont les mots ne se traduisent pas de la même façon qu'en anglais dans ce pays particulier. Comprendre ces nuances subtiles peut transformer une documentation illisible en information pleinement compréhensible et bien traduite.
Pour éviter de telles situations, l'objectif est de développer une solution qui recueille et analyse les commentaires des utilisateurs et les modèles de navigation.
Des outils de feedback comme Vocally, une fonctionnalité de Docsie, constituent un excellent moyen de recevoir et d'évaluer les modèles de navigation et d'enquêter sur la façon dont vos clients consultent votre documentation. Découvrez les 7 règles d'or pour recueillir des feedbacks ici.
Ces informations sont essentielles pour mettre à jour et optimiser vos guides et manuels afin de créer une expérience plus fluide pour vos clients. Rien n'est plus frustrant que de lancer un nouveau produit et de constater une augmentation des demandes d'assistance en raison d'instructions mal rédigées.
Comment rédiger une documentation produit complète¶
Une documentation produit de qualité est captivante, utile et puissante. Je dirais qu'une documentation habile est un élément nécessaire d'une bonne gestion de produit. Autant les chefs de produit jouent un rôle important dans le développement des produits, une part significative du succès réside dans la création d'une documentation soignée que nos clients peuvent comprendre et utiliser pour approfondir leurs connaissances sur nos produits.
Qu'en est-il de la plupart des documentations produit ?¶
De nombreux chefs de produit sont réticents à rédiger de la documentation. Les documents qu'ils connaissent peuvent ne pas avoir d'impact sur leurs clients, à moins qu'un soin particulier ne soit apporté pour les rendre attrayants, faciles à lire et pertinents.
Cependant, souvent, les entreprises ne prennent pas le soin nécessaire pour créer une documentation produit exceptionnelle. Une mauvaise documentation est écrite uniquement pour être écrite. Elle utilise des phrases alambiquées remplies d'idées vaguement acceptables et une mise en page médiocre pour décourager les lecteurs. Une mauvaise documentation est créée pour protéger l'auteur des critiques et représente une perte de temps pour tous. Et les clients n'aiment pas la lire pour cette raison également.
Comment améliorer et rédiger une meilleure documentation que nos clients apprécieront ?¶
Une excellente documentation produit est écrite pour être lue. Elle est concise. Une bonne documentation est bien formatée et peut être lue et comprise par tous dans l'entreprise ou par les clients en trois minutes. Elle évite le jargon et fournit ou fait référence à une perspective commerciale. Une excellente documentation consacre du temps à décrire des cas d'utilisation spécifiques que les clients peuvent comprendre et appliquer pour améliorer l'utilisation du produit. Elle engage le lecteur et attire l'attention sur les problèmes sous-jacents avec des solutions bien élaborées.
La puissance d'une documentation produit bien rédigée¶
Que ce soit pour les petites, moyennes ou grandes entreprises, une documentation technique bien formatée peut faire gagner beaucoup de temps et aider les employés à travailler plus efficacement. C'est généralement vrai pour la plupart des entreprises axées sur les produits, qui consacrent une grande partie de leur budget à l'embauche de rédacteurs techniques et à la rédaction de documentation technique.
Si votre entreprise emploie plus de deux personnes pour créer de la documentation produit, il est tout à fait judicieux d'établir une culture de bonne documentation. Il y a de nombreuses raisons pour lesquelles vous voudriez que votre équipe crée, gère et publie une documentation bien conçue, mais dans cette section, nous aborderons comment une documentation efficace est une approche peu coûteuse pour améliorer l'expérience client.
Une documentation produit efficace est une approche économique pour améliorer l'expérience client¶
Une solide expérience client est essentielle pour fidéliser les clients. La plupart des chefs de projet sont optimistes – ils ont une idée, s'enthousiasment, puis l'exécutent. Bien que la passion soit admirable et que l'exécution semble productive, avoir un plan de jeu avant d'élaborer une documentation produit appropriée est vital.
Les premières étapes après la réflexion consistent à initier un cycle de conception et à structurer le contenu de la documentation de manière à le rendre progressivement facile à lire pour les clients.
De plus, recueillir les commentaires des clients sur la documentation actuelle est une étape essentielle pour restructurer les documents en fonction de leurs besoins. Ainsi, les chefs de projet peuvent créer, gérer, maintenir, publier et optimiser leur documentation avec perspicacité et automatisation. Ce n'est pas une tâche simple, et disposer d'outils exceptionnels comme Docsie, qui automatise une grande partie des processus pour rendre la documentation produit efficace, est essentiel au succès.
Une documentation technique attrayante, engageante et navigable aide les consommateurs à apprendre le produit en moins de temps, ce qui augmente la probabilité qu'ils configurent et utilisent correctement le produit.
Toutes ces stratégies de création d'une documentation produit soignée conduiront essentiellement à des produits mieux notés, des avis plus favorables et plus de ventes qui sont tous liés entre eux.
Comment créer une documentation produit bien conçue¶
Comment produire une documentation efficace et favoriser une culture où c'est la norme ? Rédiger une documentation efficace est difficile, mais Docsie offre de nombreuses fonctionnalités qui peuvent accélérer ce processus de création de portails de documentation produit dynamiques et bien conçus. Voici un aperçu de notre approche du problème.
Commençons :¶
Les limites de page garantissent la lisibilité. Rédiger un document correct ne devrait pas être difficile à lire et à traiter mentalement. Des phrases longues et sinueuses indiquent souvent un manque de clarté. Si la communication ne peut pas être correctement résumée sur une seule page, c'est un signe que le chef de produit devrait probablement revenir en arrière et décomposer davantage la situation.
Le formatage améliore la qualité. Une documentation produit mal structurée augmente la probabilité que le rédacteur improvise. Créez un modèle avec des sections, tableaux et en-têtes bien formatés. C'est un investissement ponctuel à fort potentiel de rendement.
Les modèles vous font gagner du temps. Il est bien plus facile de supprimer une section d'un modèle que de se rappeler d'en ajouter une. Ce n'est pas condescendant, c'est efficace et économe en temps. Des sections simples qui rappellent au rédacteur de commencer par le contexte général et d'être précis sur les mesures ou les hypothèses risquées permettent une rédaction plus précise et une hiérarchie de décision.
Commentez et assignez des tâches. Il n'y a pas de moyen plus sûr de démotiver votre personnel à produire une documentation de qualité que de ne pas la commenter. Les commentaires n'ont pas besoin d'être très intelligents ; ils doivent indiquer l'implication et servir de modèle. Bien qu'il soit idéal de fournir un retour numériquement pour que d'autres dans l'entreprise puissent bénéficier de la conversation de manière asynchrone, une fonctionnalité simple dans Docsie qui vous permet de commenter et de collaborer avec votre équipe fonctionne très bien pour l'équipe de documentation produit !
Consultez ce blog pour en savoir plus sur la façon dont Docsie aide à la collaboration pour la documentation produit
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/
Les types de documents doivent être évolutifs pour répondre aux besoins de votre entreprise. À mesure que davantage de parties prenantes s'impliquent dans le processus de développement du produit, la communication doit être divisée en plusieurs documents (particulièrement si le critère de "concision" d'une page doit être respecté). Docsie offre une solution utile et durable pour les équipes de documentation produit en croissance.
Utilisez Docsie pour accélérer la création d'une documentation produit exceptionnelle¶
Docsie est une plateforme très pratique qui vous aide dans tous les aspects de la création de documentation produit et de portails de connaissances. Elle possède de nombreuses fonctionnalités intégrées qui rendent les projets de création de documentation simples et amusants ! Voici quelques-unes des nombreuses fonctionnalités de Docsie qui peuvent vous aider à atteindre ces objectifs :
Possibilité de modifier : Docsie permet à tous nos utilisateurs de modifier la documentation après publication en créant une version alternative qui ne sera pas mise en ligne tant qu'elle n'est pas activée. C'est formidable car les équipes de gestion de produit peuvent travailler sur l'édition et la modification de la documentation et la mettre en ligne une fois qu'elles sont prêtes, sans avoir à jongler avec HTML et CSS. La documentation sera automatiquement rendue d'un simple clic lorsqu'ils seront prêts.
Possibilité de rechercher : si votre documentation est abondante ou comporte de nombreuses fonctionnalités, le plugin de recherche de Docsie ajoute un bonus utile qui permet à vos clients de rechercher rapidement et facilement dans votre documentation pour trouver les informations dont ils ont besoin.
Possibilité de créer des liens : Docsie rend votre documentation compatible SEO. Vous pouvez créer des liens vers certaines pages de votre site web ou simplement écrire des mots-clés basés sur vos produits qui seront recherchables en ligne et attireront de nouveaux clients.
Possibilité d'avoir différentes traductions : Le traducteur automatique de Docsie permet à nos utilisateurs de traduire leur documentation dans diverses langues. De plus, grâce au sélecteur de langues, vos clients peuvent choisir la langue qui leur convient le mieux. C'est très utile pour atteindre un public mondial et développer la clientèle, tout en instaurant la confiance avec les nouveaux clients à l'étranger.
Possibilité d'assigner des tâches et de commenter pour une collaboration fluide : Docsie offre d'excellents outils pour collaborer avec votre équipe de documentation. Vous pouvez ajouter des commentaires, définir des tâches et attribuer des rôles pour mieux gérer ce qui est accompli par chaque utilisateur travaillant sur votre projet de documentation avec Docsie. Pour en savoir plus, consultez ce blog.
Génération de feedback : Pouvoir connaître l'opinion de vos clients sur votre documentation est le seul moyen de savoir comment l'optimiser pour répondre à leurs besoins, afin qu'ils puissent comprendre plus agréablement vos documentations et portails de connaissances. Pour en savoir plus sur l'importance du feedback sur la documentation produit, consultez mon blog ici.
Docsie offre également de nombreuses autres fonctionnalités que vous et votre équipe de gestion de produit pouvez utiliser pour créer une documentation exceptionnelle. Dans cet article, je voudrais aborder les plugins que chaque portail de connaissances et documentation produit Docsie peut ajouter pour les améliorer et optimiser leur utilisabilité.
Les plugins Docsie pour rendre votre portail de documentation dynamique !¶
Docsie propose de nombreux plugins pour rendre votre documentation plus attrayante. Dans ce blog, je vais le diviser en 3 parties.
Dans cette section, nous diviserons l'explication de ces plugins de portail de connaissances en trois parties.
PARTIE 1 : Dans la première partie, nous montrerons le "Sélecteur de version", le "Sélecteur de langue", les "Ancres de section" et la "Navigation de pied de page"
PARTIE 2 : Dans cette partie, nous montrerons la "Mise en évidence du code", la "Recherche" et le plugin "Partage sur les réseaux sociaux"
PARTIE 3 : Dans la troisième partie, nous montrerons l'"Aperçu d'image", les "Métadonnées de document" et le plugin "Mise en évidence automatique de section".
Avant d'aborder les plugins, voyons comment y accéder dans la plateforme Docsie.
D'abord, dans l'espace de travail, nous devons cliquer sur les trois points dans le coin supérieur droit et ouvrir notre compte :
Ensuite, dans Déploiements, nous pouvons accéder aux Plugins une fois que nous créons un nouveau Déploiement via "Configurer un nouveau déploiement+"
Puis cliquez sur "Plus d'options" qui vous permettra d'ajouter ces plugins dans votre documentation déployée via un script intégré ou via le portail Docsie
L'autre option est d'accéder aux plugins des portails de connaissances Docsie via le bouton "Mettre à jour la configuration du déploiement" sous votre documentation déjà publiée.
Cela ouvrira ce tableau de bord et vous pourrez ajouter ou retirer des plugins selon vos besoins, puis mettre à jour le déploiement.
PARTIE 1 :¶
Maintenant que nous savons comment accéder aux plugins Docsie, passons à la PARTIE 1.
Pour voir le tutoriel vidéo de la partie 1, consultez cette vidéo :
Commençons par le "Sélecteur de version" et le "Sélecteur de langue"
Une fois ces deux plugins activés, ils apparaîtront en bas à gauche de votre portail de connaissances sous forme d'onglets flottants. Ils permettent à vos clients et aux lecteurs de votre documentation de consulter vos documents dans différentes langues et versions.
Lorsque l'utilisateur sélectionne une langue dans le sélecteur de langue, toute la documentation qu'il lit sera traduite dans cette langue.
Les ancres de section, une fois activées, permettent à vos clients d'avoir des liens à côté de chaque en-tête, leur donnant accès à des sections spécifiques de la documentation.
Chaque fois que ces liens sont cliqués, une partie de l'en-tête changera et lorsque votre client copie-colle cet HTML, il dirigera la personne à qui il l'envoie vers cette section spécifique de la documentation.
Ensuite, la "Navigation de pied de page"
Ce plugin ajoute un bouton de navigation en bas à droite de votre livre de documentation. Il ressemble à ceci :
Ainsi, vos clients peuvent naviguer plus confortablement dans votre documentation.
PARTIE 2 :¶
Pour voir le tutoriel vidéo de la Partie 2, consultez cette vidéo :
Dans cette partie, nous montrerons la "Mise en évidence du code", la "Recherche" et le plugin "Partage sur les réseaux sociaux"
Commençons par le plugin "Mise en évidence du code"
Ce plugin est parfait pour les produits techniques qui doivent présenter divers codes à leurs clients. Il permet à ces derniers de copier-coller le code pour l'utiliser facilement dans leur éditeur en ajoutant un bouton "Copier".
Passons maintenant au plugin Recherche.
Une fois activé sur votre portail de connaissances Docsie, vos clients peuvent effectuer des recherches dans votre documentation via une barre de recherche située dans le coin supérieur droit du portail.
En cliquant sur recherche, un tableau de bord sophistiqué apparaîtra, permettant à vos clients de localiser exactement où trouver certaines informations dans vos étagères et livres.
Cela accélère considérablement le processus par lequel vos clients peuvent trouver et récupérer les informations dont ils ont besoin sur vos produits.
Ensuite, le plugin Partage sur les réseaux sociaux
Ce plugin permet à vos clients de sélectionner des sections surlignées de votre documentation et de les partager sur leurs réseaux sociaux.
C'est excellent car cela peut augmenter le trafic, attirer de nouveaux clients potentiels et renforcer la confiance envers votre marque.
PARTIE 3 :
Pour voir le tutoriel vidéo de la partie 3, consultez cette vidéo :
Dans la troisième partie, nous montrerons l'"Aperçu d'image", les "Métadonnées de document" et le plugin "Mise en évidence automatique de section".
Commençons par le plugin Aperçu d'image
L'aperçu d'image permet à vos clients de zoomer ou dézoomer sur une image de votre documentation pour mieux la visualiser.
Ensuite, "Métadonnées de document"
Cela permet à vos clients de voir un horodatage indiquant quand la documentation ou des aspects du portail de connaissances ont été mis à jour. Il sera situé en haut et en bas de la documentation écrite.
Maintenant, examinons le plugin "Mise en évidence automatique de section"
Ce plugin simple permet à vos clients de suivre où ils se trouvent dans une documentation donnée au sein du portail de connaissances.
Il mettra en évidence chaque emplacement où ils se trouvent dans le portail de connaissances, afin que vos clients puissent mieux suivre leur position et naviguer plus facilement vers d'autres sections.
Tous ces outils et bien d'autres sont fournis par la plateforme Docsie. Si vous ne l'avez pas encore essayée, nous vous suggérons de le faire. Cliquez ici
Si vous avez des questions, n'hésitez pas à nous contacter à hello@docsie.io