Comment créer un manuel de l'utilisateur : Du zéro au héros (Guide complet)

Un manuel d'utilisation est un contenu qui aide vos clients (ou employés) à utiliser efficacement votre produit ou service. En fournissant des instructions claires et en garantissant une utilisation sûre.

En plus d'aider vos clients à utiliser efficacement votre produit, les manuels d'utilisation peuvent également vous aider à réduire les demandes de service et d'assistance à la clientèle.

Voici un exemple typique de manuel d'utilisation :

Source : ManyManuals

Il n'y a rien de mal à cela, cela fonctionne toujours très bien pour les produits dont l'utilisation est limitée. Mais qu'en est-il des logiciels ? Ou des produits comme les téléphones qui ont des centaines de fonctionnalités et de cas d'utilisation ?

Cela semble compliqué, n'est-ce pas ?

Voici l'approche de Sony en ce qui concerne le manuel d'utilisation de ses téléphones portables.

• Une barre de recherche très pratique et puissante, toujours présente à l'écran
• Accès rapide à un manuel d'utilisation en ligne et hors ligne (généralement fourni avec les téléphones portables).
• Des visuels de haute qualité, extrêmement utiles et qui donnent une impression de qualité supérieure.
• Droit au but avec des listes, des étapes et d'autres éléments constitutifs.
• Barre latérale puissante.
• Les guides peuvent être facilement trouvés grâce aux moteurs de recherche.

Tous ces éléments rendent l'expérience très agréable pour les clients.

C'est pourquoi vous devriez envisager de créer un manuel de l'utilisateur en ligne qui soit convivial et facilement accessible par les moteurs de recherche.

Pour ce faire, voici tout ce que nous allons aborder :

Allons-y !

Différents types de manuels d'utilisation

Il existe plusieurs types de manuels d'utilisation, qu'il s'agisse d'un contenu destiné aux clients ou d'un contenu interne.

Avant de commencer, il est important de savoir quel type de manuel vous souhaitez créer, car cela influencera la manière dont vous aborderez le contenu.

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

• Manuel d'instruction : un manuel d'instruction classique enseigne aux utilisateurs comment utiliser un produit. Nous avons beaucoup parlé du manuel d'instruction dans notre autre guide si vous souhaitez en savoir plus.
• Manuel de formation : un manuel de formation enseigne aux utilisateurs comment effectuer une certaine tâche ou un certain travail.
• Manuel d'exploitation: un manuel d'exploitation 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 de son cycle de vie.
• Procédures opérationnelles normalisées (POS): Les SOP sont des manuels internes qui enseignent aux membres de l'organisation comment effectuer certains processus "de la bonne manière".

Les instructions ci-dessous concernent principalement la création d'un manuel de l'utilisateur destiné au grand public. Toutefois, les principes de base ci-dessous s'appliquent à tout type de manuel de l'utilisateur.

Comment créer un manuel de l'utilisateur

Maintenant que vous disposez de quelques informations de base, nous allons voir comment créer un manuel de l'utilisateur, en partant de zéro et en allant jusqu'à la réalisation d'un manuel de l'utilisateur complet.

Note : Je vous conseille d'éviter de sauter des étapes, si vous ne voulez pas vous laisser déborder.

Étape 1. Fixer des objectifs et identifier les principaux problèmes

La définition des objectifs et la compréhension des problèmes devraient constituer la première étape de tout projet.

Le manuel de l'utilisateur vous permet de créer des objectifs tels que

1. Guider les utilisateurs tout au long du processus d'installation
2. Réduire le nombre de tickets d'assistance à la clientèle
3. Garantir une utilisation sûre
4. Améliorer l'expérience des utilisateurs
5. Respecter les normes juridiques et industrielles

Une fois les objectifs fixés, vous pouvez rechercher les principaux problèmes:

1. Manque d'expérience
2. Question budgétaire
3. Utilisation du développement interne par rapport aux solutions en ligne
4. Objectifs que les manuels d'utilisation traditionnels ne peuvent pas résoudre
5. Utilité

