Guide ultime de la documentation produit : Tout ce que vous devez savoir pour créer des documents de qualité

Dernière mise à jour le
Écrit par : image de l'auteur Colin Newcomer
documentation des produits guide ultime

La documentation des produits... ce n'est peut-être pas la partie la plus sexy de la gestion d'une entreprise, mais c'est un domaine clé que vous ne devez pas négliger si vous voulez que votre entreprise soit couronnée de succès.

La création d'une documentation produit de haute qualité peut vous aider à améliorer la réussite de vos clients, à réduire votre charge d'assistance et, d'une manière générale, à développer une meilleure entreprise.

Mais que faut-il faire pour créer une documentation sur un produit ? Et comment pouvez-vous créer votre propre documentation sur votre site web ?

Ce ne sont là que quelques-unes des questions auxquelles nous répondrons dans notre guide ultime de la documentation produit. Voici tout ce que nous allons couvrir :

  • Pourquoi vous devez vous préoccuper de votre stratégie de documentation sur les produits
  • Quelques exemples concrets d'une documentation de qualité
  • Le meilleur logiciel de documentation produit
  • Huit conseils pour créer une meilleure documentation

Êtes-vous prêt à améliorer la façon dont votre entreprise gère la documentation ? Allons-y !

Icône de confiance

Nous testons et étudions rigoureusement chaque produit que nous recommandons sur HeroThemes. Notre processus d'évaluation. Nous pouvons également percevoir une commission si vous effectuez un achat par l'intermédiaire de nos liens.

Pourquoi vous devez vous préoccuper de votre stratégie de documentation des produits

Commençons par examiner les raisons pour lesquelles il ne faut pas lésiner sur la stratégie de documentation des produits.

Il permet à vos clients d'avoir plus de succès

Le principal avantage de la création d'une documentation sur les produits est qu'elle permet à vos clients de mieux réussir. Des clients plus performants se traduisent par des taux de conversion plus élevés, des taux de désabonnement plus faibles, etc.

C'est logique : si un client ne parvient pas à comprendre comment tirer parti de votre produit, il ne restera pas client très longtemps.

La documentation produit est un moyen utile d'éduquer les clients afin qu'ils en tirent le plus de valeur possible. S'ils tirent le meilleur parti de votre produit, ils seront plus enclins à continuer à payer, à vous recommander à leurs amis/collègues, et ainsi de suite.

Il réduit votre charge de soutien

La documentation sur les produits peut également être un excellent moyen de réduire la charge qui pèse sur vos canaux d'assistance humaine.

Si la documentation de votre produit est de mauvaise qualité ou inexistante, cela signifie que vos clients doivent s'adresser à votre équipe d'assistance humaine à chaque fois qu'ils rencontrent un problème. Cela signifie que vous passez plus de temps à répondre aux demandes d'assistance.

Vous devrez soit consacrer du temps à la croissance de votre entreprise pour gérer ces réponses vous-même, soit engager une personne dédiée à l'assistance(ce qui coûte de l'argent).

Grâce à une documentation de qualité, les clients seront en mesure de résoudre eux-mêmes un grand nombre de leurs problèmes, ce qui leur évitera d'avoir à faire appel à l'assistance. Vous pouvez également structurer vos processus d'assistance de manière à inciter les clients à consulter votre documentation avant de formuler une demande.

Il peut être un bon outil de marketing et de vente

Si la plupart des gens pensent à la documentation produit dans le contexte de l'aide aux personnes qui ont déjà décidé de faire un achat, une bonne documentation produit peut également vous aider à attirer et à convertir davantage de clients dès le départ.

D'un point de vue marketing, la documentation produit est une mine d'or de mots-clés à longue traîne pour lesquels vous pouvez classer votre documentation. Vous pourriez être surpris par le nombre de personnes qui arrivent directement sur votre documentation produit à partir de Google. Si vous structurez bien votre documentation, vous aurez une chance de convertir ces personnes en clients.

