Introduction
Une documentation peut être le facteur clé de différenciation pour une entreprise qui souhaite réussir. Par exemple, la solution de paiement en ligne Stripe est bien connue de ses utilisateurs pour sa documentation de pointe, ce qui a contribué énormément à sa croissance et à sa fidélisation.
Mais si vous êtes ici, vous n'avez probablement pas besoin de plus de persuasion, alors plongeons directement dans nos 7 conseils pour rédiger une meilleure documentation.
Tips
Giving examples
Vous vous souvenez de l'école ? Parfois, vous ne compreniez rien à une définition, mais en ayant un scénario réel, vous compreniez instantanément.
Les concepts dans une documentation fonctionnent de la même manière. Il est bon de présenter la partie théorique, mais il est tout aussi important d'inclure des exemples concrets.
Exhaustivity 📚
La plupart des utilisateurs ne liront pas votre documentation comme ils le feraient pour un roman ou un article de blog. Chez Notice, 87% des utilisateurs ne lisent pas un article complet*, ils recherchent une information précise et utiliseront la navigation, la barre de recherche et la structure interne de l'article pour la trouver.
La conclusion ? Vos utilisateurs se fichent de savoir si vos articles sont très longs, mais ils s'en soucieront s'il manque une information et qu'ils ont besoin de vous contacter. N'ayez pas peur d'être exhaustif, couvrez tous les cas et petites subtilités.
A good search engine 🔎
Parlons de la recherche ? Un énorme 42% des utilisateurs utilisent la barre de recherche à chaque visite. Un bon moteur de recherche doit tolérer les requêtes mal écrites, les synonymes et vous signaler les recherches qui n'ont donné aucun résultat afin que vous puissiez combler les lacunes.
Regular updates
Une documentation est un organisme vivant, prenez-en bien soin. Elle doit refléter les derniers changements de votre produit/service et les ressources doivent être à jour (vidéos, images, liens, ...).
Une documentation collaborative peut aider à améliorer la fraîcheur du contenu.
Letting the experts talk
Chaque membre d'une équipe dédiée à un sujet doit gérer sa partie de la documentation, ou du moins revoir le contenu qui lui est dédié.
C'est aussi un bon moyen de donner la responsabilité et de responsabiliser les auteurs. Confier la responsabilité du contenu et de la pertinence à des personnes spécifiques améliorera la qualité globale des articles.
Use images and videos
Les fondements d'un article doivent toujours être son contenu textuel. Parce que le texte est indexable, modifiable et recherchable. Cependant, l'ajout de vidéos et d'images rend votre contenu plus divertissant et plus facile à comprendre pour le lecteur.
Il est souvent judicieux de faire une vidéo d'un long tutoriel, par exemple.
Use the right tools
Chez Notice, notre objectif est de fournir les meilleurs outils pour y parvenir, n'hésitez pas à les essayer ici.
*ne tient compte que des articles contenant plus de 5 paragraphes.
