Comment rédiger un manuel d'utilisation du logiciel : le guide ultime (y compris un modèle)

Vous ne savez pas comment rédiger un manuel d'utilisation du logiciel pour votre produit ?

Si vous souhaitez aider vos utilisateurs à tirer le meilleur parti de votre produit de la manière la plus efficace possible, la création d'un manuel d'utilisation de logiciel de qualité est un excellent point de départ.

En donnant aux utilisateurs le contenu dont ils ont besoin pour apprendre et dépanner eux-mêmes votre produit, vous pouvez les aider à réussir sans qu'ils aient besoin de contacter vos canaux d'assistance humaine.

Cela ne facilite pas seulement les choses pour vos utilisateurs, mais cela peut également réduire les demandes d'assistance dans votre entreprise, ce qui vous fait gagner du temps et de l'argent.

Alors, comment pouvez-vous créer le manuel d'utilisation du logiciel parfait pour vos utilisateurs ? C'est le but de ce guide.

Pour vous aider à démarrer, voici tout ce que nous allons couvrir dans cet article :

• Qu'est-ce qu'un manuel d'utilisation de logiciel
• Comment rédiger un manuel d'utilisation de logiciel en quatre étapes, y compris un modèle de manuel d'utilisation de logiciel
• Meilleures pratiques pour créer un contenu de haute qualité pour votre manuel d'utilisation

Allons creuser !

Qu'est-ce qu'un manuel d'utilisation du logiciel ?

Un manuel d'utilisation du logiciel est une documentation qui fournit des informations sur l'utilisation et la gestion de votre application logicielle ou de votre produit.

Le manuel d'utilisation de votre logiciel peut inclure des guides de démarrage, des instructions, des glossaires, des conseils de dépannage et d'autres types de contenu similaires.

Fondamentalement, il comprend toutes les informations dont vos utilisateurs ont besoin pour tirer parti de votre logiciel.

En règle générale, il commencera par les étapes d'installation, puis couvrira un aperçu général de l'interface et comment utiliser différentes fonctionnalités, puis approfondira le dépannage et les FAQ si nécessaire. Encore une fois, nous partagerons un modèle de manuel d'utilisation du logiciel plus détaillé ci-dessous.

Pour voir un exemple de manuel d'utilisation du logiciel, vous pouvez consulter le manuel d'utilisation du chariot élévateur 3, qui passe directement à l'explication de l'interface.

Pour un autre exemple, vous pouvez consulter le contenu de démarrage de Slack, qui passe également directement à l'explication de l'interface Slack.

Pourquoi est-il important de créer un manuel d'utilisation du logiciel ?

Il existe deux grandes raisons de créer un manuel d'utilisation du logiciel pour votre produit :

1. Expérience utilisateur améliorée - en facilitant l'apprentissage de l'utilisation de votre logiciel par les utilisateurs et en maximisant la valeur qu'ils reçoivent de votre logiciel, vos utilisateurs auront de meilleures expériences.
2. Charge d'assistance réduite - en donnant aux utilisateurs la possibilité de résoudre leurs propres problèmes, vous pouvez réduire la charge sur vos canaux d'assistance humaine. Cela est particulièrement vrai si vous combinez votre manuel d'utilisation avec d'autres types de contenu d'assistance, comme une base de connaissances et/ou des questions fréquemment posées (FAQ).

Comment écrire un manuel d'utilisation du logiciel en quatre étapes

Passons maintenant au guide général étape par étape pour savoir comment rédiger un manuel d'utilisation du logiciel. Dans la section suivante, nous passerons également en revue certaines des meilleures pratiques pour le contenu réel de votre manuel d'utilisation.

Si vous êtes intéressé par un aperçu plus général de ces sujets, nous avons également un guide sur la façon de créer tout type de manuel d'utilisation.

1. Planifiez la structure de votre manuel d'utilisation du logiciel

Avant de commencer à créer du contenu pour votre manuel, vous devez d'abord définir correctement la structure de votre manuel.

Pour rendre votre manuel aussi complet que possible, vous souhaiterez peut-être réunir plusieurs parties prenantes clés pour vous aider à le faire.

Par exemple, cela peut inclure la réussite des clients, les ventes, etc. - toute personne qui sait comment aider les utilisateurs à tirer le meilleur parti possible du produit. Dans certains cas, vous devrez peut-être également faire appel à plus de personnel technique pour vous aider avec des détails plus avancés.

Bien sûr, si vous dirigez un projet solo, vous porterez vous-même tous ces chapeaux. C'est la joie d'être un fondateur solo.

