L'une des meilleures pratiques lors du lancement d'un nouveau produit consiste à préparer la sortie du produit. En particulier, nous voulons nous concentrer sur la rédaction d'une nouvelle documentation produit pour soutenir le lancement d'un produit. Sans cette documentation, les utilisateurs potentiels ne disposeront pas d'informations pertinentes à utiliser comme point de référence après l'achat de votre nouvelle solution.
Dans le cadre d'une stratégie marketing plus large, les chefs de produit et les membres de l'équipe produit devraient poursuivre leur lecture pour découvrir les 15 meilleures pratiques à suivre lors de leur prochain lancement. À la fin, vous saurez comment faire en sorte que ces documents importants soient les meilleurs possibles !
Quels sont les types de documentation produit à connaître ?
Avant de plonger dans la liste des meilleures pratiques, précisons quels sont les types de documentation produit existants et l'objectif visé pour chacun d'entre eux :
Documentation sur les exigences du produit - Un document sur les exigences du produit ou PRD est un type de documentation interne sur le produit utilisé pour aider les entreprises à respecter les critères de publication. Il explique ce que le produit final doit accomplir pour un utilisateur, sans définir précisément comment ni où. Les équipes de développement et de test utilisent ensuite un PRD pour aligner le produit sur les exigences de l'entreprise avant sa mise sur le marché. Les PRD sont monnaie courante pour les produits logiciels, mais ils peuvent être utilisés pour respecter n'importe quelle feuille de route.
-
Guides de l'utilisateur et libre-service** - Les équipes chargées des produits devront créer des guides de l'utilisateur comme condition préalable à un lancement réussi du produit. Comme son nom l'indique, il s'agit d'une documentation destinée à aider les utilisateurs finaux à maximiser leur productivité lors de l'utilisation d'un nouveau produit. Toutes les principales fonctionnalités destinées à l'utilisateur doivent être expliquées en détail, afin que les clients puissent en tirer le meilleur parti. Mieux encore, partagez ces guides dans une base de connaissances externe en libre-service pour que les clients puissent s'aider eux-mêmes !
-
Guides de configuration, d'installation et de paramétrage** - Si un produit nécessite une configuration, une installation et un paramétrage, il s'agit là d'un autre élément de la documentation technique du produit que vous devrez créer. L'objectif est d'illustrer clairement ces processus du point de vue de l'utilisateur et, le cas échéant, du point de vue du développeur. S'il s'agit d'une documentation sur un logiciel, cela peut concerner plusieurs appareils et plusieurs systèmes d'exploitation ; c'est une chose à garder à l'esprit.
Biens marketing - Vous ne pensez peut-être pas qu'il s'agit d'une documentation produit, mais c'est pourtant le cas ! Le style et le format des ressources marketing influencent la façon dont les clients perçoivent votre produit, avant même de commencer à l'utiliser. Il est essentiel de faire bonne impression. Comment décrivez-vous les nouvelles fonctionnalités du produit ? À quel public s'adresse-t-il ? Comment ce produit va-t-il améliorer la vie professionnelle ou personnelle d'une personne ? Est-ce ce que vous et l'ensemble de l'entreprise voulez que les clients pensent ?
15 Meilleures pratiques en matière de documentation lors de la sortie de nouveaux produits
Après cette introduction sur les documents relatifs aux produits, voici la liste des meilleures pratiques :
1 : Commencez !
Vous débutez dans la documentation produit ? C'est parfait ! N'hésitez pas à vous lancer. Beaucoup de gens veulent que la documentation produit soit PARFAITE ; et en recherchant la perfection, ils deviennent paralysés par la tâche. Mettez sur papier le concept de base de vos services, puis concentrez-vous sur la mise au point afin d'impressionner vos clients. Les notes de mise à jour sont idéales pour définir les bases, puis vous pouvez construire à partir de ce document.
2 : Rester simple, stupide...
Abrégé en KISS, il s'agit d'un véritable principe de conception qui a fait son chemin (jeu de mots) dans la marine américaine dans les années 60. La même règle peut s'appliquer à la documentation produit. Posez-vous la question suivante "Comment pouvez-vous transmettre les informations nécessaires d'une manière compréhensible pour tous les groupes démographiques ?"
Pour appliquer cette règle à la vision de votre produit, nous recommandons le test de lisibilité de Flesch-Kincaid. Les outils d'évaluation du contenu tels que Grammarly utilisent couramment ce système. Ce test vous donne une note équivalente à celle d'une classe de lycée aux États-Unis lorsque vous analysez un contenu écrit. Visez la huitième année ou l'âge de scolarisation de 13 à 14 ans pour maximiser l'interprétabilité du contenu - attendez, nous aurions pu dire... la facilité de compréhension de vos écrits.
3 : Comprendre le public cible
Vous avez commencé, et vous êtes resté simple. Vous devez maintenant savoir pour qui vous écrivez... Par exemple, le public cible d'un éditeur de logiciels sera très différent de celui d'un constructeur automobile.
Imaginons une société de logiciels éducatifs qui se concentre sur des outils simples pour aider les jeunes étudiants à apprendre pas à pas des concepts. La première idée qui vous vient à l'esprit est peut-être la suivante : "Le public cible est donc les enfants, n'est-ce pas ? Pas nécessairement... Le public cible est le principal décideur en matière de progiciels dans une école maternelle ou secondaire - comme le service informatique et les parties prenantes internes chargées de l'approvisionnement. Un public secondaire serait les jeunes étudiants, qui pourraient voir le logiciel éducatif dans la nature et plaider en faveur de son utilisation dans leur école.
4 : Se concentrer sur la valeur plutôt que sur l'histoire
Tout le monde aime les bonnes histoires, mais les clients veulent savoir quelle valeur votre produit va leur apporter. Simplifiera-t-il une tâche ou un flux de travail ? Votre produit est-il disponible hors ligne, alors que vos concurrents ne le proposent qu'en ligne ? Votre produit permet-il d'accomplir une tâche plus rapidement que d'autres produits concurrents ?
Ces exemples constituent des arguments de vente uniques (USP) pour une offre particulière. En mettant l'accent sur ces atouts, vous séduirez les clients potentiels et les aiderez à comprendre ce que vous avez de plus que les autres pour accroître votre part de marché. Vous pouvez définir les USP en effectuant une analyse de la concurrence dans votre secteur d'activité.
5 : Tirer parti de la mise en forme pour catégoriser les informations
La documentation ne doit pas être un gros bloc de texte. Il est difficile pour les utilisateurs finaux de la parcourir et de s'y retrouver. Utilisez plutôt des titres et d'autres options de formatage pour diviser le texte.
Les titres H1 sont la première chose que les gens voient lorsqu'ils cliquent sur une page. Les titres H2 et H3 servent de sous-titres pour les sujets abordés sur la page. Vous pouvez utiliser des puces ou des listes numérotées pour regrouper le contenu afin d'en faciliter la lecture, et même devenir éligible pour les Rich Snippets afin d'améliorer le référencement et la visibilité dans les SERPS. Si vous avez des connaissances en Markdown, un éditeur de Markdown en ligne comme Docsie offre de nombreuses options de formatage pour que vos documents produits se distinguent !
6 : Conservez votre documentation dans un emplacement central
Il n'y a rien de pire que de publier une documentation technique et de se rendre compte ensuite à quel point il sera compliqué d'en assurer le suivi et la gestion à long terme. Que faire si la documentation doit être mise à jour ? Où se trouve le document original et comment publier de nouvelles versions de la page ? Qu'en est-il de la traduction de ce contenu dans d'autres langues ?
Pour cette meilleure pratique, nous devons mentionner Docsie ! Ce logiciel de base de connaissances en ligne vous permet de stocker des documents dans un emplacement unique et centralisé dans le nuage. À partir de là, les employés et les sous-traitants peuvent collaborer sur le contenu afin d'accélérer l'achèvement du projet avant son lancement. Docsie offre une gestion du contrôle des versions lorsque vous devez mettre à jour les connaissances, ainsi qu'une gestion des langues pour la localisation du contenu à l'échelle mondiale. Si vous souhaitez automatiser la création de contenu global, nous avons également un robot de traduction ghost AI qui traduit avec précision pour vous en arrière-plan !
7 : Une image parle à mille mots
Bien qu'il soit possible d'écrire une longue explication sur la façon de procéder, ce n'est pas une façon efficace d'enseigner aux utilisateurs finaux. Au lieu de cela, montrez-leur des images, ou même des images animées !
Essayez de créer un tutoriel vidéo pour chaque document produit. Ainsi, ceux qui préfèrent lire peuvent parcourir le texte, tandis que les apprenants visuels peuvent opter pour la vidéo. De même, les GIF et les images peuvent aider les utilisateurs à voir à quoi vous faites référence, en particulier dans l'interface utilisateur d'un logiciel. La prise en compte de différents styles d'apprentissage vous permettra d'aider un plus grand nombre d'utilisateurs, ce qui se traduira par un plus grand potentiel pour votre produit.
8 : Apprentissage vs Objectifs vs Compréhension vs Information
Quelle est l'intention du document ? L'intention de l'utilisateur est essentielle pour la documentation d'un produit en ligne et vous aide à aligner votre contenu sur les différentes sections du parcours de l'utilisateur.
-
Apprentissage** - Si une personne n'a jamais vu une chose auparavant, le contenu d'apprentissage l'aide à comprendre les principes de base.
-
Objectifs** - Ce type de contenu doit aider les utilisateurs à atteindre un objectif, tel que "Comment exporter un fichier PDF à partir de Docsie". À la fin, l'utilisateur aura atteint l'objectif : exporter un fichier PDF.
Compréhension - Également appelé recherche, ce type de contenu est destiné aux clients qui ont déjà des connaissances pratiques sur un sujet, mais qui souhaitent le comprendre plus en profondeur.
Information - Le client a une question et souhaite obtenir une réponse précise. Il peut s'agir tout simplement de la météo en temps réel dans un endroit précis ou d'une vidéo sur la construction d'une cabane dans un arbre.
9 : Faites en sorte qu'il soit possible d'effectuer des recherches
Avant de rendre cette documentation publique, vos utilisateurs peuvent-ils rechercher des mots-clés dans le texte ?
Si ce n'est pas le cas, nous vous recommandons de trouver une plateforme de documentation qui le permette. Le principal facteur dissuasif pour les utilisateurs est l'impossibilité de trouver rapidement des informations. Cela engendre de la frustration, une charge de travail supplémentaire pour l'équipe de support client si elle ne peut pas trouver l'information, et une expérience client (CX) globale négative. Oh, Docsie prend en charge la recherche globale, si vous vous posiez la question !
10 : Se préparer à recueillir un retour d'information exploitable
Les rédacteurs de la documentation sont conscients du fait que la version initiale du contenu est appelée à évoluer. Tant que le public n'a pas pris connaissance de la documentation, les rédacteurs ne peuvent que s'échanger des idées et des commentaires.
Une fois la documentation publiée, nous pensons qu'il est essentiel de mettre en place un système de collecte des commentaires. De cette façon, vos rédacteurs peuvent transformer les aspects négatifs du contenu en aspects positifs en écoutant de vrais clients et utilisateurs finaux. Inutile de chercher ailleurs, vous pouvez profiter de la collecte de commentaires dans Docsie !
11 : Créer un lien vers une page lorsque l'on mentionne un sujet
Cette meilleure pratique s'appuie sur le référencement et les structures de navigation des pages web.
Lorsque vous mentionnez un mot-clé, créez-vous un lien vers celui-ci ? Lorsque vous faites référence à d'autres sujets, il se peut que les utilisateurs ne comprennent pas encore l'autre sujet dans le contexte de la page actuelle. Vous devez créer un lien vers tous les sujets mentionnés qui disposent d'une documentation, car cela permet aux lecteurs de se référer rapidement à des sujets secondaires tout en se renseignant sur un sujet principal.
12 : La clarté, pas l'ambiguïté
La clarté l'emporte sur l'ambiguïté lorsqu'il s'agit de rédiger une documentation sur un produit. Vous pouvez utiliser un anglais simple pour éviter toute ambiguïté, ce qui signifie essentiellement éviter le jargon et le langage technique, sauf en cas d'absolue nécessité. Si vous utilisez du jargon, veillez à rédiger une définition simplifiée immédiatement après pour les lecteurs non initiés.
"Si vous avez des difficultés à comprendre les informations contenues dans cette documentation, veuillez demander des détails supplémentaires sur la manière de surmonter cette difficulté de compréhension à notre représentant de l'assistance à la clientèle."
"Si le contenu affiché est difficile à comprendre, vous pouvez demander de l'aide au service clientèle."
Que préférez-vous ?
13 : Créer des modèles pour accélérer les documents
Lors du lancement d'un nouveau produit, il est prioritaire d'accélérer le processus de création de la documentation. Pour ce faire, vous pouvez utiliser des modèles.
Les modèles définissent une structure réutilisable pour les pages, ce qui aide les rédacteurs à créer du contenu plus rapidement et de manière plus cohérente. Vous pouvez également créer plusieurs modèles pour différents styles de contenu. Docsie propose une gamme de modèles préconstruits que vous pouvez utiliser, ainsi qu'une assistance pour les modèles personnalisés.
14 : Établir un ton de voix et un guide de style pour les rédacteurs
Quelle est la marge de manœuvre de vos rédacteurs ?
Il est important d'encadrer les rédacteurs, car cela peut entraîner des incohérences dans les versions finales de la documentation produit. Pour ce faire, vous pouvez utiliser des directives sur le ton de la voix (ToV) et des guides de style pour la rédaction du contenu.
-
Le ton de la voix** - Ce n'est pas ce que vous avez dit, c'est la façon dont vous l'avez dit. Voulez-vous que les rédacteurs soient formels et corrects, ou plus décontractés ? L'humour est-il autorisé ou les sujets sont-ils plus sérieux ? Votre contenu doit-il être davantage axé sur la conversation et la passion, ou voulez-vous des faits purs et durs ?
-
Lignes directrices en matière de style** - Ce document peut expliquer la mission de l'entreprise et la manière dont les rédacteurs peuvent suivre un style défini lors de la rédaction et de la mise en forme des pages. Il peut s'agir de personas d'utilisateurs à cibler, de principes de référencement tels que les méta-descriptions, et d'exigences en matière de citation ou de référencement (Chicago, AP Style, etc.).
15 : Publiez votre documentation à l'aide d'une puissante plateforme de base de connaissances
Si votre contenu écrit est du carburant, quel véhicule utilisez-vous pour faire passer le message ?
Une plate-forme de base de connaissances puissante est essentielle pour déployer une documentation de qualité sur les produits. Si les documents ne sont pas disponibles ou si les pages sont lentes à charger, tous les efforts déployés pour créer ces documents seront réduits à néant.
Vous devez pouvoir importer des documents existants, collaborer sur le contenu avec des équipes internes, créer et modifier de nouveaux documents, intégrer un contenu dynamique riche et publier sur un site de connaissances. Le contrôle des versions est également essentiel pour les mises à jour à long terme de la documentation, de même que la gestion des langues et la traduction automatique pour la localisation globale du contenu.
Vous l'avez deviné ! Toutes ces fonctionnalités sont disponibles dans Docsie. Testez ces fonctionnalités, essayez notre plan Free Forever pour commencer !