Documentation produit : Le guide ultime

La documentation produit… ce n’est peut-être pas la partie la plus glamour de la gestion d’une entreprise, mais c’est un domaine clé que vous ne devriez pas négliger si vous voulez que votre entreprise réussisse.

Créer une documentation produit de haute qualité peut vous aider à rendre vos clients plus performants, à réduire votre charge de support et, plus généralement, à bâtir une meilleure entreprise.

Mais qu'est-ce qui entre dans la création de la documentation produit ? Et comment pouvez-vous mettre en place 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 devriez vous soucier de votre stratégie de documentation produit
• Quelques exemples concrets de documentation de premier ordre
• Les meilleurs logiciels 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 ? Plongeons-y !

Pourquoi vous devriez vous soucier de votre stratégie de documentation produit

Commençons par examiner pourquoi vous ne devriez pas lésiner sur votre stratégie de documentation produit.

Cela rend vos clients plus performants

Le plus grand avantage de la création de documentation produit est qu'elle rend vos clients plus performants. Avoir des clients plus performants signifie des taux de conversion plus élevés, des taux d'attrition plus faibles, etc.

C'est logique : si un client ne parvient pas à 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 puissent en tirer le maximum de valeur. Lorsqu'ils tirent plus de valeur de votre produit, ils seront plus susceptibles de continuer à payer, de vous recommander à leurs amis/collègues, etc.

Il réduit votre charge de support

La documentation produit peut également être un excellent moyen de réduire la charge sur vos canaux de support humains.

Si votre documentation produit est de mauvaise qualité ou inexistante, cela signifie que vos clients doivent contacter votre équipe de support humain chaque fois qu'il y a un problème. Cela signifie plus de temps passé à répondre aux demandes de support.

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

Avec une documentation de haute qualité, les clients seront en mesure de résoudre bon nombre de leurs propres problèmes, ce qui élimine le besoin de demander de l'aide. Vous pouvez également structurer vos processus de support pour encourager les gens à consulter votre documentation avant de faire une demande.

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

Bien que beaucoup de gens pensent à la documentation produit dans le contexte d'aider les personnes qui ont déjà décidé de faire un achat, une bonne documentation produit peut également vous aider à attirer et à convertir plus 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 SEO de 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 depuis 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 produit peut répondre aux questions potentielles avant-vente qu'elles pourraient avoir, les convaincre que votre produit peut faire ce dont elles ont besoin, et leur donner confiance qu'elles recevront de l'aide quand elles en auront besoin.

Par exemple, Stripe est connu pour avoir l'une des meilleures documentations produits. Si vous allez sur Twitter, vous pouvez voir beaucoup de gens recommander Stripe en raison de la qualité de la documentation de Stripe :

Il rend vos employés plus efficaces

La documentation produit n'est pas seulement destinée aux clients, elle peut également être une ressource importante pour les membres de votre équipe afin d'en apprendre davantage sur votre produit et de s'y référer si nécessaire. C'est particulièrement vrai pour les nouveaux employés, qui n'ont peut-être pas une large base de connaissances sur votre produit.

Quatre excellents exemples de documentation produit réels

Pour vous donner plus d'inspiration, examinons quelques exemples de documentation produit réels d'entreprises prospères.

1. Stripe

Nous avons mentionné Stripe plus tôt comme l'un des meilleurs exemples de documentation de qualité en tant qu'outil marketing/vente, vous savez donc que la documentation Stripe devait être la première de notre liste.

2. Adyen

Adyen est une plateforme de paiement pour les paiements e-commerce, mobiles et en 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

Si vous ne connaissez pas Twilio, c'est un outil qui aide les entreprises à intégrer la communication dans leurs plateformes, via des messages texte, des e-mails, des appels téléphoniques, et plus encore. 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 parcourir la documentation Twilio pour voir un excellent exemple.

4. Slack

Slack est un autre outil dont la documentation est très bien écrite et utile. Vous pouvez parcourir la documentation complète de Slack ici.

Meilleur logiciel de documentation produit

Maintenant, passons à la manière dont vous pouvez commencer à offrir une meilleure documentation produit 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 avez besoin d'un endroit pour stocker ces articles et les rendre accessibles à vos utilisateurs.

Bien que vous puissiez simplement ajouter ces articles directement à votre site, il est beaucoup préférable d'utiliser un logiciel dédié à la documentation de produits. En plus d'organiser votre contenu et de le rendre accessible aux visiteurs, un bon logiciel de documentation de produits inclura d'autres fonctionnalités utiles telles que…

• Fonctions de recherche Ajax pour aider les visiteurs à parcourir la documentation.
• Analyses de recherche afin que vous puissiez voir quels sujets les gens recherchent.
• Données d'utilité afin que vous puissiez suivre l'utilité de chaque article individuel et l'améliorer si nécessaire.

Voici deux des meilleures solutions…

Heroic Knowledge Base (Heroic KB)

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 de produits 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 ce n'est pas le cas, 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 à l'aide de 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 de versioning de contenu intégré 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 instantanée Ajax.
• Analyses de recherche.
• Évaluations de l'utilité des articles.
• Pièces jointes aux articles.

Heroic Knowledge Base coûte seulement 129 $.

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 des besoins de documentation plus complexes, vous pourriez avoir des situations où vous devez publier votre documentation sur plusieurs plateformes, y compris le Web, le papier physique, les applications mobiles, les PDF, etc.

