9 conseils pour une documentation utilisateur impressionnante (avec exemples)

La documentation utilisateur est une partie importante du produit global livré à votre client. Il aide les utilisateurs finaux à avoir plus de succès avec votre produit ou service.

Dans le passé, la documentation utilisateur était fournie via un fichier d'aide local sur la machine de l'utilisateur ou un manuel ou une brochure physique. Cela signifiait qu'il ne pouvait pas être mis à jour ou modifié facilement et que les fournisseurs de logiciels obtenaient très peu de données sur la façon dont leur contenu était utilisé.

De nos jours, la documentation utilisateur est presque toujours proposée en ligne, ce qui a aidé les rédacteurs techniques à être plus imaginatifs dans la manière dont ils assistent les utilisateurs. Ils peuvent collecter des données, essayer différentes techniques d'apprentissage, itérer plus rapidement et produire une expérience de contenu plus riche pour les utilisateurs.

C'est là qu'intervient ce billet de blog ! je

Dans cet article, nous explorerons ce que vous pouvez faire pour améliorer votre documentation utilisateur et passerons en revue quelques exemples d'excellents contenus de support utilisateur.

Commencez avec un plan

Comme la plupart des choses dans la vie, il est préférable de commencer avec un plan, et la création de documentation utilisateur n'est pas différente. C'est pourquoi vous voudrez vous assurer de vous poser (et éventuellement de ceux qui demandent la documentation) beaucoup de questions avant de commencer.

1. Tenez compte de votre public

Pour qui fais-tu ça ? L'utilisateur final ? Un administrateur système ? Ce contenu ne sera-t-il examiné qu'en interne ou sera-t-il également consulté en externe ? La personne pour qui vous créez la documentation utilisateur aide à encadrer les informations que vous partagez.

2. Évaluez et gardez à l'esprit votre objectif final

Le but principal de toute documentation est d'enseigner quelque chose à votre auditoire. Après avoir déterminé qui consommera votre documentation, vous voudrez décider ce que vous voulez qu'ils en retirent.

Quelle est l'action que vous aimeriez que votre public puisse effectuer après avoir examiné la documentation ? En gardant à l'esprit la réponse à cette question, vous serez en mesure de fournir la bonne quantité de contenu pour la tâche en question.

3. Assurez-vous que votre documentation utilisateur est facilement trouvable

La documentation utilisateur masquée est presque aussi inutile qu'une mauvaise documentation utilisateur. Il est important de s'assurer que la documentation utilisateur que vous créez est facilement accessible à ceux qui en ont besoin.

Cela signifie non seulement qu'il est visible, mais également que les utilisateurs peuvent naviguer dans votre documentation technique et trouver rapidement des réponses à leurs questions.

Plus vite votre public trouvera ces réponses, plus il sera heureux. Cela vous évitera également de devoir répondre à des questions importantes mais courantes sur votre produit.

Écriture concise et forte

Une écriture solide est essentielle à une excellente documentation utilisateur. Mais l'écriture affecte plus que la lecture ou le son de la documentation utilisateur. Cela peut également influencer la facilité de navigation dans votre documentation utilisateur.

4. Rédigez des titres et des sous-titres descriptifs

Assurez-vous que vos titres sont utiles et, surtout, spécifiques. Rédiger des titres ou des sous-titres formulés pour répondre à une question est souvent ce qu'il y a de mieux. Encadrer les titres de cette manière permet à vos utilisateurs finaux de trouver plus facilement ce qu'ils recherchent et vous aide également à rédiger des articles qui répondent directement aux besoins des utilisateurs.

Unbounce fait un travail fantastique en écrivant des titres et des sous-titres efficaces tout au long de sa documentation utilisateur. Cela facilite la navigation dans leur documentation. Chaque article spécifique a sa propre table des matières, ce qui facilite la recherche de la réponse à une question particulière.

5. Facilitez la navigation

