Comment créer un manuel d'utilisation : de zéro à héros (guide complet)

Vous ne savez pas comment créer un manuel d'utilisation pour aider vos clients à tirer le meilleur parti de votre produit ?

Un manuel d'utilisation est un contenu qui aide vos clients (ou employés) à utiliser efficacement votre produit ou service. Vous pouvez également le voir appelé guide de l'utilisateur, manuel d'instructions, manuel du produit, etc.

En plus d'aider vos clients à utiliser efficacement votre produit, la création d'un manuel d'utilisation de haute qualité peut également vous aider à réduire les demandes de service client et d'assistance, car les utilisateurs peuvent résoudre leurs problèmes sans contacter l'assistance.

Dans ce guide détaillé, vous apprendrez à créer un manuel d'utilisation qui aide vos clients à réussir.

Pour que cela se produise, voici tout ce que nous allons couvrir :

• Différents types de manuels d'utilisation
• Où publier votre manuel d'utilisation
• Comment créer un manuel d'utilisation

Allons creuser !

Différents types de manuels d'utilisation

Il existe différents types de manuels d'utilisation, comprenant à la fois du contenu destiné aux clients et du contenu interne.

Avant de commencer, il est important de comprendre quel type de manuel vous souhaitez créer, car cela affectera votre approche du contenu.

Voici un bref résumé des différents types de manuels d'utilisation :

• Manuel d'utilisation - un manuel d'utilisation classique enseigne aux utilisateurs comment utiliser un produit.
• Manuel de formation - un manuel de formation enseigne aux utilisateurs comment effectuer une certaine tâche ou terminer un certain travail.
• Manuel d'utilisation – un manuel d'utilisation est généralement un manuel interne qui documente les opérations de votre entreprise.
• Manuel d'entretien - un manuel d'entretien vise à enseigner aux utilisateurs comment entretenir correctement un produit à différents moments du cycle de vie du produit.
• Procédures opérationnelles standard (SOP) - Les SOP sont des manuels internes qui enseignent aux membres de l'organisation comment mener à bien certains processus "dans le bon sens".

Pour les instructions ci-dessous, nous nous intéressons principalement à la création d'un manuel d'utilisation destiné au public. Cependant, les principes de base ci-dessous s'appliqueront à tout type de manuel d'utilisation.

Où publier votre manuel d'utilisation

L'endroit où vous publiez votre manuel d'utilisation dépendra du type de manuel d'utilisation que vous créez.

Pour les manuels d'utilisation destinés aux clients, vous souhaiterez presque toujours les publier sur votre site Web. De cette façon, les utilisateurs peuvent accéder au manuel de n'importe où.

De plus, la publication du contenu du manuel d'utilisation sur le Web vous permet également de créer une expérience plus conviviale qu'avec un manuel d'utilisation physique, comme l'ajout de tables des matières cliquables et de suggestions de recherche en temps réel.

Toutefois, pour les produits physiques, vous souhaiterez peut-être également inclure un manuel d'utilisation physique en complément de votre manuel Web.

Pour les manuels d'utilisation internes, vous souhaiterez généralement les masquer de la vue du public.

Une façon d'y parvenir est de les rendre disponibles uniquement sur l'intranet de l'entreprise. Cependant, avec autant de personnes travaillant à domicile, cela peut être difficile à faire à moins que votre entreprise ne dispose de sa propre configuration VPN.

Au lieu de cela, vous pouvez envisager de protéger le contenu par un mot de passe, soit en demandant à l'employé de se connecter à un compte d'utilisateur, soit en ajoutant simplement un mot de passe pour accéder à la page.

Pour les manuels d'utilisation physiques, vous pouvez utiliser un outil de gestion des connaissances dédié pour vous aider à publier des manuels plus complexes. Ou, pour des manuels d'utilisation plus simples, vous pouvez simplement écrire dans Google Docs et publier à partir de là - notre collection d'outils de rédaction technique propose des outils utiles pour vous faciliter la vie.

Pour publier votre manuel d'utilisation en ligne, vous pouvez utiliser la plupart des logiciels de documentation ou de base de connaissances. Si vous voulez un outil capable de gérer à la fois les manuels d'utilisation publics et internes, vous pouvez envisager le plug-in open source Heroic Knowledge Base pour WordPress. Nous en parlerons plus en détail dans le tutoriel.

Voici un exemple de manuel d'utilisation en ligne de la base de connaissances héroïque (et à propos de la base de connaissances héroïque) :

En parlant de tuto…

Comment créer un manuel d'utilisation en six étapes

Maintenant que vous avez quelques informations de base, voyons comment créer un manuel d'utilisation, en partant de zéro et en allant jusqu'au manuel d'utilisation fini.

1. Créez vos personas utilisateur

Avant de commencer à créer du contenu, vous voulez comprendre à qui il est destiné , ce que vous pouvez accomplir en créant des personas utilisateur.

Vous avez probablement déjà une bonne idée de qui sont vos clients, mais il est utile de l'écrire pour vraiment concentrer vos efforts.

