Comment créer la meilleure documentation utilisateur

Il y a de fortes chances que si vos produits sont plus complexes qu'un rouleau de serviettes en papier, vous créez une sorte de documentation utilisateur pour aider les gens à apprendre à les utiliser.

Un manuel de produit ou un guide de l'utilisateur bien conçu et convivial peut faire la différence entre une expérience client fantastique et une expérience terrible.

De plus, la documentation utilisateur n'est pas réservée aux nouveaux utilisateurs.

Les clients expérimentés peuvent également se référer aux manuels d'utilisation ou aux guides de produits pour se rafraîchir la mémoire sur une fonctionnalité qu'ils n'ont pas souvent utilisée ou pour résoudre un problème spécifique qu'ils ont.

Pour cet article, nous nous concentrerons principalement sur les meilleures pratiques de création de documentation utilisateur pour des produits non physiques tels que des logiciels, mais la plupart (sinon la totalité) de ces conseils s'appliquent également au domaine matériel.

Voici ce que vous apprendrez :

• Qu'est-ce que la documentation utilisateur et pourquoi elle est importante.
• Comment la documentation de l'utilisateur final fait partie de l'expérience client.
• Comment une bonne documentation utilisateur peut aider à alléger le fardeau de votre équipe de support client.
• Pourquoi le contenu visuel est l'ingrédient secret de la meilleure documentation.
• Les éléments essentiels qui assurent la meilleure documentation utilisateur.
• Les quatre étapes pour créer une documentation qui ravira vos clients et résistera à l'épreuve du temps.

Qu'est-ce que la documentation utilisateur ?

