Les guides de l'utilisateur sont un élément important de la prestation de services numériques. Les clients numériques s'attendent à un accès en libre-service, exigeant un accès immédiat à l'information. Une visite guidée par téléphone ne suffit plus ; il faut passer des heures à expliquer des choses qui pourraient être mieux illustrées dans des guides de documentation destinés aux utilisateurs.
Chez Docsie, nous préconisons que toutes les entreprises créent une bibliothèque de guides d'utilisation informatifs pour les clients. Cela permettra le libre-service, réduira votre charge de travail en matière d'assistance et fournira un accès en temps réel, 24 heures sur 24 et 7 jours sur 7, aux informations dont vos clients ont besoin pour profiter de votre produit ou service et y travailler.
10 conseils pour les guides d'utilisation et la documentation dans Docsie
Avant de commencer, avez-vous un moyen de stocker, d'écrire et d'héberger de la documentation ?
Rendez-vous sur la page Docsie Onboarding pour une collaboration centrée sur le client, une intégration étendue, des traductions sur mesure et une publication puissante du bout des doigts.
Maintenant que vous avez rejoint le club, passons à nos 10 meilleurs conseils !
1 - Enrichissez vos guides utilisateur avec des médias
Les textes, les mots, les lettres, nous les utilisons tous les jours. Malheureusement, l'écrit ne peut se comparer à la véracité d'une vidéo ou à l'inspiration d'une image.
Lorsque vous créez des guides de documentation pour les utilisateurs, lisez-les du point de vue de l'utilisateur. Cette section pourrait-elle être mieux expliquée par un GIF, une vidéo intégrée ou une image annotée ? Si oui, ajoutez-en une !
Vous pouvez ajouter des images, intégrer des vidéos et du contenu iFrame dans Docsie. Essayez-le !
Images, vidéos et GIFs dans Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_CdhFEVXwXaefNXxxg/boo_dqsfhc7ObadQ3xWmV/e0eda1c6-284a-3e0f-5c43-0ff4099966d0BlogGIF10TipsforUserGuides.gif)
2 - Créez un ordre, pas le genre Jedi!
Les instructions étape par étape sont le pilier de tous les livres de cuisine ! Lorsque vous suivez une recette, vous mélangez vos œufs avec votre farine ? C'est ce qu'il faut faire, et vous le savez parce que vous suivez les instructions !
Toute plaisanterie mise à part, assurez-vous de parcourir tous les guides d'utilisation contenant des instructions étape par étape. Si vous suivez ces étapes, obtenez-vous réellement le résultat escompté ? Des instructions imprécises qui ne permettent pas d'obtenir le résultat escompté constituent un signal d'alarme pour les clients. En revanche, des instructions précises inspirent confiance et apportent de la valeur aux clients et à l'entreprise grâce au partage d'informations.
Créez un ordre en utilisant les listes numérotées de Docsie ou les articles du livre Docsie pour segmenter votre documentation.
Articles, étagères et espaces de travail dans Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_O4Ux6ERzhyIS0eB1X/boo_dqsfhc7ObadQ3xWmV/aa925138-ab48-e18b-ff33-50557a2897cfArticlesShelvesWorkspacesinDocsie.png)
3 - S'adapter à tous les niveaux de lecture
Pensez-vous que les clients connaîtront leur JavaScript grâce à vos meilleurs conseils ? L'utilisation d'un jargon et d'une terminologie complexe est généralement recommandée dans le contexte des guides d'utilisation techniques. Pour les profanes, en revanche, plus le langage est simple, mieux c'est !
La plupart des lecteurs veulent simplement savoir comment faire une chose et la répéter. Une approche consiste à présenter un concept complexe de haut niveau sur papier, puis à le répéter dans une version simplifiée pour les non-spécialistes. Cette méthode permet de satisfaire à la fois les utilisateurs techniques et les non-spécialistes, en encrant deux pages avec un seul stylo.
"L'intelligence artificielle implique l'émulation algorithmique de l'intelligence humaine dans la recherche de la productivité ; l'intelligence artificielle vise à accomplir le travail en reproduisant l'intelligence humaine à l'aide d'un code informatique." - Les deux signifient la même chose, mais visent des publics différents.
Utilisez Docsie pour créer des étagères pour les profanes et des étagères pour les utilisateurs techniques. De cette façon, vous pouvez avoir des Livres pour aider les deux publics, avec un hébergement complet disponible via le portail Docsie.
[Un code complexe simplifié pour les profanes dans un exemple Docsie] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_cnLx3DDYwihXopx74/boo_dqsfhc7ObadQ3xWmV/411ea34c-096b-3bf2-fde0-2f8fdaddd55aLaypersonSimplificationforDocsie.png)
4 - Utilisez des modèles et arrêtez de vous coucher tard!
Faut-il réécrire chaque guide de l'utilisateur à partir de zéro ? Au lieu de cela, vous devriez créer des modèles avec une structure de base et un message de marque, et construire autour de ce contenu.
La rédaction à partir de zéro prend du temps, des efforts et risque de manquer de cohérence si plusieurs rédacteurs travaillent sur le même projet. Les modèles sont un excellent moyen de gagner du temps lors de la rédaction et de renforcer la cohérence entre les pages. La confiance se construit sur la cohérence des messages et la création de valeur, ce que les modèles favorisent.
Cliquez sur ...Plus et sélectionnez Modèles dans Docsie. Ici, vous pouvez stocker des modèles et commencer de nouveaux Livres en utilisant le modèle comme source !
!Modèle en direct dans l'éditeur Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_jdf9iWL3NXlFFePHx/boo_dqsfhc7ObadQ3xWmV/2bfcea18-df94-30ff-4931-799345e4ae74Templates2inDocsie.png)
5 - Ecrire vite, itérer souvent
Dans le développement de logiciels agiles, le mantra est d'échouer rapidement et d'itérer souvent. Si l'on applique ce principe aux guides de documentation utilisateur, votre personnel doit s'efforcer de rédiger rapidement et d'itérer souvent.
Cela ne signifie pas qu'il faille sacrifier la qualité à la rapidité. Au contraire, cela permet de recueillir les commentaires et les réponses des clients avec moins d'efforts initiaux. Ce retour d'information peut être exploité lors d'itérations ultérieures du guide de documentation utilisateur et aide l'entreprise à devenir plus centrée sur le client.
Docsie Vocally élucide les commentaires des lecteurs, avec des évaluations et des enregistrements d'écran pour déterminer le contenu exact qu'ils ont lu. Essayez-le si vous écrivez vite et si vous réalisez souvent des itérations !
Docsie Vocally Feedback View](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_8uO5DnYSHSsLteI2X/boo_dqsfhc7ObadQ3xWmV/b9f841c9-1dde-5eee-c723-809f13df3255DocsieVocallyLivePreview.png)
6 - Des connaissances imbriquées avec des backlinks internes
La documentation de votre guide de l'utilisateur est-elle liée à d'autres pages ? En ajoutant des liens vers des sections pertinentes de la documentation, vous aidez les lecteurs à étoffer et à comprendre votre produit ou service à un niveau conceptuel.
Lorsque vous faites référence à une caractéristique ou à une fonction spécifique, ajoutez toujours un lien. Permettez au lecteur d'accéder rapidement à cette information, plutôt que de l'obliger à chercher et à charger la page par lui-même. Vous parlez de l'ouverture d'un compte ? Ajoutez une URL de connexion au texte "Connectez-vous à votre compte" sur votre page et sur toutes les autres pages. Faites en sorte que votre documentation soit pratique et navigable dans le corps du texte, plutôt que de constituer une bibliothèque interminable à parcourir.
Docsie permet aux rédacteurs de guides d'utilisation de créer des liens internes. Il suffit de surligner du texte et de cliquer sur le bouton 🖇️ dans la barre d'outils de l'éditeur Docsie. En outre, vous pouvez faire en sorte que les liens ne dépendent pas de la langue ou de la version grâce aux liens d'objets relatifs.
Backlinking in Docsie With Object Reference Links](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_dclZdrsTWJrB8WETc/boo_dqsfhc7ObadQ3xWmV/7d8c9e37-3aa6-580d-644b-0d7a8039fa89DocsieObjectLinksforBacklinking.png)
7 - Brosser les toiles d'araignée et rafraîchir les anciens contenus
Avez-vous d'anciens guides de l'utilisateur et de la documentation visibles en ligne ? Si vous avez publié de la documentation sur la version 1.2 alors que votre produit en est à la version 1.3, cette documentation n'est plus pertinente. Plutôt que de publier une nouvelle documentation pour chaque version, utilisez Docsie Versioning.
Docsie Versioning permet aux utilisateurs d'accéder aux versions historiques et actuelles de la documentation. Au fur et à mesure que de nouvelles versions sont publiées, les anciennes versions sont archivées à des fins de redondance tout en étant accessibles à partir d'un menu déroulant. Le tout se trouve sur la même page web, ce qui permet aux utilisateurs de naviguer plus facilement et de trouver des informations pertinentes.
De même, si votre guide des meilleurs conseils pour 2021 est toujours publié en 2022, mettez-le à jour ! Changez le nom, actualisez les citations et les sources avec les recherches les plus récentes et vérifiez que les informations sont toujours pertinentes. Brossez les toiles d'araignée et gardez les choses à jour ; le contenu peut toujours être réutilisé.
8 - Miniaturiser les tâches, les réaliser par lots
Lorsque vous écrivez, écrivez-vous toute la page d'un seul coup sans aucune planification préalable ? Il s'agit en partie d'une question de préférence personnelle pour les rédacteurs. Toutefois, en miniaturisant les tâches, le travail peut être achevé plus rapidement et avec plus de concentration.
Créez une structure simple avec des balises H1 et H2 et de brèves descriptions pour chaque section. Utilisez cette structure lorsque vous rédigez, et attaquez-vous aux différentes sections plutôt que de vous préoccuper de l'ensemble de la page. C'est ce qu'on appelle un plan dans l'industrie de l'écriture. Le plan permet aux rédacteurs de donner leur avis avant le début de la rédaction et sert de cadre d'orientation pendant que le rédacteur écrit.
Créez un nouveau livre dans Docsie et ajoutez-y des en-têtes et du texte de base pour un plan. Vous pouvez également ajouter des tâches à l'aide du menu de droite, afin de diviser le travail en lots plus petits lorsque plusieurs membres de l'équipe collaborent au contenu. L'historique des versions vous permet de revenir en arrière si un rédacteur ajoute un contenu qui n'est pas très bon. C'est parfait pour écrire rapidement et faire des itérations fréquentes !
Calendrier pour les assignés de tâches dans Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_4JCx9FdXnyXu3quMX/boo_dqsfhc7ObadQ3xWmV/d3468298-7bc2-7f51-7afe-2437f6321658TaskMiniaturizeCalendarDocsie.png)
9 - Une table des matières pour des lecteurs de contenu plus nombreux
Dans le cas d'une documentation complexe et diversifiée, un mur de texte peut être intimidant pour les lecteurs. Ce problème peut être résolu à l'aide d'une table des matières complète. Couramment utilisée dans les encyclopédies, cette table des matières aide les utilisateurs à identifier et à accéder aux informations pertinentes, tout en structurant l'environnement d'un portail de connaissances.
Les articles, les étagères et les espaces de travail de Docsie permettent de créer une table des matières. Celle-ci s'affichera automatiquement sur le côté gauche de votre portail de connaissances, offrant ainsi un moyen facile de naviguer dans votre base de connaissances. Avec cette astuce, Docsie le fait pour vous !
Table des matières générée automatiquement par Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_oxDNcw0pA6rCZa3J7/boo_dqsfhc7ObadQ3xWmV/35d48662-895e-b83f-c7c3-abb0ce6edd0dTableofContentsDocsie.png)
10 - Maîtrisez votre sujet
Votre rédacteur est-il un expert en la matière ? De même, votre rédacteur est-il débrouillard et sait-il faire des recherches sur des sujets qu'il ne connaît pas ? En fin de compte, malgré tous nos conseils, c'est le rédacteur qui dicte la qualité de vos guides de documentation utilisateur.
Plus il comprendra votre produit, plus son travail sera précis. Donnez aux rédacteurs la possibilité de tester et de casser votre produit, car les utilisateurs peuvent rencontrer des problèmes similaires. Mieux encore, faites participer votre rédacteur à une démonstration du produit avec votre équipe de vente, et donnez-lui une expérience pratique du pipeline de vente et des messages qu'il contient. Cela permet de renforcer la cohérence, tout en transformant vos rédacteurs en utilisateurs. Tous les rédacteurs ne deviennent pas des utilisateurs, mais tous les utilisateurs peuvent devenir de bons rédacteurs grâce à leurs connaissances pratiques.
Mettez ces conseils en pratique dans Docsie!
Merci d'avoir lu nos 10 conseils pour de meilleurs guides d'utilisation. Nous vous invitons à les appliquer à vos documents Docsie !
Docsie est une plateforme de gestion documentaire de bout en bout que les entreprises utilisent pour créer des FAQ en ligne, des documents sur les produits, des guides d'utilisation, des documents d'aide et des manuels d'utilisation. La plateforme offre une collaboration centrée sur le client, une intégration étendue, des traductions sur mesure et une publication puissante au bout des doigts.
Passez à l'action en [s'inscrivant à Docsie] (https://app.docsie.io/onboarding/) dès aujourd'hui et offrez à vos clients une documentation de qualité !