Une fois que vous avez mis en place les détenteurs de connaissances pertinents, vous pouvez élaborer les grandes lignes de votre manuel d'utilisation.

Pour un modèle de manuel d'utilisation de logiciel approximatif, vous pouvez suivre quelque chose comme ceci…

1. Table des matières - répertoriez les différentes sections de votre manuel d'utilisation afin que les utilisateurs sachent à quoi s'attendre.
2. Introduction - expliquez le but du manuel d'utilisation de votre logiciel.
3. Configuration système requise - détaillez toutes les exigences spécifiques dont les utilisateurs ont besoin pour utiliser votre logiciel, telles que les spécifications matérielles, le système d'exploitation, etc.
4. Instructions d'installation - expliquent comment l'utilisateur peut installer le logiciel.
5. Vue d'ensemble de l'interface utilisateur - donne une vue d'ensemble de haut niveau de l'interface.
6. Comment utiliser des fonctionnalités spécifiques - créez une section pour chaque fonctionnalité principale qui montre aux utilisateurs comment cela fonctionne.
7. Foire aux questions - couvre certaines questions courantes qu'un utilisateur pourrait avoir.
8. Dépannage - partager des conseils de dépannage.
9. Glossaire - si votre logiciel a une terminologie spécifique, vous pouvez ajouter un glossaire vers la fin du manuel d'utilisation de votre logiciel.
10. Coordonnées de l'assistance : expliquez comment les utilisateurs peuvent contacter l'assistance s'ils ont besoin d'aide supplémentaire. Vous voulez garder cela à la fin afin que les utilisateurs essaient de s'aider eux-mêmes avant de contacter l'assistance.

Vous n'êtes pas obligé de suivre exactement ce modèle de manuel d'utilisation du logiciel - c'est juste un point de départ pour vous donner une idée de ce que vous pourriez vouloir inclure.

2. Créez le contenu du manuel d'utilisation de votre logiciel

Une fois que vous avez votre plan, vous êtes prêt à commencer à créer le contenu du manuel d'utilisation de votre logiciel.

La majeure partie de votre contenu sera constituée de texte, mais n'oubliez pas d'inclure également des images, des GIF et des vidéos pertinents.

Bien que cette étape prenne probablement le plus de temps, nous gardons cette section brève pour l'instant car, dans la section suivante, nous partagerons quelques meilleures pratiques du manuel d'utilisation du logiciel pour aider votre équipe à créer un contenu de manuel d'utilisation efficace.

La personne qui rédige votre contenu dépendra de la taille de votre organisation et de la complexité de votre produit. Si vous n'avez pas de rédacteur technique dédié dans votre équipe, vous devrez peut-être attribuer le contenu à votre équipe de réussite client ou à votre équipe technique, en fonction de la complexité de votre logiciel.

Ou, si vous êtes un fondateur solo, vous serez probablement la meilleure personne pour rédiger le contenu de votre manuel car vous avez la compréhension la plus profonde de votre contenu. Vous pouvez toujours engager un éditeur pour vous aider à améliorer votre premier brouillon.

3. Publiez le manuel d'utilisation de votre logiciel

Une fois que vous avez le contenu du manuel d'utilisation de votre logiciel, vous devez publier votre manuel d'une manière qui permet aux utilisateurs de le consulter facilement.

La plupart des logiciels de base de connaissances ou de documentation devraient fonctionner correctement pour un manuel d'utilisation de logiciel, bien que vous puissiez toujours coder votre propre solution si vous vous sentez trop limité. Certaines entreprises publient également une version PDF du manuel d'utilisation en plus de la version Web.

Pour voir quelques options intéressantes pour publier la version Web du manuel d'utilisation de votre logiciel, vous pouvez consulter nos listes des meilleurs logiciels de base de connaissances et des meilleurs outils de documentation.

Si vous recherchez un logiciel de manuel d'utilisation qui vous donne une liste de fonctionnalités solide, la pleine propriété de votre contenu et la flexibilité de personnaliser les choses selon vos besoins, vous pouvez utiliser notre plugin WordPress Heroic Knowledge Base.

Heroic Knowledge Base est un logiciel open source qui étend le système de gestion de contenu (CMS) WordPress également open source avec toutes les fonctionnalités dont vous avez besoin pour publier le manuel d'utilisation de votre logiciel.

Vous aurez la pleine propriété de votre plate-forme, ainsi que la flexibilité d'ajuster chaque élément selon vos besoins. Mais en même temps, Heroic Knowledge Base inclut toujours des fonctionnalités intégrées pour toutes les fonctionnalités importantes dont le manuel d'utilisation de votre logiciel a besoin :