Votre documentation peut également être un outil de vente utile pour les personnes qui hésitent à acheter votre produit. La documentation sur le produit peut répondre aux questions qu'ils pourraient se poser avant la vente, les convaincre que votre produit peut répondre à leurs besoins et leur donner l'assurance qu'ils obtiendront de l'aide lorsqu'ils en auront besoin.

Par exemple, Stripe est connu pour avoir l'une des meilleures documentations de produit. Sur Twitter, de nombreuses personnes recommandent Stripe en raison de la qualité de sa documentation :

Un tweet mettant en avant la documentation du produit Stripe

Il rend vos employés plus efficaces

La documentation sur les produits n'est pas seulement destinée aux clients, elle peut également constituer une ressource importante pour les membres de votre équipe, qui peuvent ainsi se familiariser avec votre produit et s'y référer en cas de besoin. C'est particulièrement vrai pour les nouveaux employés, qui n'ont pas forcément une connaissance approfondie de votre produit.

Quatre excellents exemples de documentation de produits dans la vie réelle

Pour vous donner un peu plus d'inspiration, examinons quelques exemples concrets de documentation de produits provenant d'entreprises prospères.

1. Rayure

Documentation sur Stripe

Nous avons mentionné Stripe plus haut comme l'un des meilleurs exemples de documentation de qualité en tant qu'outil de marketing/vente, vous savez donc que la documentation Stripe devait être numéro un sur notre liste.

2. Adyen

Docs Adyen

Adyen est une plateforme de paiement pour le commerce électronique, les paiements mobiles et les paiements au point de vente. Comme Stripe, cela signifie que les développeurs doivent l'intégrer dans leurs propres plateformes, ce qui nécessite une excellente documentation. Adyen ne déçoit pas - consultez la documentation complète d'Adyen ici.

3. Twilio

Documentation Twilio

Si vous ne connaissez pas Twilio, sachez qu'il s'agit d'un outil qui aide les entreprises à intégrer la communication dans leurs plateformes, par le biais de messages texte, d'e-mails, d'appels téléphoniques, etc. Comme pour Stripe et Adyen, cela signifie que les entreprises devront intégrer Twilio dans leurs services existants, ce qui nécessite une documentation de premier ordre. Vous pouvez consulter la documentation de Twilio pour voir un bon exemple.

4. Fente

Documentation sur le produit Slack

Slack est un autre outil dont la documentation est très bien rédigée et très utile. Vous pouvez consulter la documentation complète de Slack ici.

Pour voir d'autres exemples, consultez notre article complet sur les meilleurs exemples de documentation utilisateur.

Meilleur logiciel de documentation produit

Voyons maintenant comment vous pouvez commencer à offrir une meilleure documentation sur les produits sur votre site. 

Nous parlerons de la rédaction de votre documentation dans la section suivante. Cependant, avant de pouvoir rédiger votre documentation, vous devez disposer d'un endroit où stocker ces articles et les rendre accessibles à vos utilisateurs.

Bien que vous puissiez ajouter ces articles directement sur votre site, il est préférable d'utiliser un logiciel de documentation produit dédié. En plus d'organiser votre contenu et de le rendre accessible aux visiteurs, un bon logiciel de documentation produit comprendra d'autres fonctions utiles telles que...

  • Fonctions de recherche Ajax pour aider les visiteurs à parcourir la documentation.
  • L'analyse des recherches vous permet de savoir quels sont les sujets recherchés par les internautes.
  • Les données relatives à l'utilité vous permettent d'évaluer l'utilité de chaque article et de l'améliorer si nécessaire.

Voici deux des meilleures solutions...

Base de connaissances héroïque (Heroic KB)

Heroic KB vous aide à créer votre propre documentation sur les produits

Heroic Knowledge Base est un plugin pour le logiciel gratuit et open-source WordPress qui vous permet de créer facilement votre propre centre de documentation produit auto-hébergé.

