De nombreuses entreprises technologiques SaaS se débattent avec le processus de développement et de distribution de la documentation produit (manuels d'utilisation, guides d'utilisation et/ou tutoriels) à leurs clients.
Souvent, cette situation résulte d'un manque de connaissances ou de processus concernant le traitement et la production corrects des manuels, ou même concernant la personne qui en est responsable.
Tant que le besoin d'outils et de logiciels existera dans ce monde, nous aurons besoin d'une communication efficace pour transmettre aux autres l'utilisation, le développement, le fonctionnement et l'architecture de ces biens. Si vous vous demandez pourquoi, la réponse est simple. Elle est due au fait que les compétences en communication technique sont essentielles pour collecter des informations et permettre au public de comprendre le produit ou la technologie de manière plus efficace.
Alors que dans le monde réel, la communication se fait par la parole, le langage corporel et l'expression des émotions, dans le monde virtuel, la communication technique se fait par le biais de la documentation technique sur les produits !
Le seul objectif de la documentation technique d'un 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. Il s'agit plutôt d'un manuel d'utilisation destiné aux nouveaux employés, aux utilisateurs/clients et à toute autre personne qui doit connaître les méthodes de travail, une description complète des rouages d'un produit !
Il est du devoir du chef de produit de prendre sur lui la responsabilité de développer une équipe pour créer, gérer, publier et maintenir une documentation produit de qualité.
Je suis sûr que tous les chefs de produit ont dit ou entendu ce qui suit dans leur service : "La documentation du produit fait partie des obligations du propriétaire du produit" ; "Chaque équipe de développement doit 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".
Il est clair que la documentation technique d'un produit peut être un peu déroutante, même si elle semble simple ! Pendant que les individus tentent de résoudre ou d'argumenter sur les lignes du paragraphe précédent, les manuels et les tutoriels se détériorent, ce qui nuit à l'image de votre "produit/entreprise".
Pour aider ceux qui rencontrent des problèmes similaires, voici quelques procédures à mettre en œuvre pour optimiser votre documentation produit.
Quel est l'objectif de la documentation produit ?
Lorsque l'on parle de la documentation d'un produit ou d'un service technologique, on parle des informations qui le décrivent et des données qui s'y rapportent.
La documentation technique, ou documentation produit, a pour but d'aider votre public et vos clients à utiliser, lire, comprendre et exploiter votre produit. La plupart des documentations de produits sont évidemment produites dans divers domaines, notamment l'ingénierie, la médecine, les technologies de l'information et le marketing.
Une bonne documentation technique aide votre public à se familiariser avec votre produit et lui permet de l'utiliser sans complications.
Par ailleurs, la documentation technique est essentielle pour l'assistance à la clientèle et contribue de manière significative à l'image de marque de votre entreprise et à la confiance qu'elle inspire. Lorsqu'ils en ont le plus besoin, les utilisateurs recherchent de la documentation technique. Le public utilise votre produit pour se familiariser avec les processus et résoudre les problèmes.
Il est donc très important de disposer d'une documentation complète et détaillée sur les produits, qui soit dynamique et dotée de fonctions de recherche.
Quels sont les différents types de documentation produit ?
Cette section vous permet de voir de quel type de documentation produit vous avez besoin pour vos clients.
Il existe de nombreux types de documentation produit qui répondent à différents types de cas d'utilisation et de besoins des utilisateurs :
Documentation utilisateur du produit: Il s'agit des manuels d'utilisation, des guides pratiques, des tutoriels, des FAQ, des notes de version et des manuels de formation, ainsi que des procédures d'exploitation.
Documentation d'entreprise: Les enquêtes montrent que plus de 8 entreprises sur 10, sur les 1000 entreprises interrogées, utilisent des politiques formelles et des manuels de procédures.
Il existe de nombreux autres documents d'entreprise, notamment des documents relatifs aux politiques et procédures de l'entreprise, comme indiqué dans l'étude ci-dessus, des manuels d'instruction, des pratiques techniques, des documents relatifs au comportement et à l'éthique. Il existe également une documentation juridique qui peut être protégée par un mot de passe. Les structures des entreprises, les meilleures pratiques et les procédures, ainsi que les manuels de maintenance, font également partie de la documentation de l'entreprise.
**Ce type de documentation fournit des instructions pour le développement de produits logiciels, des spécifications fonctionnelles, des spécifications techniques, de la documentation et des outils pour aider le développeur dans son travail.
Maintenant que nous comprenons mieux les différents types de documentation technique et de documentation sur les produits, examinons les premières étapes d'un processus solide de gestion de la documentation sur les produits.
Trouver un responsable du développement de la documentation produit
Un problème très courant consiste à déterminer qui doit être responsable de la documentation du produit, non pas comme quelqu'un qui se contente de la mettre à jour, mais comme quelqu'un qui est responsable de la qualité et du succès du produit.
Alors que certaines entreprises pensent que chaque propriétaire de produit et/ou gestionnaire de produit est responsable de la documentation produit, d'autres départements tels que le développement et le support peuvent également se voir confier la responsabilité de maintenir les manuels d'utilisation, les guides d'utilisation et toutes les facettes de la documentation produit à jour et efficaces.
Le développement de la documentation produit comporte de nombreux éléments mobiles, mais nous n'en soulignerons ici que deux :
-
Qui comprend le fonctionnement du produit à tous les niveaux (y compris les équipes chargées du développement du produit et des spécifications).
-
Ceux qui reçoivent des informations de la part des clients qui consultent la documentation du produit et écoutent leurs difficultés, leurs réactions et leurs préoccupations concernant la compréhension de la documentation du produit en question.
La première partie nous aide à créer la documentation produit attribuée avec les connaissances dont nous disposons, et celle-ci est envoyée au client qui, en retour, donne son avis et lance le deuxième processus qui permet d'optimiser la documentation.
Parfois, ces deux points ne sont pas parfaitement en place, ce qui crée des situations dans lesquelles la documentation du produit ne reçoit jamais l'attention nécessaire.
Une approche consiste à désigner une personne responsable de la "performance" de la documentation produit, des manuels produit et des guides de l'utilisateur. Prenons l'exemple d'un bon de commande dont le produit est la "documentation produit". Cette personne est chargée de passer en revue toutes les équipes de l'entreprise, de décrire la manière dont chaque produit génère ses guides et d'identifier les défis associés à ce processus.
L'objectif n'est pas que le propriétaire et le gestionnaire du produit soient entièrement responsables de la création et de la modification des manuels, mais qu'ils aident les membres de chaque équipe à gérer les documents.
Cette personne devrait étudier la manière dont les utilisateurs interagissent avec les documents, proposer des moyens de rendre les mises à jour plus fluides et recueillir des informations en retour afin de déterminer comment améliorer la documentation et les explications de chaque produit pour le public auquel il est destiné.
Le fait d'avoir une personne en charge de toutes les facettes de la documentation produit, de gérer le flux de travail et les différents départements qui doivent 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, dans l'ensemble, rationalisera la compréhension du produit.
Considérez la documentation de votre produit comme le produit lui-même.
Les produits existent pour offrir un degré de valeur qui satisfait ou dépasse les attentes du client. D'après les statistiques générées par D2WorldWide, 73,7 % des personnes estiment que la documentation est plus utile que les vidéos, l'emballage ou les vendeurs lorsqu'elles recherchent des informations sur les produits qu'elles envisagent d'acheter.
Tenez compte des facteurs qui contribuent à l'attrait d'un produit. Plusieurs facteurs peuvent influer sur l'attrait d'un produit, mais pour les besoins de cet article, nous nous concentrerons sur trois d'entre eux. Ils dépassent les attentes en termes de valeur, leur utilisation génère de la satisfaction et ils sont compétitifs.
En outre, les mêmes concepts s'appliquent à une bonne documentation en ligne sur les produits. Les documents sur les produits qui vont "au-delà de la valeur attendue" illustrent non seulement la manière d'utiliser l'article spécifié, mais proposent également des solutions dont le client n'a pas connaissance ou qu'il ne croit pas possibles. Il est toujours nécessaire de voir comment d'autres entreprises mettent en place leur documentation produit afin d'apprendre de leurs succès et de leurs erreurs.
Il ne sert à rien d'avoir une entreprise qui développe des logiciels uniques et de qualité, en avance sur la concurrence, si les développeurs et les clients qui intègrent vos documents techniques de produits ne sont pas en mesure de les comprendre.
Considérez que l'individu qui lit la documentation du produit peut ne pas être familier avec l'éventail des solutions possibles offertes par le produit ou avec le marché (comme c'est souvent le cas avec les produits techniques SaaS), et qu'il doit donc être "éduqué" à propos de ces solutions et des différentes options liées au produit.
Les documents relatifs au produit dont "l'utilisabilité génère la satisfaction" suivent un schéma de lecture logique adapté à leur public cible. Il ne sert à rien d'avoir le manuel le plus complet du monde s'il s'agit d'un PDF de 500 pages ou s'il ne comporte pas d'exemple de code et n'est pas créé dynamiquement avec des capacités de recherche et d'autres fonctions. Recueillez les réactions des utilisateurs de votre produit et de votre personnel d'assistance. Ils détermineront les principaux domaines de stress liés aux données rapportées.
Les documents produits compétitifs sont ceux qui sont continuellement mis à jour à l'aide des techniques d'échange d'informations les plus efficaces. Elles présentent des caractéristiques étonnantes telles que des capacités de recherche intégrées, des traductions, des versions différentes, des images et des vidéos intégrées, 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 s'il n'est pas accompagné d'une vidéo, d'images et de codes qui peuvent être copiés et collés pour faciliter l'utilisation par vos clients technophiles qui achètent vos produits SaaS techniques.
Il est toujours nécessaire de voir comment d'autres entreprises préparent leurs documents afin d'apprendre de leurs succès et de leurs erreurs.
Il ne sert à rien d'avoir une entreprise qui développe des logiciels uniques et de qualité, en avance sur la concurrence, si les développeurs et les clients qui intègrent vos documents ne sont pas en mesure de les appréhender dans leur intégralité.
Rétroaction sur la documentation du produit
Une documentation technique efficace améliore l'expérience de l'utilisateur final en améliorant le processus de compréhension des produits et en diagnostiquant tout problème à l'aide de solutions écrites facilement accessibles. Lorsque les clients ont confiance et comprennent comment utiliser vos produits, ils peuvent revenir vers vous à l'avenir lorsque le besoin s'en fait sentir.
[Une nouvelle étude réalisée par SDL (https://www.tcworld.info/e-magazine/technical-writing/technical-product-information-impacts-brand-perception-893/) montre que le rôle de la documentation sur les marchés mondiaux est en pleine expansion. L'étude [(https://www.tcworld.info/e-magazine/technical-writing/technical-product-information-impacts-brand-perception-893/)] montre qu'environ 53 % des acheteurs utilisent la documentation technique avant même d'avoir essayé le produit. De plus, une autre statistique compilée à partir de cette recherche montre que 94 % des acheteurs estiment qu'il est utile de disposer d'informations sur les produits en un seul endroit. C'est pourquoi, de nos jours, chaque entreprise accorde autant d'importance à la documentation sur les produits qu'au développement ou à l'essai des produits.
Même si la documentation a un propriétaire désigné qui gère l'équipe de documentation, qu'ils ont créé une documentation produit qui a été révisée et évaluée pour en améliorer la convivialité, et qu'elle a été correctement mise à jour, vous continuez à vous battre pour que vos utilisateurs et consommateurs comprennent vos produits techniques. Cela peut résulter de l'incapacité des utilisateurs/lecteurs à comprendre comment vos documents sont lus ou les questions qu'ils posent réellement. C'est pourquoi l'un des aspects les plus difficiles de la composition d'un document est de se mettre à la place du lecteur. Après tout, la personne qui produit la documentation du produit doit avoir une solide compréhension du produit.
Cette expertise peut amener le rédacteur à négliger des éléments qui ne sont pas évidents pour l'utilisateur moyen. Cela se produit généralement lorsque quelque chose d'évident pour les personnes qui créent le produit n'est pas tout à fait clair pour ceux qui l'achètent et l'utilisent.
Cela peut se produire de différentes manières :
Structure ou forme rédactionnelle: Bien que ce terme puisse sembler subjectif, la manière même dont un manuel est rédigé peut être source de confusion. Il est essentiel d'identifier le type de lecteur qui lit la documentation ; sinon, des mots tels que "Les développeurs préfèrent les exemples au texte descriptif" ou "Notre documentation n'est pas claire malgré la présence d'exemples et d'éléments visuels" peuvent apparaître.
Les sujets organisés dans les manuels: Occasionnellement, 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 un sentiment d'étrangeté.
Utilisation excessive de termes implicites: Dans un manuel, les abréviations peuvent avoir peu de sens, même s'il ne s'agit pas d'acronymes. Il est difficile de s'en rendre compte, mais certains mots, tels que "status", "id", "credentials", contiennent une signification implicite déguisée en explicite. Utilisez des désignations particulières, telles que "UserID", plutôt que "UID".
Traduction valide: la traduction est un élément essentiel de la portée mondiale. Souvent, les entreprises créent des manuels d'utilisation et de la documentation produit mal traduits, qui ne correspondent pas à la culture de certains pays ou dont les mots ne se traduisent pas de la même manière qu'en anglais dans ce pays particulier. La compréhension de ces nuances subtiles peut faire passer la documentation produit d'une information illisible à une documentation produit complète et traduite.
Pour éviter de telles situations, l'objectif est de développer une solution qui recueille et analyse les commentaires des utilisateurs et les schémas de navigation.
Les outils de retour d'information tels que Vocally a Docsie constituent un excellent moyen de recueillir et d'évaluer les schémas de navigation et d'étudier la manière dont vos clients perçoivent votre documentation produit. (Apprenez ici les 7 règles d'or de la collecte d'informations) (https://www.docsie.io/blog/articles/7-golden-rules-to-successfully-approach-customer-feedback/)
Ces informations sont essentielles pour mettre à jour et optimiser vos guides d'utilisation, vos manuels d'utilisation et votre documentation produit afin de créer une expérience plus transparente pour vos clients qui souhaitent découvrir vos produits. Rien n'est plus frustrant que de lancer un nouveau produit et de constater une augmentation des demandes d'assistance en raison d'instructions insuffisantes.
Comment rédiger une documentation produit complète
Une documentation produit de qualité est captivante, utile et puissante. Je dirais même qu'une documentation de qualité est un élément essentiel d'une bonne gestion des produits. Même si 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 produit étonnante et soignée que nos clients peuvent comprendre et utiliser pour approfondir leurs connaissances sur nos produits.
Que se passe-t-il avec la plupart des documents relatifs aux produits ?
De nombreux chefs de produit sont réticents à l'idée de rédiger des documents sur les produits. Les documents qu'ils connaissent bien risquent de ne pas trouver d'écho auprès de leurs clients si l'on ne prend pas soin de les rendre attrayants, faciles à lire et à comprendre.
Cependant, il arrive souvent que les entreprises ne prennent pas le soin nécessaire pour créer et rédiger une documentation produit étonnante. Une documentation produit médiocre est rédigée dans le seul but d'être écrite. Elle utilise des phrases expansives remplies d'idées vaguement acceptables et une mise en page médiocre pour décourager les utilisateurs d'interagir avec le document. Une documentation produit médiocre est créée pour protéger l'auteur des critiques et constitue une véritable perte de temps pour tout le monde. C'est aussi pour cette raison que les clients n'aiment pas la lire.
Comment remédier à cette situation et rédiger une meilleure documentation produit que nos clients prendront plaisir à lire ?
Une excellente documentation produit est rédigée dans l'intention d'être lue. Elle est succincte. Une bonne documentation produit est bien formatée et peut être lue et comprise par tous les membres de l'entreprise ou les clients en trois minutes. Elle évite le jargon et donne ou fait référence à un point de vue professionnel. Une excellente documentation produit passe du temps à décrire des cas d'utilisation spécifiques que les clients peuvent comprendre et appliquer à l'utilisation améliorée du produit. Elle suscite l'intérêt du lecteur et attire l'attention sur les problèmes sous-jacents grâce à des solutions bien conçues.
L'efficacité d'une documentation produit bien rédigée
Dans les petites, moyennes ou grandes entreprises, des documents techniques bien formatés sur les produits peuvent faire gagner beaucoup de temps et aider les employés à travailler de manière plus productive. C'est généralement le cas de la plupart des entreprises axées sur les produits, qui consacrent un pourcentage important de leur budget à l'embauche de rédacteurs techniques et à la rédaction de documents techniques sur les produits.
Si votre entreprise emploie plus de deux personnes pour créer de la documentation sur les produits, il est tout à fait utile d'instaurer une culture de la bonne documentation. Il existe de nombreuses raisons pour lesquelles vous souhaitez que votre équipe crée, gère et publie une documentation produit bien conçue, mais dans la section ci-dessous, nous verrons comment une documentation produit efficace constitue une approche peu coûteuse pour améliorer l'expérience des clients.
Une documentation produit efficace est une approche peu coûteuse pour améliorer l'expérience client
Une expérience client solide est la clé de voûte de la fidélisation des clients. La plupart des chefs de projet sont des optimistes : ils découvrent un concept, deviennent enthousiastes et l'exécutent. Bien que la passion soit admirable et que l'exécution semble productive, il est vital d'avoir un plan de match avant d'exécuter une documentation produit appropriée.
Les premières étapes après l'élaboration d'un plan de match consistent à lancer un cycle de conception et à structurer le contenu de la documentation produit de manière à ce qu'il soit progressivement facile à lire pour les clients.
En outre, l'obtention d'un retour d'information de la part des clients sur leur documentation actuelle est une étape essentielle pour restructurer les documents afin qu'ils correspondent aux besoins des clients. De cette manière, les chefs de projet peuvent créer, gérer, maintenir, publier et optimiser leur documentation avec perception et automatisation. Ce n'est pas une tâche simple et minuscule, et il est essentiel pour réussir d'avoir des outils étonnants comme Docsie qui automatise une grande partie des processus pour rendre la documentation produit efficace.
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 le produit correctement et l'utilisent correctement.
Toutes ces stratégies de création d'une documentation produit soignée conduiront essentiellement à des produits mieux notés, à des critiques plus favorables et à une augmentation des ventes.
Comment créer une documentation produit bien conçue
Comment produire une documentation efficace et favoriser une culture où elle est la norme ? La rédaction d'une documentation efficace est un défi, mais [Docsie ] (https://www.docsie.io/) offre de nombreuses fonctions intéressantes qui peuvent aider à lancer le processus de création de portails de documentation produits dynamiques et bien conçus. Voici un résumé de haut niveau de la façon dont nous abordons la question.
Maintenant, commençons :
La limitation du nombre de pages garantit la lisibilité. La rédaction d'un document décent ne devrait pas être difficile à lire et à traiter mentalement. Les phrases interminables et sinueuses sont souvent le signe d'un manque de clarté. Si la communication ne peut pas être résumée correctement sur une seule page, cela indique 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 la bâcle. Créez un modèle avec des sections, des tableaux et des en-têtes de document bien formatés. Il s'agit d'un investissement unique avec un potentiel de dividendes élevé.
Les modèles vous font gagner du temps. Il est beaucoup plus facile de supprimer une section d'un modèle que de se rappeler d'en ajouter une. Ce n'est pas de la condescendance, mais plutôt de l'efficacité et un gain de temps. Des sections simples qui rappellent au rédacteur de commencer par le contexte général et de préciser les mesures ou les hypothèses hasardeuses permettent une rédaction plus précise et une hiérarchie des décisions.
**Il n'y a pas de moyen plus sûr de démotiver votre personnel à produire une documentation de qualité que de ne pas lui faire de remarques. Les commentaires n'ont pas besoin d'être très intelligents ; ils doivent plutôt indiquer une implication et servir de modèle. Bien qu'il soit idéal de fournir des commentaires sous forme numérique afin que les autres membres de l'entreprise puissent bénéficier de la conversation de manière asynchrone, une simple fonction de Docsie vous permettant de commenter et de collaborer avec votre équipe est très utile à l'équipe de documentation produit !
Consultez ce blog pour en savoir plus sur la façon dont Docsie aide à la collaboration en matière de 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 exigences de votre entreprise. Comme de plus en plus de parties prenantes sont impliquées dans le processus de développement du produit, la communication doit être divisée en plusieurs documents (en particulier si le critère de concision d'une page doit être respecté). Docsie constitue une solution utile et durable pour les équipes de documentation de produits en pleine croissance.
Utiliser Docsie pour accélérer la création d'une documentation produit impressionnante
Docsie est une plateforme très pratique qui vous aide dans tous les aspects de la création d'une documentation produit et d'un portail de connaissances. Elle possède de nombreuses fonctionnalités intégrées qui rendent la création, la publication, la maintenance et la gestion des projets de création de documentation produit vraiment simples et amusantes ! Voici quelques-unes des fonctionnalités de Docsie qui peuvent vous aider à atteindre ces objectifs :
Capacité d'édition: Docsie permet à tous ses utilisateurs d'éditer la documentation produit après sa publication en créant une version alternative qui ne sera pas mise en ligne tant qu'elle n'est pas active. C'est génial parce que les équipes de gestion de produits peuvent travailler sur l'édition et la modification de la documentation produit et la mettre en ligne une fois qu'elles sont prêtes à le faire, sans avoir à sauter à travers des cerceaux HTML et CSS. Il suffit d'appuyer sur un bouton pour que la documentation produit soit automatiquement mise en ligne lorsqu'elle est prête.
Possibilité de recherche : Si la documentation de votre produit est abondante ou comporte de nombreuses fonctionnalités, le plugin de recherche Docsies est un bonus utile qui permet à vos clients de rechercher rapidement et facilement dans votre documentation les informations dont ils ont besoin afin d'accélérer le processus au cours duquel ils visualisent et absorbent les informations contenues dans la documentation de votre produit.
Possibilité de créer des liens : Docsie permet à votre documentation produit d'être optimisée pour le référencement. Vous pouvez créer des liens vers certaines pages du site web de votre entreprise ou simplement écrire des mots-clés basés sur vos produits qui seront consultables en ligne et attireront de nouveaux clients cherchant à trouver le même produit que celui que vous avez en place.
Possibilité d'avoir différentes traductions: Docsie est un traducteur fantôme à la pointe de la technologie qui permet à nos utilisateurs de traduire leur documentation produit dans différentes langues. De plus, grâce à la fonction de sélection de langue de Docsie, vos clients peuvent choisir la langue qui leur convient le mieux. Ceci est très utile pour atteindre une portée globale et pour étendre la base de clients des entreprises, tout en construisant une confiance avec leurs clients nouvellement créés et leurs clients à l'étranger.
La possibilité d'assigner des tâches et des commentaires pour une collaboration transparente : Docsie dispose d'outils exceptionnels pour collaborer avec votre équipe de documentation produit. Vous pouvez attribuer des commentaires, définir des tâches et attribuer des rôles afin de mieux gérer les tâches accomplies par les utilisateurs qui travaillent sur votre projet de documentation produit avec Docsie. [Pour en savoir plus, consultez ce blog ici] (https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/)
Génération de feedback : Savoir ce que vos clients pensent de votre documentation est la seule façon de savoir comment optimiser votre documentation produit pour répondre aux besoins de vos clients afin qu'ils puissent mieux comprendre vos documentations produit et vos portails de connaissances Pour en savoir plus sur l'importance du retour d'information sur la documentation produit, veuillez consulter mon blog ici.
Docsie vous permet, à vous et à votre équipe de gestion des produits, d'utiliser de nombreuses autres fonctionnalités et capacités pour créer une documentation produit exceptionnelle. Dans cet article, j'aimerais aborder les plugins que chaque portail de connaissances Docsie et chaque documentation produit peuvent ajouter à leurs documentations afin de les améliorer et de les rendre plus faciles à utiliser.
Docsie plugins pour rendre votre portail de documentation dynamique!Docsie dispose d'un grand nombre de plugins que vous pouvez utiliser pour rendre votre documentation plus attrayante. Dans ce blog, je le diviserai en 3 parties.
Dans cette section, nous allons diviser l'explication de ces plugins de portail de connaissances en trois parties.
PARTIE 1 : La première partie montrera ce que sont les plugins "Display Version Picker", "Display Language Picker", "Display Section Anchors", et "Display Footer Navigation".
PARTIE 2 : Dans cette partie, nous montrerons les plugins 'Code Highlighting', 'Search', et 'Share to Social Network'.
PARTIE 3 : Dans la troisième partie, nous présenterons les plugins 'Image Preview', 'Document Metadata', et 'Auto-highlight Section'.
Avant de nous lancer dans les plugins, nous allons voir comment accéder à ces plugins dans la plateforme Docsie.
Tout 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 Deployments, nous pouvons accéder aux plugins une fois que nous avons créé un nouveau Deployment via 'Configure a new deployment+'.
Cliquez ensuite sur "Plus d'options", ce qui vous permettra d'ajouter ces plugins à votre documentation déployée via un script intégré ou via le portail Docsie.
L'autre option est d'accéder aux plugins de portails de connaissances de Docsie via le bouton "Mettre à jour la configuration du déploiement" situé sous votre documentation déjà publiée.
Ce tableau de bord s'ouvrira et vous pourrez ajouter ou supprimer des plugins comme bon vous semble, puis mettre à jour le déploiement.
PART 1 :
Maintenant que nous savons comment accéder à Docsie Pluggin, passons à la PART 1.
Afin de voir la partie 1 le tutoriel vidéo, veuillez regarder cette vidéo ici :
Commençons par le "sélecteur de version d'affichage" et le "sélecteur de langue d'affichage".
Une fois que ces deux éléments sont actifs, ils apparaissent en bas à gauche de votre portail de connaissances sous forme d'onglets flottants. Ils permettent à vos clients et à ceux qui lisent la documentation de votre produit de l'afficher dans différentes langues et versions.
Lorsque l'utilisateur appuie sur le bouton "Langue" dans le sélecteur de langue, l'ensemble de la documentation qu'il est en train de lire est convertie dans la langue en question.
L'ancre "Display Section", une fois activée, permet à votre client d'avoir des liens à côté de chaque en-tête, ce qui lui permet d'accéder à certaines sections de la documentation.
Chaque fois que ces liens seront activés, une partie de l'en-tête changera et lorsque votre client copiera et collera ce code html, il dirigera la personne à qui il l'envoie vers cette section spécifique de la documentation.
L'étape suivante est "Afficher la navigation en bas de page
Ce plugin ajoute un bouton de navigation en bas à droite de votre livre de documentation. Il ressemble à ceci.
Vos clients pourront ainsi naviguer plus facilement dans votre documentation.
PART 2 :
Afin de voir la partie 2 le tutoriel vidéo, veuillez consulter cette vidéo ici :
Dans cette partie, nous montrerons les plugins "Code Highlighting", "Search" et "Share to Social Network".
Commençons par le plugin "Code Highlighting".
Ce plugin est idéal pour les produits techniques qui ont besoin d'exprimer différents codes à leurs clients. Ce plugin permet à leurs clients de copier et coller le code attribué afin qu'ils puissent l'utiliser sur leur éditeur pour une facilité d'utilisation en ajoutant un bouton "Copier".
Passons maintenant au plugin de recherche.
Une fois activé sur le portail de connaissances de votre Docsie, vos clients peuvent rechercher dans votre documentation via une navigation de recherche dans le coin supérieur droit du portail de connaissances.
En cliquant sur "recherche", vous ouvrirez un tableau de bord sophistiqué qui permettra à vos clients de savoir exactement où trouver certaines informations dans vos étagères et vos 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.
Vient ensuite le plugin Share To Social Networks
Ce plugin permet à vos clients d'extraire des sections surlignées de la documentation écrite de votre produit et de les partager sur leurs réseaux sociaux.
C'est une excellente chose car cela peut augmenter le trafic, le nombre de nouveaux clients potentiels et la confiance en votre marque.
PART 3:
Afin de voir la partie 3 le tutoriel vidéo, veuillez consulter cette vidéo ici :
Dans la troisième partie, nous présenterons les plugins "Image Preview", "Document Metadata" et "Auto-highlight Section".
Commençons par le plugin Image Preview
L'aperçu de l'image permet à vos clients d'agrandir ou de réduire l'image de la documentation de votre produit afin de mieux la visualiser.
L'élément suivant est "Métadonnées de la documentation
Cela permet à nos clients de voir un horodatage lorsque la documentation du produit ou certains aspects du portail de connaissances ont été mis à jour. Il sera situé en haut et en bas de la documentation écrite.
Voyons maintenant le plugin 'Auto-Highlight Section Plugin
Ce simple plugin permet à vos clients de savoir où ils en sont dans une documentation donnée du portail de connaissances.
Les clients de yo8ru pourront ainsi mieux repérer la section dans laquelle ils se trouvent et naviguer plus facilement vers d'autres sections.
Tous ces outils et bien d'autres encore vous sont fournis par la plateforme Docsie. Si vous ne l'avez pas encore essayée, nous vous conseillons de le faire. [Cliquez ici] (https://app.docsie.io/try/t/)
Si vous avez des questions, n'hésitez pas à nous contacter à l'adresse suivante : hello@docsie.io