Guide ultime de la documentation produit : tout ce que vous devez savoir pour créer d'excellents documents

Documentation produit… 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 réussisse.

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, de manière générale, à créer une meilleure entreprise.

Mais que se passe-t-il 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 couvrirons :

• Pourquoi vous devriez vous soucier de votre stratégie de documentation produit
• Quelques exemples concrets de documentation de premier ordre
• 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 creuser !

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

Commençons par un aperçu des raisons pour lesquelles 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 que cela rend vos clients plus performants. Avoir plus de clients prospères signifie des taux de conversion plus élevés, des taux de désabonnement plus faibles, etc.

C'est logique - si un client ne sait pas comment tirer parti de votre produit, il ne restera pas un client très longtemps.

La documentation produit est un moyen utile d'éduquer les clients afin qu'ils puissent obtenir le plus de valeur possible. Lorsqu'ils obtiendront plus de valeur de votre produit, ils seront plus susceptibles de continuer à payer, à vous recommander à leurs amis/collègues, etc.

Cela réduit votre charge de soutien

La documentation produit peut également être un excellent moyen de réduire la charge de vos canaux d'assistance humaine.

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

Vous devrez soit prendre le temps de développer votre entreprise pour gérer vous-même ces réponses, soit embaucher une personne de soutien dédiée ( ce qui coûte de l'argent ).

Grâce à une documentation de haute qualité, les clients seront en mesure de résoudre bon nombre de leurs propres problèmes, ce qui leur évite d'avoir à demander de l'aide. Vous pouvez également structurer vos processus de support pour inciter les gens à vérifier votre documentation avant de faire une demande.

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

Alors que beaucoup de gens pensent à la documentation produit dans le contexte d'aider les personnes qui ont déjà décidé d'effectuer un achat, une bonne documentation produit peut également vous aider à attirer et à convertir plus de clients en premier lieu.

D'un point de vue marketing, la documentation produit est une mine d'or de mots-clés SEO à longue traîne pour lesquels vous pouvez classer votre documentation. Vous pourriez être surpris par le nombre de personnes qui atterrissent directement sur votre documentation produit 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 produit peut répondre aux éventuelles questions d'avant-vente qu'ils pourraient se poser, 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 produits. Si vous allez sur Twitter, vous pouvez voir beaucoup de personnes recommander Stripe en raison de la qualité de la documentation de Stripe :

Cela 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 savoir plus sur votre produit et de s'y référer en cas de besoin. Cela 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 de produits réels

Pour vous inspirer davantage, examinons quelques exemples concrets de documentation de produits d'entreprises prospères.

1. Rayure

Nous avons mentionné Stripe plus tôt 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

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

3. Twilio

Si vous n'êtes pas familier avec Twilio, c'est un outil qui aide les entreprises à établir la communication dans leurs plates-formes, via des SMS, des e-mails, des 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 parcourir les documents Twilio pour voir un excellent exemple.

4. Mou

Slack est un autre outil qui a une documentation très bien écrite et utile. Vous pouvez parcourir 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 de produit

Voyons maintenant comment vous pouvez commencer à proposer une meilleure documentation produit sur votre site.

Nous parlerons de la rédaction de votre documentation dans la section suivante. Cependant, avant de pouvoir écrire 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 sur votre site, il est préférable d'utiliser un logiciel de documentation produit dédié. Au-delà d'organiser votre contenu et de le rendre accessible aux visiteurs, un bon logiciel de documentation produit inclura d'autres fonctionnalités utiles telles que…

• Fonctions de recherche Ajax pour aider les visiteurs à parcourir la documentation.
• Analyse de recherche pour 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…

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

Heroic Knowledge Base est un plugin pour le logiciel WordPress gratuit et open source 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 le faites pas, vous pouvez créer une installation WordPress dédiée pour votre documentation. Dans ce dernier cas, vous pourriez également être intéressé par le thème de documentation KnowAll WordPress .

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 gestion des versions 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 Ajax instantanée.
• Analyse de recherche.
• Évaluations de l'utilité des articles.
• Pièces jointes aux fichiers d'articles.

La base de connaissances héroïque ne coûte que 129 $.

Adobe RoboHelp

Si vous publiez uniquement votre documentation sur le Web, une solution telle que Heroic Knowledge Base est tout ce dont vous avez besoin. Cependant, pour des besoins de documentation plus au niveau de l'entreprise, vous pouvez avoir des situations où vous devez publier votre documentation sur plusieurs plates-formes, y compris le Web, le papier physique, les applications mobiles, les PDF, etc.

Dans ce cas, vous préférerez peut-être un outil de création de documentation multiplateforme tel qu'Adobe RoboHelp. À partir de 29,99 $ par mois pour un usage individuel, c'est plus cher que la base de connaissances héroïque. Cependant, si vous avez besoin d'une création multiplateforme, ce prix supplémentaire pourrait en valoir la peine.

Comment optimiser la structure et le contenu de votre documentation produit

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

1. Comprendre votre public

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

Les personnes pour lesquelles vous écrivez auront une incidence sur les informations que vous incluez et sur la manière dont vous structurez 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 voulez pas supposer que votre public est composé d'experts et passer sous silence les détails clés, mais vous pouvez supposer certaines connaissances de base en fonction de qui ils sont.

2. Comprendre 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 :

• Vues d'ensemble - ces articles fournissent une vue d'ensemble du fonctionnement d'un domaine de votre produit, tel qu'un guide "Mise en route".
• Tutoriels étape par étape - ces articles montrent aux gens 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 peuvent rencontrer.

Le type de documentation sur lequel vous travaillez devrait affecter la façon dont vous écrivez et la façon dont vous structurez votre documentation, il est donc important de savoir quel est l'objectif avant de creuser.

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

Afin de rendre la documentation de votre produit plus facile à utiliser pour vos clients, il est important que vous conserviez le même style et les mêmes conventions de dénomination dans toute votre documentation. Cela permettra aux clients de suivre plus facilement votre documentation et d'éviter toute confusion potentielle.

Pour vous aider à le faire, 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 vaut toujours mieux qu'une salade de mots. Votre objectif devrait être de communiquer toutes les informations nécessaires en aussi peu de mots que possible.

Vous devez également éviter d'utiliser du jargon ou des termes complexes dans la mesure du 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 profit de votre documentation.

5. Organisez la documentation dans des articles logiques et « de la taille d'un problème »

Pour permettre aux utilisateurs de parcourir plus facilement votre documentation et de trouver des articles pour 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 dans 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 il sera difficile pour les gens de rechercher ces sujets et ils pourraient être confondus lorsqu'ils atterrissent 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 en fonction du problème qu'ils rencontrent en ce moment. La division de vos articles en segments logiques vous aide à tenir compte de ce comportement.

6. Incorporer des éléments multimédias

Bien que le texte écrit doive constituer le cœur de la documentation de votre produit, il ne doit pas être la seule chose. Il peut également être utile d'inclure du contenu image et vidéo là où cela a du sens.

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

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

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

Pour aider les gens à naviguer dans l'article, vous pouvez également ajouter une table des matières qui permet aux lecteurs d'accéder 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 livré avec 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.

Au niveau de base, votre produit subira probablement des modifications, il est donc important de mettre à jour votre documentation pour tenir compte de ces modifications et de toutes les nouvelles fonctionnalités que vous avez ajoutées.

Mais au-delà de cela, si vous choisissez un logiciel de documentation de 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. Suivez ce que les gens recherchent, ce qui peut être un signe que vous devez créer une documentation sur ces sujets si vous ne l'avez pas déjà fait.
2. Découvrez 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 améliorer leur utilité.

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

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

• Rendez vos clients plus performants.
• Réduisez la charge de travail de votre équipe d'assistance.
• Attirez et convertissez plus de clients en premier lieu.
• Améliorez 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 des conseils sur la manière 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 créer votre propre solution auto-hébergée alimentée par WordPress. Cliquez pour en savoir plus sur la base de connaissances héroïque.