Si vous utilisez déjà WordPress pour le site web de votre entreprise, vous pouvez ajouter Heroic Knowledge Base à votre site pour créer votre propre centre de documentation. Ou, si vous ne l'utilisez pas, vous pouvez créer une installation WordPress dédiée à votre documentation. Dans ce dernier cas, vous pourriez également être intéressé par le thème de documentation WordPress KnowAll .

Heroic Knowledge Base vous permet d'ajouter toute votre documentation en utilisant l'éditeur de contenu de WordPress, ce qui facilite l'inclusion de contenu multimédia si nécessaire. Vous aurez également accès au système intégré de gestion des versions du contenu de WordPress, qui vous permet de suivre facilement les modifications et de comparer les versions précédentes de votre documentation.

Heroic Knowledge Base ajoute également un certain nombre de fonctionnalités utiles, notamment

  • Recherche Ajax instantanée.
  • Analyse de la recherche.
  • Article helpfulness ratings.
  • Fichiers joints à l'article.

Heroic Knowledge Base ne coûte que 129 $.

Adobe RoboHelp

Adobe RoboHelp

Si vous ne publiez votre documentation que sur le web, une solution comme Heroic Knowledge Base est tout ce dont vous avez besoin. Cependant, pour les besoins en documentation d'une entreprise, vous pouvez être confronté à des situations où vous devez publier votre documentation sur plusieurs plateformes, y compris le web, le papier physique, les applications mobiles, les PDF, et ainsi de suite.

Dans ce cas, vous préférerez peut-être un outil de création de documentation multiplateforme comme Adobe RoboHelp. À partir de 29,99 $ par mois pour une utilisation individuelle, il est plus cher que Heroic Knowledge Base. Cependant, si vous avez besoin d'un outil de création multiplateforme, ce prix supplémentaire peut en valoir la peine.

Comment optimiser la structure et le contenu de votre documentation produit ?

Maintenant que vous disposez des logiciels nécessaires à la gestion de votre documentation, parlons de la rédaction d'articles de qualité. Voici huit conseils clés pour structurer votre documentation et rédiger de meilleurs articles d'aide...

1. Comprendre votre public