Pourquoi est-ce important?

Eh bien, voici un exemple :

Il existe une grande différence entre la création de contenu technique pour les ingénieurs en mécanique et la création de contenu technique pour les utilisateurs non techniques.

Pour la plupart des produits, les différences ne seront pas si flagrantes. Mais il est toujours important de comprendre les personnalités de vos clients afin de vous assurer que votre manuel d'utilisation a du sens pour les personnes qui l'utiliseront réellement.

2. Identifier le(s) problème(s) clé(s) et le(s) objectif(s)

Une fois que vous comprenez qui sont vos clients, l'étape suivante consiste à comprendre ce qu'ils essaient d'accomplir avec le manuel d'utilisation que vous allez créer.

Autrement dit, quel est l'objectif final (ou les objectifs finaux) des personnes qui liront ce manuel ?

Comprendre cela est important car le but de votre manuel doit être d'aider vos utilisateurs à atteindre cet objectif aussi efficacement que possible.

Dans certains cas, cet objectif final peut être une chose spécifique. Par exemple, si vous disposez d'un outil de gestion des réseaux sociaux, il peut s'agir de "planifier une publication sur les réseaux sociaux".

Dans d'autres, il peut s'agir d'un objectif plus abstrait, tel que « l'amélioration de nos processus de gestion de projet ».

Pour les produits plus volumineux, il peut y avoir plusieurs choses que l'utilisateur essaie de réaliser, ce qui nous amène à la section suivante.

3. Créer une structure logique et une hiérarchie

Maintenant que vous comprenez qui sont vos clients et ce qu'ils veulent réaliser, vous pouvez commencer à définir la structure de votre manuel d'utilisation.

Vous souhaitez créer une structure qui amènera vos utilisateurs de « zéro » à la réalisation des objectifs finaux que vous avez énumérés dans la section précédente.

Voici quelques conseils pour vous aider à le faire :

1. Réfléchissez à la manière d'aider les clients à tirer profit de votre produit le plus rapidement possible.
2. Tirez-en vos propres connaissances personnelles. Vous en savez évidemment beaucoup sur votre produit, mais vos clients n'auront pas ce niveau de connaissances de base.
3. Assurez-vous de couvrir tous les problèmes courants ou détails déroutants que vos clients pourraient rencontrer en essayant d'utiliser votre produit. Ceux-ci doivent être traités logiquement aux moments où les clients sont les plus susceptibles de rencontrer des problèmes.

4. Rédigez le contenu de votre manuel d'utilisation

Une fois que vous avez cartographié votre contenu, vous êtes prêt à commencer à écrire.

Selon la taille de votre produit/organisation, vous pouvez tout écrire vous-même. Ou, vous devrez peut-être collaborer avec d'autres membres de l'équipe pour écrire le contenu.

Voici quelques bonnes pratiques générales du manuel d'utilisation à prendre en compte lors de la rédaction de votre manuel d'utilisation :

• Utilisez un modèle pour garantir une mise en forme cohérente . La création d'un modèle formaté accélère non seulement votre travail, mais garantit également que chaque article de votre manuel est cohérent avec les autres.
• Inclure des éléments visuels (images et vidéos) pour aider les utilisateurs . Une image ou un GIF bien annoté peut être plus utile que des instructions textuelles autonomes, quel que soit le niveau de détail et de précision du texte.
• Utilisez un langage simple et évitez le jargon . Ou, lorsque le jargon est totalement inévitable, assurez-vous de l'expliquer.
• Soyez bref et précis . Votre objectif avec un manuel d'utilisation doit être de couvrir entièrement le sujet, mais en aussi peu de mots que possible. Ne laissez pas de côté des informations importantes, mais supprimez impitoyablement tout contenu inutile.
• Utilisez des puces et des listes pour obtenir des instructions lorsque cela est possible . L'utilisation d'une liste numérotée ou à puces peut faciliter le suivi du guide par les utilisateurs. Ou, si vous avez besoin de plus de détails qu'une liste ne le permet, vous pouvez faire de chaque étape son propre sous-titre.
• Utilisez la voix active . La voix passive peut être particulièrement déroutante pour les instructions d'un manuel d'utilisation. C'est la différence entre « Le produit peut être allumé en appuyant sur le bouton rouge » et « Vous pouvez allumer le produit en appuyant sur le bouton rouge ». Ce dernier exemple (voix active) est plus clair et permet au lecteur de se mettre plus facilement dans la notice.

Enfin, c'est toujours une bonne idée de tester les instructions de votre manuel d'utilisation comme si vous étiez un premier utilisateur.

Autrement dit, une fois que vous avez écrit un article, revenez en arrière et suivez ces instructions étape par étape pour vous assurer de ne rien manquer.

5. Publiez votre manuel d'utilisation

Une fois que vous avez votre contenu, la dernière étape pour le mettre en ligne consiste à publier votre manuel d'utilisation pour le rendre facilement accessible à vos clients.

