Voici comment Construire la meilleure Documentation utilisateur

Il est probable que si vos produits sont plus complexes qu’un rouleau de papier essuie-tout, vous créez une sorte de documentation utilisateur pour aider les gens à apprendre à les utiliser.

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

Et, la documentation utilisateur n’est pas seulement pour les nouveaux utilisateurs.,

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

Pour cet article, nous nous concentrerons principalement sur les meilleures pratiques pour créer de la documentation utilisateur pour des produits non physiques tels que les logiciels, mais la plupart, sinon la quasi-totalité, de ces conseils s’appliquent également au domaine des produits physiques.

Voici ce que vous apprendrez:

• qu’est-Ce que la documentation de l’utilisateur et pourquoi est-il important?
• 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 ravit vos clients et résiste à l’épreuve du temps.

qu’est-Ce que la documentation de l’utilisateur?

Documentation de l’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 à avoir plus de succès avec votre produit ou service.

ce sont les matériaux d’enseignement qui vont avec votre produit pour aider quelqu’un à apprendre à l’utiliser correctement ou — dans le cas de produits physiques — même mis ensemble.,

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

Mais la documentation utilisateur prend plusieurs formes.

Les jeux vidéo sont livrés avec des manuels pour vous dire quels boutons appuyer pour tirer sur les méchants. 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ù recharger le carburant.

Passez à la façon de faire de la documentation utilisateur

Pourquoi la documentation de l’utilisateur important?

Vous savez que votre produit est génial. 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 sauvegarder un document, de démarrer un moteur, d’utiliser un outil spécifique ou d’informations de sécurité importantes, votre documentation utilisateur final est une partie importante de votre relation avec vos clients.

Il peut ravir vos clients

La documentation utilisateur est facile, non? Je veux dire, il suffit d’écrire quelques trucs sur la façon d’utiliser votre produit et vous êtes prêt à partir!

Ce n’est pas tout à fait aussi simple que cela.

C’est plus que du « comment faire” du matériel. 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 connu des guides d’utilisation à la fois géniaux et horribles. Je parie que la plupart d’entre vous ont eu des expériences similaires.

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

Et les clients qui pensent que vous vous souciez d’eux au-delà de leur portefeuille continueront à revenir vers vous.,

Si vous voulez qu’ils crient au monde à quel point ils aiment vos produits et services, fournir une documentation utilisateur impressionnante est une partie essentielle de cette expérience post-achat.

Comment la documentation utilisateur prend en charge votre équipe de support

Les gens contactent votre équipe de support quand quelque chose ne fonctionne pas, mais ils appellent aussi quand ils ne peuvent 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 aider à mieux soutenir vos clients lorsqu’ils appellent. Lorsque vous incluez des éléments essentiels tels qu’une table des matières ou un index, ils peuvent rapidement trouver 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 tard dans l’article.

2. Réduit les appels

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

Maintenant, même la meilleure documentation n’éliminera pas tous ces appels, mais la création de guides d’utilisation et de manuels complets, faciles à comprendre, clairs et concis contribuera grandement à réduire le volume global d’appels, d’e-mails, de chats, etc.

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

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

Une excellente documentation utilisateur devrait inclure:

• Langage simple
• 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 des utilisateurs réels
• Liens vers d’autres ressources

Langage simple

Rien ne frustrera un client plus que de lire quelque chose qu’il ne peut Personne ne veut sentir stupide., Faire en sorte que votre client se sente de cette façon n’est certainement pas un moyen de favoriser une grande expérience.

Utilisez un langage simple et simple 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 semble être une évidence, mais écrire en langage clair sur un produit ou un service que vous connaissez de face à face est beaucoup plus difficile que vous ne le pensez. Vous connaissez toutes sortes de jargon, d’acronymes et d’autres informations « d’initiés” que les clients ne connaissent probablement pas. Il est naturel pour vous de l’utiliser.,

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

Ne supposez pas que votre client sait quoi que ce soit sur votre produit. Ne supposez pas qu’ils connaissent tous les mots à la mode techniques et/ou industriels que vous utilisez probablement tous les jours à l’intérieur de votre bureau. Écrire pour eux.

N’écrivez pas comme s’ils étaient des enfants, mais comprenez qu’ils peuvent avoir besoin d’aide supplémentaire pour les mettre vraiment à niveau. Écrivez la documentation d’une manière facile à lire.

Simplicité

le Garder aussi simple que possible pour atteindre son but. Cela s’applique aussi bien au contenu du document qu’à sa conception., De longs blocs de texte et des pages étroitement emballés avec du contenu écrit et graphique peuvent rendre les guides ou les manuels de l’utilisateur intimidants et hostiles.