Pour rédiger une bonne documentation produit, vous devez comprendre le public pour lequel vous écrivez (c'est-à-dire vos clients).

Le destinataire de votre documentation influencera les informations que vous inclurez et la manière dont vous structurerez le tout. Par exemple, si vous écrivez pour des développeurs, votre documentation doit être radicalement différente de celle destinée à des utilisateurs occasionnels.

Vous ne devez pas supposer que votre public est un expert et passer sous silence des détails essentiels, mais vous pouvez supposer qu'il possède des connaissances de base en fonction de son profil.

2. Comprendre les différents types de documentation sur les produits

Il existe différents types de documentation sur les produits et chacun d'entre eux nécessite une approche différente. Voici quelques-uns des types les plus courants :

  • Aperçus - ces articles donnent un aperçu du fonctionnement d'une partie de votre produit, par exemple un guide de démarrage.
  • Tutoriels étape par étape - ces articles montrent aux lecteurs comment effectuer une tâche spécifique.
  • Référence - ces articles expliquent des concepts spécifiques de votre produit.
  • Dépannage - ces articles expliquent comment déboguer/dépanner les problèmes courants que les clients peuvent rencontrer.

Le type de documentation sur lequel vous travaillez doit influer sur votre façon d'écrire et de structurer votre documentation, il est donc important de savoir quel est l'objectif avant de vous lancer.

3. Soyez cohérent dans votre style et vos conventions d'appellation

Afin de faciliter l'utilisation de votre documentation produit par vos clients, il est important que vous conserviez le même style et les mêmes conventions de dénomination dans l'ensemble de votre documentation. Il sera ainsi plus facile pour les clients de suivre votre documentation et d'éviter toute confusion potentielle.

Pour vous aider, il peut être utile d'élaborer un guide de style pour la mise en forme et la terminologie de base.

4. Utiliser un langage clair et concis

Toutes choses égales par ailleurs, un langage court et simple est toujours préférable à une salade de mots. Votre objectif doit être de communiquer toutes les informations nécessaires en un minimum de mots.

Dans la mesure du possible, évitez également d'utiliser du jargon ou des termes complexes. Tous vos clients n'auront pas la même base de connaissances et certains ne seront peut-être même pas des locuteurs natifs de la langue dans laquelle votre documentation est rédigée.

5. Organiser la documentation en articles logiques de la taille d'une question

Pour que les utilisateurs puissent plus facilement parcourir votre documentation et trouver les articles correspondant à leurs problèmes spécifiques, vous devez diviser votre documentation en segments logiques. En général, chaque article doit être axé sur la résolution d'un problème spécifique.

Bien sûr, il peut y avoir plusieurs sous-problèmes à l'intérieur de ce problème principal, mais l'idée est de ne pas regrouper deux problèmes complètement distincts dans le même article, car cela rendrait difficile la recherche de ces sujets et les gens risqueraient d'être désorientés lorsqu'ils arriveraient sur l'article.

Vos clients ne liront pas votre documentation de manière linéaire comme s'ils lisaient un livre. Au contraire, ils sauteront d'un endroit à l'autre en fonction du problème qu'ils rencontrent à ce moment-là. Le fait de diviser vos articles en segments logiques vous aide à tenir compte de ce comportement.

6. Incorporer des éléments multimédias

Si le texte écrit doit constituer l'essentiel de votre documentation produit, il ne doit pas être le seul. Il peut également être utile d'inclure des images et des vidéos lorsque cela s'avère utile.

Si vous incluez des captures d'écran, vous pouvez également ajouter des annotations aux images pour clarifier les détails clés.

7. Utiliser des titres et ajouter une table des matières

Dans les articles de la documentation produit, veillez à utiliser des titres pour diviser vos articles en segments logiques au lieu de rédiger un long mur de texte.

Pour aider les lecteurs à naviguer dans l'article, vous pouvez également ajouter une table des matières qui leur permet d'accéder rapidement à une section spécifique.

Certains logiciels de documentation de produits peuvent vous aider à ajouter automatiquement une table des matières. Par exemple, le plugin Heroic Knowledge Base est doté d'une fonction intégrée qui permet de générer automatiquement une table des matières à partir des titres de chaque article.

8. Améliorez et mettez toujours à jour votre documentation

Enfin, il est important de se rappeler que la création d'une documentation sur les produits n'est pas un événement ponctuel, mais un processus continu.

Il est donc important de mettre à jour votre documentation pour tenir compte de ces changements et de toutes les nouvelles fonctionnalités que vous avez ajoutées.

Mais au-delà de cela, si vous choisissez un logiciel de documentation produit tel que Heroic Knowledge Base, vous aurez accès à des analyses qui vous aideront à comprendre comment les gens utilisent votre documentation. Vous pouvez utiliser ces analyses pour :

  1. Suivez les recherches des internautes, ce qui peut être le signe que vous devez créer une documentation sur ces sujets si vous ne l'avez pas encore fait.
  2. Voyez quels articles n'aident pas les utilisateurs autant que vous le souhaiteriez, ce qui peut être un signe que vous devez apporter des améliorations à ces articles pour qu'ils soient plus utiles.

Commencez dès aujourd'hui à créer une documentation de qualité sur vos produits !

La création d'une documentation produit de haute qualité est un investissement dans le succès à long terme de votre entreprise. Elle vous aide...

  • Faites en sorte que vos clients aient plus de succès.
  • Réduire la charge de travail de votre équipe d'assistance.
  • Attirer et convertir plus de clients dès le départ.
  • Améliorez les connaissances de vos employés sur votre produit.

Dans ce billet, nous avons partagé avec vous quelques exemples de documentation de produits provenant d'entreprises prospères, ainsi que des conseils sur la manière de rédiger et de structurer votre documentation.

Si vous êtes prêt à créer votre propre centre de documentation produit, vous pouvez utiliser le plugin Heroic Knowledge Base pour construire votre propre solution auto-hébergée sous WordPress. Cliquez pour en savoir plus sur Heroic Knowledge Base.

Laisser un commentaire ?