Fournir des informations d'une manière facile à numériser aide les utilisateurs à gagner du temps. En tant qu'êtres humains, nous apprécions tous les gains de temps que nous pouvons obtenir. De plus, les utilisateurs peuvent ne pas savoir exactement ce qu'ils recherchent. C'est à ce moment-là que le contenu facile à parcourir est le plus avantageux.

IBM fait un bon travail pour rendre son contenu d'aide facile à parcourir en organisant une table des matières propre et en fournissant des rubriques connexes.

6. Rendez-le facilement consultable

Google nous a appris que trouver les réponses à nos questions est aussi simple que de les taper dans un champ de recherche. Votre documentation d'aide doit refléter cette attente. Si votre contenu d'aide n'est pas consultable, il n'est probablement pas très utile.

La base de connaissances approfondie de Hubspot facilite le libre-service pour leurs clients.

Utiliser des visuels pour améliorer la compréhension

Une bonne documentation utilisateur est très visuelle. Bien qu'une écriture et un texte solides soient essentiels à une documentation utilisateur impressionnante, les gens apprennent mieux lorsque des éléments visuels sont également présents.

7. Utilisez des captures d'écran annotées

Les captures d'écran annotées sont des visuels puissants à utiliser dans la documentation utilisateur. Ils éliminent les conjectures pour les utilisateurs en montrant exactement les étapes qu'ils doivent suivre.

Avec des programmes comme TechSmith Snagit, il est facile d'ajouter des légendes de texte, des flèches et plus encore aux captures d'écran. Par exemple, vous remarquerez que j'utilise des captures d'écran annotées que j'ai faites avec Snagit tout au long de cet article de blog.

Si vous vous sentez inspiré, vous pouvez même essayer l'outil Step Tool de Snagit qui vous permet d'identifier des parties d'une image en plaçant des légendes ordonnées lorsque vous pointez et cliquez. Chaque fois que vous cliquez pour ajouter une autre étape, le nombre avance automatiquement.

Une entreprise qui fait un travail formidable en utilisant la puissance des captures d'écran dans sa documentation est Asana. Tout au long de leur impressionnante documentation utilisateur, ils utilisent des captures d'écran annotées pour guider clairement les clients.

8. Tirez parti de la vidéo pour montrer et non dire

La vidéo fonctionne bien pour démontrer un processus. De nombreuses documentations utilisateur impressionnantes combinent la puissance de la vidéo avec des instructions textuelles. Par exemple, il est recommandé d'utiliser une courte vidéo pour parcourir rapidement un processus.

Ensuite, à côté de la vidéo, vous pouvez fournir un guide textuel étape par étape que les utilisateurs pourront consulter lorsqu'ils essaieront le processus eux-mêmes. De cette façon, ils n'ont pas à regarder la vidéo encore et encore s'ils ont juste besoin d'un rappel rapide.

Dans nos didacticiels sur les produits TechSmith, nous utilisons une vidéo principale pour donner un aperçu complet de la fonctionnalité ou du sujet dont nous discutons. Ensuite, sous la vidéo, nous fournissons des extraits accompagnés de captures d'écran ou de GIF animés pour réitérer les points principaux de la vidéo.

9. Montrez des exemples et des résultats finaux

Les utilisateurs doivent savoir à quoi ressemble la réussite de chaque tâche. Fournir aux utilisateurs une capture d'écran d'un exemple de résultat final est un bon moyen de démontrer le résultat idéal à votre public.

Une excellente documentation utilisateur permet aux utilisateurs finaux de trouver facilement des réponses à leurs questions, ce qui crée des utilisateurs heureux et satisfaits.

Un élément clé de la création d'une documentation utilisateur impressionnante consiste à fournir des informations claires et facilement scannables. Les visuels comme les captures d'écran, les vidéos ou les GIF animés sont tous d'excellents moyens de communiquer plus efficacement avec vos utilisateurs.