Cela vous donnera une bonne idée de votre situation et vous permettra de définir clairement le champ d'application de ce projet.

Étape 2. Création du contenu du manuel de l'utilisateur

Voici quelques bonnes pratiques à prendre en compte lors de la création du contenu du manuel de l'utilisateur :

2.1. Comprendre vos utilisateurs

Avant de commencer à créer du contenu, vous devez savoir à qui il s'adresse, ce que vous pouvez faire en créant des profils d'utilisateurs.

Vous avez probablement déjà une bonne idée de l'identité de vos clients, mais il est utile de la mettre par écrit pour mieux cibler vos efforts.

Pourquoi est-ce important ?

Voici un exemple :

Il y a une grande différence entre créer un contenu technique pour des ingénieurs en mécanique et créer un contenu technique pour des utilisateurs non techniques.

Pour la plupart des produits, les différences ne seront pas aussi marquées. Il n'en reste pas moins important de comprendre les profils de vos clients afin de vous assurer que votre manuel d'utilisation a un sens pour les personnes qui l'utiliseront réellement.

2.2. Trouver des sujets de rédaction

Vous ne voulez certainement pas perdre du temps à rédiger un contenu qui pourrait ne pas correspondre à ce que les utilisateurs recherchent.

Pour commencer.

L'équipe d'assistance à la clientèle peut recueillir les questions les plus fréquemment posées et les résoudre à l'aide d'un manuel d'utilisation avant que les utilisateurs ne commencent à le chercher.

Vous pouvez également consulter les analyses pour comprendre ce que les utilisateurs recherchent, mais ce n'est qu'après avoir terminé la rédaction du manuel de l'utilisateur.

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

Pour en revenir à l'exemple de Sony, vous pouvez voir à quel point leur contenu est bien structuré.

Si un utilisateur a des problèmes de connectivité, le contenu bien organisé lui permet de trouver facilement les documents qui s'y rapportent.

Il peut non seulement aider les clients à trouver rapidement des réponses :

1. Cela vous aidera à déterminer ce qu'il faut inclure dans le manuel de l'utilisateur.
2. Il facilite également le référencement grâce aux fils d'Ariane, au regroupement des contenus et à une meilleure expérience utilisateur.

Voici quelques conseils pour vous aider à créer une structure adéquate :

1. Réfléchissez à la manière d'aider les clients à tirer le plus rapidement possible profit de votre produit.
2. Ne tenez pas compte de vos connaissances personnelles. Il est évident que vous en savez beaucoup sur votre produit, mais vos clients n'auront pas ce niveau de connaissance.
3. Veillez à couvrir les problèmes courants ou les détails déroutants que vos clients peuvent rencontrer lorsqu'ils essaient d'utiliser votre produit. Ces questions doivent être abordées de manière logique aux moments où les clients sont le plus susceptibles de rencontrer des problèmes.

2.4. Rédaction du contenu du manuel de l'utilisateur

La rédaction d'un manuel d'utilisation est totalement différente d'un contenu ordinaire. Il est aussi simple que possible, sans jargon, et très visuel.

Reprendre le contenu du manuel d'utilisation de Sony¹ à titre d'exemple.

Comme vous pouvez le constater, il est très instructif, expliquant facilement les bases de la manipulation des paramètres de l'appareil mobile ou de l'écran d'accueil, et ces visuels ajoutent une touche agréable qui améliore la clarté générale du didacticiel.

Voici quelques conseils à suivre pour rédiger un manuel d'utilisation de qualité :