• Organisation des articles – vous pouvez organiser les articles du manuel de votre logiciel à l'aide de catégories. Par exemple, vous pouvez avoir différentes catégories pour « Installation », « Interface », « Utilisation des fonctionnalités », « Dépannage », etc.
• Fonctionnalités de découverte de contenu - pour aider les utilisateurs à trouver le contenu pertinent le plus rapidement possible, Heroic Knowledge Base comprend des fonctionnalités utiles de découverte de contenu telles que des suggestions de recherche en temps réel, une table des matières automatique, etc.
• Système de commentaires des utilisateurs - les utilisateurs peuvent partager des commentaires sur l'utilité de chaque article, ce qui vous permet de savoir ce que vous faites bien (et où vous devez vous améliorer).
• Analyses détaillées - vous pouvez suivre les articles qui obtiennent le plus de vues, les articles qui génèrent les demandes d'assistance les plus humaines, les termes recherchés par les utilisateurs, les recherches qui ne renvoient aucun résultat, etc.

4. Mettez à jour le manuel d'utilisation de votre logiciel en fonction des commentaires et des modifications

La création d'un manuel d'utilisation de logiciel de qualité n'est pas une chose "une fois et faite". Une fois que vous avez publié votre manuel, il est important d'affecter toujours les principales parties prenantes à la mise à jour et à la révision de votre manuel selon les besoins.

Dans certains cas, ces mises à jour pourraient être requises par une modification de votre logiciel. Par exemple, si vous ajoutez une nouvelle fonctionnalité ou modifiez l'interface de votre logiciel, vous devrez mettre à jour votre manuel d'utilisation pour tenir compte de ces modifications.

Dans d'autres cas, ces mises à jour pourraient découler des commentaires des utilisateurs. Par exemple, si vous voyez que les utilisateurs sont confus par un certain article, vous pouvez mettre à jour cet article pour le rendre plus utile.

Ou, si vous voyez que les utilisateurs recherchent un sujet qui n'existe pas dans le manuel d'utilisation de votre logiciel, vous devrez peut-être créer un nouvel article pour couvrir ce sujet.

La publication de votre manuel d'utilisation avec un outil comme Heroic Knowledge Base vous permettra de suivre facilement ces types d'analyses afin que vous puissiez surveiller et améliorer le contenu de votre manuel d'utilisation.

Meilleures pratiques pour rédiger le manuel d'utilisation de votre logiciel

Maintenant que vous comprenez le processus de base de rédaction d'un manuel d'utilisation de logiciel, passons en revue quelques bonnes pratiques pour créer un contenu de manuel d'utilisation efficace.

Comprendre qui est votre public

Si vous souhaitez créer un manuel d'utilisation utile, il est essentiel de savoir pour qui vous écrivez :