Les clients qui sont intimidés par vos documents 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. Et, ils sont beaucoup moins susceptibles d’avoir une bonne expérience client.

Visuels, visuels, visuels

La meilleure documentation utilisateur illustre parfaitement l’adage « montrer, ne pas dire., »

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

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

contenu Visuel contribue également à briser les longs blocs de texte et peut aider à éliminer beaucoup de texte qui peut faire beaucoup de guides d’utilisation ou les manuels intimidant et désagréable.

Les moyens populaires d’inclure du contenu visuel dans la documentation utilisateur incluent des captures d’écran, des enregistrements d’écran, des vidéos de didacticiels, etc.

Avez-vous entendu parler de graphiques simplifiés?, Parfois appelé interface utilisateur simplifiée (ou SUI), les graphiques simplifiés prennent des images d’une interface utilisateur ou d’un autre graphique et — comme son nom l’indique — les simplifie. 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 à ceci:

ressemble Maintenant à ceci:

Si je devais essayer de montrer à quelqu’un comment sélectionnez la connexion de l’Appareil Mobile de l’élément de menu, la deuxième image supprime tous l’encombrement et permet au client les yeux pour se concentrer là où ils doivent être.

Il y a de fortes chances que vous ayez déjà rencontré des graphiques simplifiés et que vous ne vous en rendiez même pas compte.,

Comme celui-ci de G Suite Learning Center:

Il existe de nombreux outils, mais si vous cherchez des moyens puissants et faciles de créer des captures d’écran et des enregistrements d’écran, je recommande fortement de télécharger un essai gratuit de Snagit.

l’Accent sur le problème à résoudre

Chaque produit résout un problème., Mais trop souvent, nous sommes tellement amoureux de nos fonctionnalités de produit cool, tout ce que nous voulons faire est de mettre en évidence ce qu’il peut 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 des caractéristiques du produit, mais le faire dans le contexte d’aider l’utilisateur à obtenir pour la raison qu’ils ont acheté votre produit en premier lieu — pour résoudre un problème spécifique.,

Par exemple, nos tutoriels Camtasia et Snagit (oui, les vidéos de tutoriel 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é. Il s’agit du pourquoi, pas seulement du comment.

Voici un excellent exemple

Hiérarchie logique et flux

Une bonne documentation nécessite une hiérarchie d’en-têtes et de sous-titres qui permet à un utilisateur de savoir ce que chaque section leur 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 voulez probablement pas commencer votre documentation en montrant à vos clients comment utiliser les fonctions les plus avancées sans d’abord leur montrer les bases du fonctionnement de votre produit. Commencez d’abord par les choses faciles, puis, au fur et à mesure que vos utilisateurs développent 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 afin qu’ils n’aient pas à passer au crible les pages de texte pour trouver ce qu’ils recherchent. Il devrait inclure toutes les principales positions et sous-positions décrites ci-dessus.

le Rendre consultable

Il fut un temps où la plupart des utilisateur de la documentation imprimée., Maintenant, à une époque où à peu près tout le monde a accès à un smartphone, il est plus logique de créer de la documentation électronique. Cela ne signifie pas que vous ne pouvez pas créer de versions imprimées, mais une version électronique offre un certain nombre d’avantages que nous verrons 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 beaucoup de vos clients en ont besoin pour comprendre et accéder pleinement à votre documentation utilisateur. Ne les laissez pas derrière!

Bon design

offrez à vos utilisateurs un document qu’ils veulent regarder et ils seront plus enclins à l’utiliser.

Concevez des matériaux en pensant à vos clients. Le rendre utilisable et convivial., Évitez les longs paragraphes de texte ou les pages trop remplies de contenu. Prévoyez des espaces blancs pour aider à briser la monotonie et à rendre la perspective d’apprendre un nouveau produit moins intimidante.

Incluez des graphiques et des images autant que possible pour montrer plutôt que de dire à vos clients comment utiliser votre produit. Pour la documentation électronique, utilisez des vidéos et des 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 vous recommande vivement), assurez-vous que votre documentation y adhère.,

Snagit templates rend incroyablement facile la création d’une documentation utilisateur d’apparence 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 et Image à partir du modèle et vous êtes sur votre chemin.

Snagit est livré avec un tas de modèles gratuits, 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 de documentation utilisateur vraiment géniale tant que vous n’avez pas écouté les personnes extérieures à votre organisation qui utilisent réellement les produits.,

Apprenez leurs points douloureux et essayez de les aborder du mieux que vous le pouvez. Découvrez ce qu’ils vous disent qu’ils doivent savoir pour utiliser au mieux vos produits. Bien que certaines d’entre elles puissent être é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 à plus de ressources de votre société 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 tutoriels, des FAQ, des forums d’utilisateurs, etc.,