1. Utilisez un langage simple et évitez le jargon. Ou, lorsque le jargon est totalement inévitable, veillez à l'expliquer.
2. Soyez bref et précis. L'objectif d'un manuel d'utilisation doit être de couvrir entièrement le sujet, mais en aussi peu de mots que possible. N'omettez pas les informations importantes, mais supprimez impitoyablement tout contenu superflu.
3. 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 isolées, même si le texte est très détaillé et complet.
4. Dans la mesure du possible, utilisez des puces et des listes pour les instructions. L'utilisation d'une liste numérotée ou à puces permet aux utilisateurs de suivre plus facilement le guide. Ou, si vous avez besoin de plus de détails qu'une liste ne le permet, vous pouvez donner à chaque étape son propre sous-titre.
5. Utilisez une 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 retrouver plus facilement dans les instructions.
6. Veillez à la cohérence de la mise en forme, qui est expliquée ci-dessous.

2.5. Utiliser des modèles pour assurer une mise en forme cohérente

La création d'un modèle formaté permet non seulement d'accélérer votre travail, mais aussi de garantir que chaque article de votre manuel est cohérent avec les autres.

Voici un modèle à privilégier pour les articles de manuels d'utilisation ou les guides centrés sur le client.

Votre modèle peut inclure un schéma de base, que vous pouvez suivre lors de la création du contenu du manuel de l'utilisateur :

Par exemple, chaque article du manuel de l'utilisateur doit présenter les qualités suivantes :

1. Barre de recherche
2. Chapelure
3. Titre
4. Intro
5. Contenu principal
6. Conseils, notes ou autres informations importantes
7. Images
8. Système de retour d'information
9. Articles connexes
10. Liens vers des communautés, des forums ou des services d'assistance

Enfin, il est toujours bon de tester vos guides comme si vous les utilisiez pour la première fois.

En d'autres termes, une fois que vous avez rédigé un tutoriel, revenez en arrière et suivez les instructions étape par étape pour vous assurer que vous n'avez rien oublié.

Maintenant que vous avez une très bonne compréhension des objectifs du manuel de l'utilisateur et de son contenu, commençons par créer un portail en ligne, où vous pourrez héberger vos articles de manuel de l'utilisateur.

Étape 3. Création du site web du manuel de l'utilisateur

Comme nous préparons un portail en ligne pour les manuels d'utilisation afin d'en faciliter l'accès et d'améliorer l'expérience des utilisateurs, nous devons d'abord créer un site web WordPress.

3.1. Créer un site web WordPress

WordPress est un choix de premier ordre lorsqu'il s'agit de créer des sites web. Il s'agit d'un système de gestion de contenu (CMS) gratuit, que vous pouvez modeler à votre guise à l'aide de thèmes et de plugins.

Créer un site web WordPress est facile. Voici comment installer WordPress sur Kinsta.

1. Achetez n'importe quel plan d'hébergement Kinsta.
2. Suivez la procédure de création de compte et de paiement.
3. Vérifier l'email.

Une fois cette opération effectuée, un tableau de bord s'affiche. À partir du tableau de bord, vous pouvez facilement créer des sites WordPress.

Comme les manuels d'utilisation, Kinsta dispose d'une très bonne documentation utilisateur, à consulter en cas de problème, ou à contacter l'équipe d'assistance.

Comme Kinsta, WordPress peut facilement être installé sur n'importe quelle plateforme d'hébergement. À vous de choisir !

3.2. Créer un portail de manuel de l'utilisateur

Maintenant que votre site web WordPress est prêt, commençons à créer votre portail de manuel de l'utilisateur en ligne !

L'hébergement d'un manuel d'utilisation en ligne est assez similaire à la création d'une documentation utilisateur. Pour cela, nous aurons besoin d'un logiciel capable de répondre aux exigences suivantes :

1. Barre de recherche puissante
2. Flexible et entièrement personnalisable
3. Options de catégorisation et d'étiquetage
4. Blocs de construction dédiés aux éléments visuels
5. Liberté de mise en page et de conception
6. Rôles des utilisateurs et contrôle d'accès
7. Système de retour d'information
8. Analyses et rapports
9. Contrôles SEO