• D'où viennent vos utilisateurs.
• Ce qu'ils essaient d'accomplir avec votre logiciel.
• Quels points de douleur ils éprouvent.
• Leur niveau de connaissance générale de votre industrie et/ou de tout domaine technique pertinent.
• Dans quelle entreprise ils travaillent (ou s'ils sont des utilisateurs solo).
• Etc.

Par exemple, supposons que votre logiciel traite avec Salesforce. Si vos utilisateurs cibles sont des administrateurs Salesforce expérimentés, votre contenu sera très différent de si vos utilisateurs cibles sont les vendeurs eux-mêmes.

Vous aurez probablement déjà une bonne compréhension de vos utilisateurs cibles grâce à votre travail existant. Cependant, si vous n'êtes pas sûr, vous pouvez utiliser des personnalités de clients, des enquêtes et des entretiens pour approfondir votre compréhension.

Utiliser une structure et une organisation logiques

Nous en avons parlé dans la première étape de la section précédente, mais il est important d'organiser votre manuel d'utilisation de manière optimale pour permettre aux utilisateurs de tirer facilement parti de votre contenu.

Il existe différentes manières d'organiser votre manuel d'utilisation et vous pouvez utiliser plusieurs approches dans différentes sections :

• Expérience linéaire - vous pouvez organiser votre manuel de la manière dont les utilisateurs expérimenteront les choses. Par exemple, vous pouvez commencer par « Installation » comme première section, puis passer à la première action après l'installation dans la section suivante.
• Fonctionnalité – vous pouvez organiser le contenu de votre manuel en fonction des différentes fonctionnalités de votre logiciel.
• Dépannage - vous pouvez rassembler les étapes de dépannage courantes en un seul endroit.

Encore une fois, il est tout à fait acceptable d'utiliser plusieurs approches dans votre manuel. Par exemple, vous pouvez commencer par organiser les choses de manière linéaire pour le processus d'installation.

Mais une fois que vous avez couvert l'installation et que les utilisateurs peuvent commencer à appliquer votre logiciel de différentes manières, vous pouvez passer à une approche d'organisation basée sur les fonctionnalités.

Gardez votre écriture simple et cohérente

Pour rendre le manuel d'utilisation de votre logiciel aussi accessible que possible, il est important de garder votre écriture aussi simple que possible.

Voici quelques éléments à garder à l'esprit pour y parvenir :

• N'utilisez pas de jargon ou de mots confus - tous vos utilisateurs n'auront pas les mêmes connaissances en ce qui concerne votre secteur et/ou la langue de votre produit, il est donc important d'éviter le jargon technique inutile et le vocabulaire confus. Vous pouvez tester votre contenu avec des outils comme le test Flesch Reading Ease pour trouver des problèmes.
• Évitez la voix passive - l'utilisation de la voix passive peut être particulièrement déroutante dans un manuel d'utilisation. Par exemple, au lieu d'utiliser une voix passive telle que « L'enregistrement d'une copie de votre brouillon peut être effectué en appuyant sur le bouton Enregistrer le brouillon », il est préférable d'utiliser une voix active telle que « Appuyez sur le bouton Enregistrer le brouillon pour enregistrer une copie de votre brouillon."
• Utilisez des phrases courtes - diviser votre contenu en phrases courtes permet aux utilisateurs de consommer et de parcourir plus facilement le contenu de votre manuel d'utilisation. Dans la mesure du possible, évitez les longs paragraphes ("murs de texte").
• Restez cohérent - l'utilisation d'un libellé et d'un formatage cohérents facilitera la compréhension de votre manuel par les utilisateurs. Par exemple, si vous utilisez toujours une liste ordonnée pour répertorier les étapes individuelles d'une certaine tâche, essayez de conserver cette mise en forme dans l'ensemble de votre manuel d'utilisation.
• Évitez les problèmes de grammaire – assurez-vous de ne pas avoir de fautes de grammaire qui pourraient compliquer la compréhension de votre manuel par les utilisateurs. Vous pouvez vérifier cela en utilisant des outils comme Grammarly et Hemingway.

Inclure des images et des vidéos lorsque cela est utile

Bien que le contenu textuel constitue la base de votre manuel d'utilisation, il est important d'inclure également des images et des vidéos là où cela a du sens.

Le dicton selon lequel « une image vaut mille mots » est peut-être un cliché, mais il peut certainement être vrai lorsque vous essayez d'expliquer comment les utilisateurs peuvent tirer parti de votre produit logiciel.

Pour aider à expliquer les concepts de votre texte, vous pouvez ajouter des images annotées ou des GIF qui illustrent ce dont vous parlez.

Par exemple, Slack fait un excellent travail d'annotation des images d'introduction de son interface.

Le contenu vidéo peut également être utile pour certains utilisateurs. Cependant, vous devez faire attention à ne pas vous fier uniquement au contenu vidéo, car ce n'est pas toujours un moyen optimal pour les utilisateurs de consommer le contenu manuel du logiciel.

Par exemple, si un utilisateur essaie simplement de résoudre un détail spécifique, il lui est généralement beaucoup plus facile de trouver ce détail dans le contenu textuel que dans une vidéo.

Créez votre manuel d'utilisation du logiciel aujourd'hui

Cela conclut notre guide sur la rédaction d'un excellent manuel d'utilisation de logiciel qui préparera vos utilisateurs au succès.

Si vous voulez le moyen le plus simple de publier le manuel d'utilisation de votre logiciel, vous pouvez utiliser le plugin Heroic Knowledge Base pour WordPress.

Heroic Knowledge Base est un plugin open source qui vous permet de tirer parti du CMS WordPress pour créer votre propre manuel d'utilisation de logiciel auto-hébergé entièrement sous votre contrôle.

Dans le même temps, vous n'avez pas besoin de sacrifier la fonctionnalité, car Heroic Knowledge Base offre toutes les fonctionnalités dont vous avez besoin pour créer un excellent manuel d'utilisation du logiciel. Ces fonctionnalités incluent des suggestions de recherche en direct, l'organisation des catégories, la collecte des commentaires des utilisateurs, des analyses, etc.

Si vous êtes prêt à commencer, achetez la base de connaissances héroïque aujourd'hui et vous aurez un superbe manuel d'utilisation en un rien de temps.