La façon dont vous procéderez dépendra du type de produit que vous proposez. Par exemple, vous pouvez inclure une version physique de votre manuel si vous expédiez des produits physiques.

Cependant, quel que soit le type de produit que vous proposez, vous voudrez publier votre manuel d'utilisation en ligne afin que les gens puissent le trouver facilement.

Pour vous aider à le faire, vous pouvez utiliser un logiciel de base de connaissances/documentation.

Par exemple, avec le plugin WordPress Heroic Knowledge Base, vous pouvez publier votre manuel d'utilisation à l'aide du logiciel open source WordPress.

Cette approche open source vous donne la pleine propriété et le contrôle de votre plate-forme, tout en fournissant de nombreux outils utiles pour aider vos clients à naviguer plus efficacement dans votre manuel d'utilisation :

• Organisation des catégories - vous pouvez facilement organiser votre manuel d'utilisation en catégories logiques et classer ces catégories par glisser-déposer.
• Suggestions de recherche en temps réel - si les clients souhaitent accéder directement à un didacticiel spécifique, ils peuvent simplement commencer à taper dans la recherche et voir des suggestions de recherche en direct en fonction de leurs requêtes.
• Table des matières automatique - le plugin générera automatiquement une table des matières cliquable pour chaque article du manuel d'utilisation, ce qui aide les lecteurs à accéder directement à la section qui les concerne.
• Légendes/mise en forme faciles - vous pouvez facilement ajouter des légendes et d'autres mises en forme pour attirer l'attention sur les éléments clés de vos articles.
• Widget de réponses instantanées - en plus de créer une page de manuel d'utilisation dédiée sur votre site, vous pouvez également ajouter un widget de réponses instantanées consultable qui permet aux visiteurs de parcourir le contenu du manuel d'utilisation de n'importe où sur votre site.

Si vous souhaitez voir encore plus d'options de logiciels pour vous aider à publier un manuel d'utilisation, vous pouvez lire nos articles sur les meilleurs logiciels de base de connaissances et les meilleurs outils de documentation.

6. Mettez à jour et révisez votre manuel d'utilisation si nécessaire

La création d'un manuel d'utilisation n'est pas un effort ponctuel. À l'avenir, vous devrez consacrer du temps à la révision et à la mise à jour de votre contenu.

Il existe deux raisons principales pour lesquelles vous pourriez avoir besoin de mettre à jour votre manuel d'utilisation :

1. Vous avez ajouté de nouvelles fonctionnalités à votre produit ou modifié le fonctionnement des fonctionnalités/interfaces existantes.
2. Vous souhaitez améliorer le contenu de votre manuel d'utilisation pour le rendre plus utile.

La première situation est évidente - si vous modifiez votre produit d'une manière ou d'une autre, vous devez mettre à jour votre manuel d'utilisation pour tenir compte de ces modifications.

Cependant, il est important de prendre en compte la deuxième situation. Essayez comme vous le feriez, vous n'obtiendrez probablement pas tous les articles du manuel d'utilisation parfaits dès le premier jour.

Pour mieux aider vos utilisateurs, vous souhaiterez mettre à jour et réviser le contenu manuel peu performant pour le rendre plus utile.

Si vous publiez votre manuel d'utilisation avec un outil comme Heroic Knowledge Base, il inclut des évaluations d'utilité des articles intégrées afin que vous puissiez facilement voir quels articles doivent être améliorés. Les utilisateurs peuvent également laisser des commentaires textuels sur l'article, ce qui peut vous orienter vers des parties spécifiques de l'article qui n'aident pas autant qu'elles pourraient l'être :

Il se peut également que vous manquiez d'articles pour des sujets avec lesquels les utilisateurs rencontrent des problèmes. Pour vous aider à trouver ces sujets manquants, Heroic Knowledge Base comprend également des analyses de recherche intégrées afin que vous puissiez suivre les recherches qui n'ont pas de résultats de sujet ( ainsi que les recherches globales en général ) :

Créez votre manuel d'utilisation aujourd'hui

Apprendre à créer un manuel d'utilisation est important si vous voulez préparer vos clients au succès.

Avec les conseils et les meilleures pratiques de cet article, vous devriez maintenant avoir les connaissances dont vous avez besoin pour être opérationnel avec votre manuel d'utilisation.

Pour publier facilement votre manuel d'utilisation en ligne et aider vos clients à le parcourir, vous pouvez utiliser WordPress et le plugin Heroic Knowledge Base.

Heroic Knowledge Base facilite la publication de vos articles et les organise selon vos besoins. De plus, vos clients peuvent profiter de fonctionnalités utiles telles que des suggestions de recherche en direct, une table des matières automatique, etc.

Commencez dès aujourd'hui et vous publierez votre manuel d'utilisation en un rien de temps.

Si vous êtes intéressé par la création de documentation pour améliorer les connaissances internes de votre entreprise, vous pourriez également être intéressé par notre tutoriel sur la façon de publier un manuel de formation pour votre personnel.