Imaginez que votre équipe doive passer par tous les problèmes que vous avez dû affronter, pour résoudre chaque erreur qui se présente. Qu'elle doive deviner quelle est la procédure à suivre pour faire quoi que ce soit. Que vos clients doivent deviner quoi faire ou comment utiliser ce que vous avez créé pour eux.
Pour tous ces cas et bien d'autres, il existe la documentation. Des textes structurés et pensés pour expliquer comment fonctionne ce que vous avez créé.
C'est un élément fondamental de tout produit ou de toute entreprise. Pourtant, on le laisse souvent de côté. Si vous êtes créateur de produits numériques en tout genre, de modèles Notion, de cours, etc., vous devez faire de la documentation.
Je comprends, faire de la documentation est fastidieux et pénible, ce n'est pas amusant. Mais malgré sa nature ennuyeuse, il faut en faire. Elle facilite la vie des utilisateurs comme des créateurs, en résolvant ou en clarifiant à l'avance les problèmes ou le fonctionnement.
Dani et Alejandra font un travail incroyable avec les documentations des modèles de Notionología.
Voici quelques conseils pour faire monter le niveau de votre documentation
1. Commencez par vous interroger sur le lecteur
La documentation ne s'écrit pas pour le plaisir, le statut ou par obligation. Vous l'écrivez pour faciliter aux utilisateurs l'usage de ce que vous avez créé. C'est essentiellement un manuel d'instructions.
La documentation EST DESTINÉE AUX UTILISATEURS.
La façon la plus simple de commencer est de vous demander :
- De quoi mon utilisateur a-t-il besoin ?
- Que veut-il accomplir ?
- Où peut-il se tromper ou se perdre ?
- L'utilisateur a-t-il vraiment besoin de savoir cela ?
- Comment puis-je faciliter la tâche de l'utilisateur ?
2. Écrivez moins
Personne ne consulte une documentation pour le plaisir. Les utilisateurs veulent trouver quelque chose de précis rapidement. Écrivez le moins possible pour rendre claire la solution, le fonctionnement ou le problème. Ne vous étendez pas plus que ce qui est absolument nécessaire.
Curieusement, écrire moins est précisément ce que vous voulez faire avec une tâche aussi ennuyeuse que la rédaction d'une documentation. Ces conseils sont bons pour l'utilisateur comme pour le créateur.
3. Les idées générales d'abord
En répondant aux questions du premier point, au sein de chaque étape de votre produit ou de votre entreprise, vous verrez naturellement qu'il y a des thèmes, des parties de votre propre produit qui se distinguent clairement ; écrivez-les. Ils sont la colonne vertébrale de votre documentation.
En découvrant un thème, posez-vous les mêmes questions que dans le premier conseil. Vous trouverez des sous-thèmes jusqu'aux niveaux nécessaires pour obtenir les réponses les plus courtes et concises possibles.
Il est plus facile de développer une documentation en allant du plus général au plus particulier.
Les rubriques aident à la navigation dans la documentation. Un seul texte immense est difficile à parcourir, il y est difficile de trouver des réponses. Si vous le découpez en rubriques, les personnes peuvent voir des titres et des sous-titres qui les orientent vers leur centre d'intérêt ou leur besoin précis.
4. Restez décontracté
Si vous ne savez pas comment expliquer quelque chose, essayez de l'expliquer à quelqu'un à voix haute, comme exercice pour débloquer les idées. Si vous pouvez rédiger la documentation avec ce même langage, de la même manière que vous le diriez à quelqu'un en personne, faites-le.
Je sais que ce n'est pas toujours possible, mais le ton conversationnel facilite la compréhension de n'importe quoi. Il met moins de pression et facilite la rédaction de l'ensemble du texte.
5. La lisibilité est importante
Nous avons déjà abordé un peu ce point dans le conseil n° 3. Il est important que la documentation ne soit à aucun moment un bloc de texte immense et ennuyeux.
Vous ennuyez l'utilisateur, vous le perdez et vous le démotivez à consommer l'information importante de votre documentation.
- Si vous avez plusieurs points dans un paragraphe, divisez-les en listes. Si la hiérarchie est importante au sein de ces points, utilisez une liste de chiffres ou de lettres.
- S'il y a une information particulièrement importante à laquelle ils doivent prêter attention, utilisez des blocs de citation (blockquote) ou faites ressortir un style différent, comme un callout de Notion.
- La division en titres est importante elle aussi. Faites en sorte que les idées soient les plus petites et concises possible. Écrivez le moins possible, soyez direct, clair et concis.
- Évitez les adjectifs et les connecteurs. Utilisez le point pour les remplacer. Au lieu de dire : « Il est extrêmement important que vous fassiez ceci de la manière suivante : ». Mieux : « Il est important de le faire ainsi : ». Encore mieux : « La bonne façon : »
Chaque fois que vous pouvez supprimer un mot, faites-le sans pitié.
6. La documentation n'est pas une baguette magique
Si quelque chose ne fonctionne pas, l'expliquer parfaitement ne le fera pas fonctionner. Il est important de savoir faire la différence entre les erreurs que l'utilisateur peut commettre et résoudre, et les problèmes fondamentaux au sein du produit ou de l'entreprise.
L'objectif est d'écrire le moins possible, d'avoir le moins de choses à expliquer possible. Moins il y a d'erreurs et de situations, moins vous avez à écrire.
En d'autres termes, la meilleure documentation est un produit ou une entreprise qui fonctionne parfaitement. Utopique, je sais, mais toujours digne d'être recherché.
Conclusion
Voilà les 6 conseils pour améliorer votre documentation. Ce sont aussi de bons conseils pour écrire des articles en ligne.
Je sais qu'expliquer ce que nous savons peut être pénible, surtout si nous avons en tête l'idée que : « Un produit doit être utilisable sans explication ». Mais dans bien des cas, c'est impossible.
Une documentation bien rédigée va faire gagner du temps et éviter des frustrations à vos utilisateurs, laissant la place pour qu'ils vous apprécient encore plus. Elle économisera aussi du temps et des ressources de support client personnalisé.
Quel que soit l'angle, c'est gagnant-gagnant.
Si vous avez déjà rédigé des documentations, j'aimerais beaucoup savoir : comment les faites-vous ? Quel conseil ajouteriez-vous à la liste ?