Base de connaissances héroïque répondra à toutes les exigences susmentionnées, vous permettant ainsi de vous concentrer sur la création de contenu.

Téléchargez le fichier .zip de Heroic KB en achetant n'importe quel plan à partir d'ici et notez la clé de licence.

Une fois que le fichier nécessaire est prêt :

1. Accédez à votre Tableau de bord du site web en ajoutant "/wp-admin"à la fin de l'URL de votre site web.
2. Cliquez sur Plugins → Ajouter un nouveau plugin.
3. Cliquez sur le bouton Upload Plugin.
4. Choisissez le fichier plugin Heroic KB .
5. Cliquez sur le bouton Installer maintenant.
6. Après l'installation, activez le plugin.

Une fois l'installation du plugin terminée, un assistant de configuration s'affiche. Il vous suffit de suivre les étapes.

1. Activez le plugin à l'aide d'une clé de licence, que vous pouvez obtenir dans la section des téléchargements.
2. Installer le contenu de la démo.

Note : Si vous avez manqué l'assistant de configuration pendant le processus d'installation du plugin, vous pouvez y accéder à nouveau à partir de la section Plugins.

Félicitations 🎊 ! Votre portail manuel de l'utilisateur est prêt et vous pouvez commencer à le personnaliser et à y ajouter du contenu.

Pour vérifier votre portail nouvellement créé, rendez-vous sur le site : yourdomain.com/knowledge-base/.

Étape 4. Conception de votre portail

Vous avez la liberté de concevoir votre portail comme vous l'entendez grâce à un logiciel de manuel d'utilisateur haut de gamme tel que Heroic KB.

Vous pouvez effectuer la plupart des personnalisations sans avoir à écrire une seule ligne de code en mettant à jour les paramètres à partir du tableau de bord du site Web → Heroic KB → Paramètres.

Voyons quelques scénarios.

4.1. Les couleurs

Vous pouvez personnaliser les couleurs du portail du manuel de l'utilisateur pour qu'elles correspondent au guide de style de votre marque. Pour ce faire, procédez comme suit

1. Visiter le tableau de bord du site web
2. Cliquez sur Heroic KB → Paramètres
3. Cliquez sur l'onglet Apparence

4.2. Barres latérales

Vous souhaitez personnaliser votre barre latérale par défaut ?

1. Visiter le tableau de bord du site web
2. Cliquez sur Heroic KB → Paramètres
3. Cliquez sur l'onglet Général
4. Gérer les paramètres de la barre latérale
5. Enregistrer les modifications pour refléter les paramètres

Et pour modifier le contenu de la barre latérale, rendez-vous dans Apparence → Widgets.

Étape 5. Ajouter des articles au manuel de l'utilisateur

L'ajout d'articles au manuel est similaire au remplissage d'un formulaire en ligne, sauf que vous avez une totale liberté sur la conception.

Vous pouvez faire beaucoup de choses si vous êtes familiarisé avec les constructeurs de pages web, et la création de mises en page complexes sera très facile une fois que vous aurez pris le coup de main.

Par exemple, vous pouvez créer en quelques minutes une mise en page similaire à celle des manuels d'utilisation d'Apple et la réutiliser en créant des modèles.

Pour en revenir au guide principal, tous les articles du manuel de l'utilisateur sont accessibles à partir du tableau de bord du site web → Heroic KB.

À partir de là, vous pouvez ajouter de nouveaux articles ou gérer d'anciens articles.

Pour ajouter un nouvel article, il suffit de cliquer sur le bouton Ajouter un nouvel article ou surHeroic KB → Ajouter un nouvel article.

Voici à quoi ressemblera votre créateur d'articles.

Vous bénéficiez des fonctionnalités supplémentaires de l'éditeur WordPress et de Heroic KB pour créer les meilleurs guides d'utilisation.