Mais même la documentation imprimée peut inclure des choses comme les adresses de site Web et les numéros de téléphone pour une assistance supplémentaire.

Bonus! Ajouter des instructions étape par étape

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

Et rappelez-vous, inclure du contenu visuel dans vos instructions étape par étape les rend encore meilleurs.

Snagit fournit un outil Étape super 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 faire pour créer une grande documentation utilisateur

Étape 1: Plan

Chaque grand ensemble de documents de l’utilisateur commence par un plan., Voici quelques conseils sur la façon d’obtenir où vous allez.

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 qui va dans ce. Au lieu de cela, commencez par un plan pour vous assurer que vous aidez réellement vos utilisateurs.

Avant de faire de la documentation, voici quelques éléments à considérer:

• Que devez-vous inclure? Que devriez-vous laisser? (Astuce: C’est là que les commentaires des utilisateurs peuvent être vraiment utiles!)
• Dans quel ordre devrions-nous présenter les informations?, (Rappelez-vous les grandes lignes de l’essai du collège? Utilisez ‘em!)
• Quelles autres ressources seront disponibles? Comment allons-nous fournir un accès/des liens à ceux-ci?
• Qui est responsable de la création du document? Qui est responsable de la rétroaction 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.

Connaître votre produit

assurez-vous de connaître votre produit.,

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

Compter sur vos experts en la matière pour une connaissance plus approfondie, pour sûr, mais vous devez savoir comment l’utiliser vous-même avant d’essayer de l’enseigner à quelqu’un d’autre.

Choisissez votre format

en Outre, un document de format final est tout aussi important. Il sera à l’impression? Il sera électronique? Si oui, où est-il vivre?,

Il n’y a pas si longtemps, presque toute la documentation utilisateur était imprimée uniquement. Mais, sauf si vous avez une très bonne raison, je recommande au moins d’avoir 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 veulent le savoir. Mettre les ressources utilisateur en ligne leur donne accès où qu’ils soient, ce qui signifie qu’ils n’ont pas à chercher dans les tiroirs ou les 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 seulement fonctionnera pour la plupart des gens, mais êtes-vous prêt à créer une version braille pour les utilisateurs qui peuvent ê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 seulement 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.

Si vous voulez offrir une version PDF téléchargeable de votre documentation, c’est 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ésumer de vous dire exactement comment créer la documentation pour votre produit spécifique, mais il y a des choses clés à garder à l’esprit.

• Évitez le jargon et les termes très techniques sauf lorsque cela est absolument nécessaire (et assurez-vous de les définir).
• Évitez les acronymes sauf si vous expliquez ce qu’ils signifient.
• Utilisez un style d’écriture communément reconnu comme AP ou Chicago dans la mesure du possible., Si votre organisation dispose d’un guide de style d’entreprise, utilisez-le.
• Ne supposez pas que l’utilisateur sache quoi que ce soit à propos de votre produit ou de ce qu’il fait. MONTREZ-leur ce qu’ils doivent savoir pour réussir.
• n’oubliez pas d’utiliser un langage clair. Écrivez pour un niveau de huitième année. Même pour les lecteurs avancés, un langage simple permet 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 excellent que s’il aide vos clients à utiliser votre produit au mieux de leurs capacités. Et vous ne pouvez pas le savoir jusqu’à ce que quelqu’un l’utilise. Avant que votre nouvelle création ne sorte dans le monde en général, 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 le font. Incorporer leurs commentaires dans le document fini.
• Si vous n’avez pas de commentaires des utilisateurs de test bêta, testez-le en interne, de préférence avec les employés qui connaissent le moins le produit.,
• Obtenez les commentaires des développeurs et des ingénieurs. Ils connaissent le produit mieux que quiconque et ils peuvent signaler des choses que vous avez peut-être manquées.

Étape 4: Gardez votre documentation à jour

Lorsque votre produit change, vous devrez tout mettre à jour. Comme indiqué ci-dessus, cela donne à la documentation électronique un énorme avantage par rapport à l’impression. Cependant, même les documents imprimés peuvent être mis à jour et mis à disposition pour téléchargement sur votre site Web.

Rappelez-vous, votre contenu n’est génial que s’il est précis. Assurez-vous que ce que vous donnez à 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 aimeriez avoir.

Rendez votre documentation accessible, utile, visuelle.

foire aux questions

Remarque: Cet article a été initialement publié en août 2019, mais a été mis à jour en septembre 2020 pour plus de clarté et pour inclure de nouvelles informations.