La documentation utilisateur (également appelée manuels de l'utilisateur final, guides de l'utilisateur final, manuels d'instructions, etc.) est le contenu que vous fournissez aux utilisateurs finaux pour les aider à mieux utiliser votre produit ou service.

Ce sont les supports pédagogiques qui accompagnent votre produit pour aider quelqu'un à apprendre à l'utiliser correctement ou, dans le cas de produits physiques, même à l'assembler.

Si vous avez déjà assemblé un meuble IKEA, vous avez utilisé la documentation de l'utilisateur final.

Cependant, la documentation utilisateur prend de nombreuses formes.

Les jeux vidéo sont livrés avec des manuels pour vous dire sur quels boutons appuyer pour tirer sur les méchants. La documentation du logiciel vous montre ce que votre achat peut faire et comment le faire.

Les formulaires fiscaux sont accompagnés de guides sur la façon de les remplir correctement.

Les tondeuses à gazon et les souffleuses à neige ont des guides de produits pour vous montrer comment démarrer les moteurs et où faire le plein de carburant.

Passer à la création de la documentation utilisateur

Pourquoi la documentation utilisateur est-elle importante ?

Vous savez que votre produit est excellent. Vous voulez que vos clients le sachent aussi. La documentation utilisateur permet de s'assurer que vos clients ou utilisateurs apprennent réellement à tirer le meilleur parti de votre produit.

Qu'il s'agisse de savoir comment enregistrer un document, démarrer un moteur, utiliser un outil spécifique ou même des informations de sécurité importantes, votre documentation d'utilisateur final est une partie importante de votre relation avec vos clients.

La documentation utilisateur peut ravir vos clients

La documentation utilisateur est facile, n'est-ce pas ? Je veux dire, écrivez simplement quelques trucs sur la façon d'utiliser votre produit, et vous êtes prêt à partir !

Ce n'est pas si simple.

C'est plus qu'un simple matériel « comment faire ». Cela fait partie de l'expérience client. Et cela signifie que c'est aussi du matériel de marketing.

En tant que consommateur moi-même, j'ai expérimenté à la fois des guides d'utilisation formidables et horribles. Je parie que la plupart d'entre vous ont vécu des expériences similaires.

Un bon manuel d'utilisation ou un guide de produit montre à vos clients que vous vous souciez non seulement de savoir s'ils achètent votre produit, mais aussi s'ils ont une expérience vraiment formidable en l'utilisant.

Les clients qui pensent que vous vous souciez d'eux au-delà de leur portefeuille reviendront sans cesse vers vous.

Si vous voulez qu'ils crient au monde entier à quel point ils aiment vos produits et services, fournir une documentation utilisateur impressionnante est un élément essentiel de cette expérience post-achat.

Comment la documentation utilisateur soutient votre équipe de support

Les gens contactent souvent votre équipe d'assistance lorsque quelque chose ne fonctionne pas, mais ils peuvent également appeler lorsqu'ils ne peuvent tout simplement pas comprendre quelque chose. Avoir une excellente documentation utilisateur aide votre équipe de support de deux manières principales.

1. Leur donne un guide de référence facile

Une excellente documentation utilisateur ne doit pas seulement être destinée aux clients. Votre équipe de support produit peut utiliser la documentation pour mieux assister vos clients lorsqu'ils demandent de l'aide. Lorsque vous incluez des éléments essentiels, comme une table des matières ou un index, ils peuvent trouver rapidement les informations dont ils ont besoin. Et s'il s'agit d'un document électronique consultable, c'est encore mieux ! Nous en apprendrons plus à ce sujet plus loin dans l'article.

2. Réduit les appels

Comme indiqué ci-dessus, les gens appellent souvent l'assistance lorsqu'ils ne peuvent pas comprendre quelque chose. Mais, si les clients peuvent le découvrir eux-mêmes, ils sont beaucoup moins susceptibles d'avoir besoin d'aide. En fait, plus de 70 % des personnes préfèrent utiliser le site Web d'une entreprise pour obtenir de l'aide plutôt que d'obtenir de l'aide par téléphone ou par e-mail.

Même la meilleure documentation n'éliminera pas tous ces appels, mais la création de guides d'utilisation et de manuels clairs, complets et concis contribuera grandement à réduire le volume global des demandes d'assistance.

Quels sont les éléments essentiels d'une excellente documentation utilisateur ?

Même si chaque produit est unique et nécessitera des éléments différents pour créer des documents utilisateur vraiment géniaux, il existe des meilleures pratiques de documentation de l'utilisateur final à suivre quoi qu'il arrive.

Une excellente documentation utilisateur devrait inclure :

• Langage clair
• Simplicité
• Visuels
• Un focus sur le problème
• Une hiérarchie et un flux logiques
• Une table des matières
• Contenu consultable
• Contenu accessible
• Bon design
• Commentaires d'utilisateurs réels
• Liens vers d'autres ressources

Langage clair

Rien ne frustrera plus un client que de lire quelque chose qu'il ne peut pas comprendre. Personne ne veut se sentir stupide, et un langage qui fait ressentir cela à votre client n'est certainement pas un moyen de favoriser une expérience formidable.

Utilisez un langage simple et clair dans la mesure du possible pour aider vos clients à comprendre même les concepts les plus complexes.

Rappelez-vous, écrivez pour l'utilisateur, pas pour le développeur.

Cela ressemble à une évidence, mais écrire en langage simple sur un produit ou un service que vous connaissez est plus difficile que vous ne le pensez. Vous connaissez toutes sortes de jargons, d'acronymes et d'autres informations « d'initiés » que les clients ne connaissent probablement pas. Il est naturel que vous l'utilisiez.

Mais c'est là que vous pouvez rencontrer de sérieux problèmes.

Ne présumez pas que votre client sait quoi que ce soit sur votre produit. Ne présumez pas qu'ils connaissent tous les mots à la mode techniques et/ou industriels que vous utilisez probablement tous les jours dans votre bureau.

N'écrivez pas comme s'ils étaient des enfants, mais comprenez qu'ils peuvent avoir besoin d'une aide supplémentaire pour vraiment se mettre au courant. Rédigez la documentation d'une manière facile à lire.

Simplicité

Gardez la documentation aussi simple que possible pour atteindre son objectif. Cela s'applique à la fois au contenu du document et à sa conception. De longs blocs de texte et des pages étroitement remplies de contenu écrit et graphique peuvent rendre les guides d'utilisation ou les manuels intimidants et peu conviviaux.

Les clients intimidés par votre matériel utilisateur sont beaucoup plus susceptibles d'appeler votre équipe d'assistance pour obtenir de l'aide que d'essayer de résoudre leurs questions par eux-mêmes. De plus, ils sont beaucoup moins susceptibles d'avoir une bonne expérience client.

Visuels

La meilleure documentation utilisateur illustre parfaitement l'expression « montrez, ne dites pas ».

Le contenu visuel, y compris les images, les captures d'écran annotées, les graphiques et les vidéos, montre rapidement à quelqu'un comment fonctionne votre produit. Ils n'ont pas besoin de lire à ce sujet : ils peuvent le voir !

Des recherches récentes de TechSmith montrent que les gens absorbent en fait les informations visuelles plus rapidement et exécutent mieux les tâches lorsque les instructions sont fournies avec un contenu visuel ou vidéo.

Le contenu visuel aide également à diviser de longs blocs de texte et peut aider à éliminer une grande partie du texte qui rend de nombreux guides d'utilisation ou manuels intimidants et désagréables.

Les moyens populaires d'inclure du contenu visuel dans la documentation utilisateur incluent les captures d'écran, les enregistrements d'écran, les didacticiels vidéo, etc.

Avez-vous entendu parler de graphismes simplifiés ? Parfois appelés interface utilisateur simplifiée (ou SUI), les graphiques simplifiés prennent des images d'une interface utilisateur ou d'un autre graphique et, comme leur nom l'indique, les simplifient. Cette version plus basique met en évidence les informations les plus essentielles tout en réduisant le texte et les graphiques qui ne sont pas importants pour les formes plus simples.

Donc, quelque chose qui ressemble à ça :

Ressemble maintenant à ceci :

Si j'essayais de montrer à quelqu'un comment sélectionner l'élément de menu Connecter un appareil mobile, la deuxième image supprime tout l'encombrement et permet aux yeux du client de se concentrer là où ils doivent être.

Il y a de fortes chances que vous ayez déjà rencontré des graphiques simplifiés sans même vous en rendre compte, comme celui-ci du centre de formation G Suite :

Il existe de nombreux outils, mais si vous recherchez des moyens puissants et simples de créer des captures d'écran et des enregistrements d'écran, je vous recommande vivement de télécharger une version d'essai gratuite de Snagit.

Concentrez-vous sur le problème à résoudre

Chaque produit résout un problème. Mais trop souvent, nous aimons tellement les fonctionnalités de nos produits que tout ce que nous voulons faire, c'est mettre en évidence ce qu'ils peuvent faire plutôt que pourquoi nos clients en ont besoin.

Assurez-vous de montrer aux utilisateurs comment effectuer des tâches avec votre produit.

Naturellement, cela impliquera les caractéristiques du produit, mais mettez-les en évidence dans le contexte d'aider l'utilisateur à comprendre la raison pour laquelle il a acheté votre produit en premier lieu - pour résoudre un problème spécifique.

Par exemple, nos didacticiels Camtasia et Snagit (oui, les didacticiels vidéo peuvent être une forme de documentation) mettent en évidence des fonctionnalités spécifiques, mais ils le font dans le contexte de la raison pour laquelle quelqu'un pourrait utiliser cette fonctionnalité particulière. Il s'agit du pourquoi, pas seulement du comment.

Voici un excellent exemple…

Hiérarchie et flux logiques

Une bonne documentation a besoin d'une hiérarchie de titres et de sous-titres qui permet à l'utilisateur de savoir ce que chaque section lui montrera. Et cette hiérarchie doit suivre un flux logique qui aide l'utilisateur à apprendre à utiliser votre produit de la manière la plus utile.

Par exemple, vous ne souhaitez probablement pas commencer votre documentation en montrant aux clients comment utiliser les fonctions les plus avancées sans leur avoir d'abord montré les bases du fonctionnement de votre produit. Commencez d'abord par les choses simples, puis, au fur et à mesure que vos utilisateurs approfondissent leurs connaissances, montrez-leur les fonctionnalités avancées.

Table des matières

Une table des matières offre à vos clients un moyen simple, efficace et familier de trouver rapidement une solution à leur question ou problème. C'est juste au début du document, ils n'ont donc pas à parcourir des pages de texte pour trouver ce qu'ils recherchent. Il doit inclure tous les principaux titres et sous-titres décrits ci-dessus.

Rendez-le consultable

Il fut un temps où la plupart des documentations utilisateur étaient imprimées. Aujourd'hui, à une époque où presque tout le monde a accès à un smartphone, il est plus logique de créer une documentation électronique. Cela ne signifie pas que vous ne pouvez pas créer de versions imprimées également, mais une version électronique offre un certain nombre d'avantages dont nous parlerons plus en détail ci-dessous.

Comme une table des matières, le contenu interrogeable permet aux utilisateurs d'accéder plus facilement à votre contenu et les aide à trouver des solutions par eux-mêmes.

Accessibilité

Créer du contenu accessible. Cela signifie s'assurer que la documentation électronique respecte les normes d'accessibilité pour les personnes qui peuvent être aveugles ou malvoyantes, sourdes ou malentendantes, ou qui peuvent avoir des troubles cognitifs.

N'oubliez pas que nombre de vos clients en ont besoin pour comprendre et accéder pleinement à votre documentation utilisateur. Ne les laissez pas derrière vous !

Bon design

Donnez à vos utilisateurs un document qu'ils souhaitent consulter et ils seront plus susceptibles de l'utiliser.

Concevez des matériaux en pensant à vos clients. Rendez-le utilisable et convivial. Évitez les longs paragraphes de texte ou les pages trop remplies de contenu. Prévoyez un espace blanc pour aider à briser la monotonie et rendre la perspective d'apprendre un nouveau produit moins intimidante.

Incluez autant que possible des graphiques et des images pour montrer plutôt que de dire à vos clients comment utiliser votre produit. Pour la documentation électronique, utilisez la vidéo et les GIF.

Utilisez des polices cohérentes et des couleurs complémentaires sur plusieurs documents. Si votre organisation dispose d'un guide de style (que je recommande vivement de créer s'il n'en existe pas déjà), assurez-vous que votre documentation y adhère.

Les modèles Snagit facilitent la création d'une documentation utilisateur de qualité professionnelle à partir d'une série de captures d'écran ou d'autres images. Rassemblez simplement les images dont vous avez besoin, choisissez Créer, puis Image à partir d'un modèle, et vous êtes sur la bonne voie.

Snagit est livré avec un tas de modèles gratuits et conçus par des professionnels, et avec TechSmith Assets for Snagit, vous avez accès à une tonne de plus !

Commentaires d'utilisateurs réels et/ou de bêta-testeurs

Vous ne pouvez pas créer une documentation utilisateur vraiment excellente tant que vous n'avez pas écouté les personnes extérieures à votre organisation qui utilisent réellement les produits.

Apprenez leurs points faibles et essayez de les résoudre du mieux que vous pouvez. Découvrez ce qu'ils vous disent qu'il faut savoir pour utiliser au mieux vos produits. Bien que certaines d'entre elles puissent sembler évidentes, je vous garantis que vous apprendrez des choses que vous n'avez même jamais envisagées.

Liens vers d'autres documents

Assurez-vous que vos clients ont accès à davantage de ressources de votre organisation sur la façon de réussir avec vos produits. Pour la documentation utilisateur électronique, cela peut être aussi simple que de fournir des liens vers des didacticiels, des FAQ, des forums d'utilisateurs, etc.

Mais même la documentation imprimée peut inclure des éléments tels que des adresses de sites Web et des numéros de téléphone pour une assistance supplémentaire.

Prime! Ajouter des instructions pas à pas

Les guides étape par étape permettent d'éviter les longs blocs de texte et offrent un moyen beaucoup plus clair de montrer un processus que d'essayer de l'expliquer uniquement par le texte. Ils sont plus faciles à suivre, plus faciles à comprendre et offrent une expérience beaucoup plus conviviale que de simplement dire à quelqu'un comment accomplir une tâche.

Et n'oubliez pas que l'inclusion de contenu visuel dans vos instructions étape par étape les rend encore meilleures.

Snagit fournit un outil étape par étape facile à utiliser qui vous aide à créer une excellente documentation étape par étape. De plus, l'outil Combiner des images vous permet de combiner des captures d'écran individuelles et d'autres images en une seule image pour faciliter l'édition et le balisage.

Comment créer une excellente documentation utilisateur

Étape 1 : planifier

Chaque grand ensemble de documents utilisateur commence par un plan. Voici quelques conseils pour vous rendre là où vous voulez aller.

Savoir par où commencer

Beaucoup de gens supposent que si vous connaissez votre produit, vous pouvez simplement commencer à créer votre documentation. Mais il y a beaucoup plus que cela. Au lieu de cela, commencez par un plan pour vous assurer que vous aidez réellement vos utilisateurs.

Avant de créer une documentation, voici quelques éléments à prendre en compte :

• Que devez-vous inclure ? Que devez-vous laisser de côté ? (Astuce : c'est là que les commentaires des utilisateurs peuvent être VRAIMENT utiles !)
• Dans quel ordre doit-on présenter les informations ? (Vous vous souvenez des plans de dissertation de l'école ? Utilisez-les !)
• Quelles autres ressources seront disponibles ? Comment allons-nous fournir un accès/des liens vers ceux-ci ?
• Qui est responsable de la création du document ? Qui est responsable des commentaires sur le document ? Qui a l'approbation finale ?
• Cela devra-t-il être traduit ou localisé ?

Les réponses à ces questions façonnent la façon dont vous créez votre documentation. La planification garantit un processus fluide et un meilleur document utilisateur.

Connaissez votre produit

Assurez-vous de connaître votre produit.

Cela ne signifie pas que vous devez être l'expert absolu en tout, mais toute personne créant un manuel d'utilisation ou un guide d'utilisation doit avoir une expérience pratique du produit.

Fiez-vous à vos experts en la matière pour obtenir des connaissances plus approfondies, mais vous devez savoir comment les utiliser vous-même avant d'essayer d'enseigner à quelqu'un d'autre.

Choisissez votre formule

De plus, le format final d'un document est tout aussi important. Sera-t-il uniquement imprimé ? Sera-t-il électronique ? Si oui, où vivra-t-il ?

Il n'y a pas si longtemps, presque toute la documentation utilisateur était imprimée uniquement. Cependant, à moins que vous n'ayez une très bonne raison, je vous recommande d'avoir au moins une version électronique disponible sur votre site Web.

La plupart des utilisateurs ont un accès 24 heures sur 24 aux smartphones, ordinateurs ou tablettes, et ils ont l'habitude de trouver tout ce qu'ils veulent savoir quand ils le veulent. La mise en ligne des ressources utilisateur leur donne accès où qu'ils se trouvent, ce qui signifie qu'ils n'ont pas à chercher dans des tiroirs ou des classeurs pour trouver un manuel d'utilisation qu'ils n'ont pas vu depuis des années.

De plus, il est tout simplement plus facile de rendre la documentation électronique accessible aux personnes handicapées. Une version imprimée uniquement fonctionnera pour la plupart des gens, mais êtes-vous prêt à créer une version en braille pour les utilisateurs qui pourraient être aveugles ou malvoyants ? Qu'en est-il des utilisateurs qui ont un handicap physique où il leur est difficile de manipuler des objets avec leurs mains ?

Des outils existent pour rendre la documentation électronique plus facile d'accès pour tous, mais les versions imprimées uniquement posent un problème d'accessibilité beaucoup plus difficile.

De plus, la documentation électronique est beaucoup plus facile à mettre à jour, car elle vit sur le Web.

Dois-je faire de ma documentation un PDF ?

Si vous souhaitez proposer une version PDF téléchargeable de votre documentation, c'est très bien. Mais assurez-vous qu'il est également disponible sur votre site Web dans un format non PDF.

Étape 2 : Créez votre document utilisateur

Une fois que vous avez répondu à toutes les questions et pris toutes les décisions décrites ci-dessus, il est temps de créer votre documentation utilisateur. Je ne vais pas prétendre vous dire EXACTEMENT comment créer la documentation pour votre produit spécifique, mais il y a quelques éléments clés à garder à l'esprit.

• Évitez le jargon et les termes très techniques sauf lorsque cela est absolument nécessaire (et assurez-vous ensuite de les définir).
• Évitez les acronymes à moins que vous n'expliquiez ce qu'ils signifient.
• Utilisez un style d'écriture communément reconnu, tel que AP ou Chicago, dans la mesure du possible. Si votre organisation dispose d'un guide de style d'entreprise, utilisez-le.
• Ne présumez pas que l'utilisateur sait quoi que ce soit sur votre produit ou ce qu'il fait. MONTREZ-leur ce qu'ils doivent savoir pour réussir.
• N'oubliez pas d'utiliser un langage simple. Écrivez pour un niveau de huitième année ou moins. Même pour les lecteurs avancés, un langage simple conduit à un traitement plus rapide et à une meilleure compréhension.
• Le design doit être agréable, non intimidant et attirer l'utilisateur. Donnez-leur envie d'utiliser votre documentation.

Étape 3 : testez-le

Un guide de l'utilisateur n'est utile que s'il aide vos clients à utiliser votre produit au mieux de leurs capacités. Et vous ne pouvez pas le savoir tant que quelqu'un ne l'utilise pas. Avant que votre nouvelle création ne sorte dans le monde entier, vous voulez la tester. Voici quelques conseils !

• Meilleure pratique : donnez-le à un groupe d'utilisateurs réels ou de bêta-testeurs et voyez comment ils s'en sortent. Incorporez leurs commentaires dans le document final.
• Si vous n'avez pas de commentaires des utilisateurs sur les tests bêta, testez-les en interne, de préférence avec des employés qui connaissent le moins bien le produit.
• Obtenez les commentaires des développeurs et des ingénieurs. Ils connaissent le produit mieux que quiconque et peuvent vous signaler des choses que vous avez peut-être manquées.

Étape 4 : Maintenez votre documentation à jour

Lorsque votre produit change, vous devez tenir à jour la documentation utilisateur. Comme indiqué ci-dessus, cela donne à la documentation électronique un énorme avantage sur l'imprimé. Cependant, même les documents imprimés uniquement peuvent être mis à jour et mis à disposition pour téléchargement sur votre site Web.

N'oubliez pas que votre contenu n'est bon que s'il est exact. Assurez-vous que ce que vous offrez à vos clients les aide réellement à utiliser votre produit.

Résumé

Si vous ne vous souvenez de rien d'autre, gardez à l'esprit qu'une excellente documentation utilisateur doit être créée, conçue et présentée de la manière la plus utile pour vos utilisateurs .

Donnez-leur une documentation qui continue de les ravir et offre le type d'expérience client que vous souhaitez avoir.

Rendez votre documentation accessible, utile et visuelle.

Poser fréquemment des questions