• Fonctionne comme n'importe quel éditeur normal tel que TinyMCE, mais avec des options de conception supplémentaires.
• Ajoutez des paragraphes, des titres, des listes, des images ou tout autre contenu HTML.
• Créez des mises en page uniques avec des blocs de groupe, de ligne, de pile ou de grille.
• Ajoutez des pièces jointes, un système de vote ou protégez le manuel par un mot de passe à l'aide des paramètres de Heroic KB .

Il suffit de jouer avec pendant quelques minutes pour apprécier la liberté de conception.

5.1. Rendre les articles compatibles avec les normes de référencement (SEO)

Lorsque quelqu'un a un problème avec votre produit, il effectue d'abord une recherche sur Google (ou tout autre moteur de recherche). Et le fait de ne pas rendre votre manuel d'utilisation convivial pour les moteurs de recherche sera sévèrement l'expérience de l'utilisateur.

Imaginez les étapes nécessaires pour trouver un simple guide sur vos produits :

1. Les utilisateurs cherchent une solution en ligne, mais ne trouvent aucune réponse.
2. visite votre site web et lance une recherche dans la base de connaissances.
3. Recherche d'une réponse simple ou d'un guide dans une longue liste d'articles.

Cela semble si douloureux - et ça l'est.

Vous n'avez pas besoin d'investir beaucoup dans ce domaine car la plupart des requêtes que vous ciblerez ici seront basées sur le mot-clé de votre marque.

L'ajout d'un plugin SEO comme Yoast devrait suffire.

De plus, suivez les conseils de référencement ci-dessous pour les manuels d'utilisation en ligne:

1. Le titre de l'article doit être simple et inclure le mot-clé principal.
2. Utilisez le mot-clé principal pour le titre de l'article.
3. Regrouper le contenu à l'aide de catégories et d'étiquettes.
4. Créer des liens entre les articles/guides connexes et nécessaires.

Nous avons couvert en détail, comment utiliser Yoast SEO avec Heroic KB, consultez-le pour en savoir plus.

Étape 6. Mettre à jour et réviser le contenu de votre manuel de l'utilisateur si nécessaire

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

Il y a deux raisons principales pour lesquelles vous pourriez avoir besoin de le mettre à jour :

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 pour qu'il soit 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 le manuel de l'utilisateur pour tenir compte de ces changements.

Cependant, la seconde situation est également importante à prendre en compte. Vous aurez beau essayer, vous ne parviendrez probablement pas à obtenir un guide ou un tutoriel parfait dès le premier jour.

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

Si vous créez un manuel de l'utilisateur avec un outil comme Heroic Knowledge Base, il comprend des évaluations intégrées de l'utilité des articles, ce qui vous permet de voir facilement quels articles doivent être améliorés.

Les utilisateurs peuvent également laisser des commentaires sur l'article, ce qui peut vous indiquer des parties spécifiques de l'article qui ne sont pas aussi utiles qu'elles pourraient l'être :

Il se peut également que vous manquiez d'articles sur des sujets qui posent problème aux utilisateurs.

Pour vous aider à trouver ces sujets manquants, Heroic Knowledge Base inclut également des analyses de recherche intégrées afin que vous puissiez suivre les recherches qui n'ont pas de résultats de sujets(ainsi que les recherches en général) :

Créez votre manuel de l'utilisateur dès aujourd'hui

Nous avons essayé de tout couvrir sur la base de notre expérience passée. Vous devriez maintenant disposer des connaissances nécessaires pour créer un site web de manuel de l'utilisateur efficace.

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.

La base de connaissances Heroic permet de publier facilement des articles et de les organiser selon les besoins. De plus, les clients peuvent profiter de fonctionnalités utiles telles que les suggestions de recherche en direct, la table des matières, et bien plus encore.

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

Si vous souhaitez créer de la documentation pour améliorer les connaissances internes de votre entreprise, vous pourriez également être intéressé par notre tutoriel sur la publication d'un manuel de formation pour votre personnel.

Ressources utilisées dans ce tutoriel

1. Exemple de contenu du manuel d'utilisation de Sony ︎