Dans ce cas, vous pourriez préférer un outil d'auteur de documentation multiplateforme tel que Adobe RoboHelp. À partir de 29,99 $ par mois pour un usage individuel, il est plus cher que Heroic Knowledge Base. Cependant, si vous avez besoin d'un auteur multiplateforme, ce prix supplémentaire pourrait en valoir la peine.

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

Maintenant que vous avez le logiciel nécessaire pour gérer votre documentation, parlons de la manière dont vous pouvez rédiger des articles de haute qualité. Voici huit conseils clés pour structurer votre documentation et rédiger de meilleurs articles d'aide...

1. Comprenez votre public

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

À qui vous vous adressez affectera les informations que vous incluez et la manière dont vous structurez le tout. Par exemple, si vous écrivez pour des développeurs, votre documentation devrait être radicalement différente de l'écriture destinée aux utilisateurs occasionnels.

Vous ne voulez pas supposer que votre public est expert et passer sous silence les détails clés, mais vous pourriez supposer certaines connaissances de base en fonction de qui ils sont.

2. Comprenez les différents types de documentation produit

Il existe différents types de documentation produit et chacun nécessite une approche différente. Certains des types courants sont :

• Aperçus – ces articles fournissent un aperçu du fonctionnement d'un domaine de votre produit, comme un "Guide de démarrage".
• Tutoriels étape par étape – ces articles montrent 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/résoudre les problèmes courants que les clients pourraient rencontrer.

Le type de documentation sur lequel vous travaillez devrait affecter la manière dont vous écrivez et la manière dont vous structurez votre documentation, il est donc important de connaître l'objectif avant de vous lancer.

3. Soyez cohérent dans votre style et vos conventions de nommage

Afin de rendre votre documentation produit plus facile à utiliser pour vos clients, il est important de maintenir le même style et les mêmes conventions de nommage tout au long de votre documentation. Cela permettra à vos clients de suivre plus facilement votre documentation et d'éviter toute confusion potentielle.

Pour vous aider dans cette démarche, il peut être utile de créer un guide de style pour la mise en forme et la terminologie de base.

4. Utilisez un langage simple et restez concis

Toutes choses égales par ailleurs, un langage court et simple est toujours préférable à un salmigondis de mots. Votre objectif devrait être de communiquer toutes les informations nécessaires en aussi peu de mots que possible.

Vous devriez également éviter d'utiliser du jargon ou des termes complexes chaque fois que possible. Tous vos clients n'auront pas la même base de connaissances et certains pourraient même ne pas être des locuteurs natifs de la langue de votre documentation, donc garder les choses aussi simples que possible garantit que tout le monde peut tirer parti de votre documentation.

5. Organisez la documentation en articles logiques et de taille « raisonnable »

Pour faciliter la navigation dans votre documentation et la recherche d'articles pour leurs problèmes spécifiques, vous devez diviser votre documentation en segments logiques. En général, chaque article doit se concentrer sur la résolution d'un problème spécifique.

Bien sûr, il peut y avoir plusieurs sous-problèmes au sein de ce problème principal, mais l'idée est que vous ne voulez pas regrouper deux problèmes complètement distincts dans le même article, car cela rendra la recherche de ces sujets difficile et les utilisateurs pourraient être confus lorsqu'ils arriveront sur l'article.

Vos clients ne liront pas votre documentation de manière linéaire comme s'ils lisaient un livre. Au lieu de cela, ils sauteront d'une section à l'autre en fonction du problème qu'ils rencontrent à l'instant T. Diviser vos articles en segments logiques vous aide à tenir compte de ce comportement.

6. Intégrez des éléments multimédias

Bien que le texte écrit doive constituer le cœur de la documentation de votre produit, il ne devrait pas être la seule chose. Il peut également être utile d'inclure des images et des vidéos lorsque cela est pertinent.

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

7. Utilisez des titres et ajoutez une table des matières

Dans les articles individuels de la documentation produit, assurez-vous d'utiliser des titres pour diviser vos articles en segments logiques au lieu d'écrire simplement un long bloc de texte.

Pour aider les utilisateurs à naviguer dans l'article, vous pouvez également ajouter une table des matières qui permet aux lecteurs de sauter rapidement à une section spécifique.

Certains logiciels de documentation produit peuvent vous aider à ajouter automatiquement une table des matières. Par exemple, le plugin Heroic Knowledge Base est doté d'une fonctionnalité intégrée pour générer automatiquement une table des matières basée sur les titres de chaque article.

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

Enfin, il est important de se rappeler que la création de la documentation produit n'est pas un événement ponctuel ; c'est un processus continu.

À un niveau de base, votre produit subira probablement des changements, il est donc important de mettre à jour votre documentation pour tenir compte de ces changements et de toute nouvelle fonctionnalité que vous avez ajoutée.

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

1. Suivre ce que les gens recherchent, ce qui peut indiquer que vous devez créer une documentation autour de ces sujets si ce n'est pas déjà fait.
2. Voir quels articles n'aident pas les utilisateurs autant que vous le souhaiteriez, ce qui pourrait indiquer que vous devez apporter des améliorations à ces articles pour en augmenter l'utilité.

Commencez dès aujourd'hui à créer une documentation produit exceptionnelle !

Créer une documentation produit de haute qualité est un investissement dans le succès à long terme de votre entreprise. Cela vous aide à...

• Rendre vos clients plus performants.
• Réduire la charge de votre équipe de support.
• Attirer et convertir plus de clients dès le départ.
• Améliorer les connaissances de vos employés sur votre produit.

Dans cet article, nous avons partagé d'excellents exemples de documentation produit d'entreprises prospères, ainsi que quelques conseils sur la façon de rédiger et de structurer votre documentation.

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