Que vous vouliez expliquer à tonton René comment graver ses photos de vacances ou que vous vouliez rédiger un tutoriel pour le partager avec nous par exemple.
Vous serez probablement amené à rédiger de la documentation qui se veut technique, cela vaut aussi si vous avez des métiers dans l'informatique par exemple.
Ces quelques conseils de bon sens sont autant de propositions pratiques libres à vous de les suivre ou non.
On peut remarquer souvent que les gens se plaignent des documentations techniques parce qu'elles contiennent trop de termes compliqués ou demandent des actions qui semblent basiques pour le rédacteur mais qui s'avèrent totalement inconnus ou incompréhensibles pour le lecteur.
Le manque de références ou de connaissances techniques n'explique pas tout, il faut aussi tenter toujours de se mettre à la place de la personne qui sera la cible de votre documentation, et parfois d'essayer de réfléchir comme un novice.
Tout d'abord utilisez autant que possible le français normal et standard plutôt que d'utiliser du jargon ou des termes franglais.
Tentez aussi souvent que possible de faire des phrases construites sur le principe du sujet verbe complément. Cela peut vous paraitre complètement débile comme conseil mais croyez moi combien de fois j'ai eu l'occasion de me rendre compte que des documentations finissaient par se perdre dans des détails techniques inutiles à cause d'un verbiage un peu trop soutenu.
Les acronymes si elles sont essentielles doivent au minimum être suivie de leur signification ainsi que de la traduction de celle ci si elles sont anglaises.
Mettez vous à la place de celui qui va lire, vouvoyez ou tutoyez le et en même temps que vous préparez la documentation, refaite toutes les manipulations histoire de noter les petites choses qui pourraient surprendre ou poser problème.
Notez toujours les messages textuels comme ils apparaissent, y compris si ils possèdent des fautes d'orthographes... Si je vous assure que pour les recherches sur le web il faut parfois préférer la version avec erreur pour être sur de trouver la réelle signification du problème.
Si possible tentez de garder les phrases le plus courtes possible.
Si ce n'est pas possible essayez de fractionner les idées en plusieurs points, ou plusieurs étapes.
Essayez si vous le pouvez d'utiliser des exemples et toujours de manière la plus ludique possible et la plus simple afin que le lecteur puisse tenter de reproduire ceux ci le plus facilement possible.
Les analogies sont aussi bienvenue, attention tout de même à garder un semblant de cohérence en faisant que les analogies soient effectivement bien choisies et qu'elles apportent un complément de compréhension sans au contraire apporter d'autres problèmes ou incompréhensions à votre lecteur qui risque de ne pas comprendre pourquoi vous parlez du corps humain pour expliquer le fonctionnement d'un ordinateur par exemple.
Dans tous les cas mettez vous à la place du lecteur, et faites le nul, relisez vous, suivez vos instructions et tentez de vous tromper, la meilleure solution pour faire tester une documentation est de la fournir à une personne ayant peu ou pas de connaissances techniques et de voir si elle est capable de la lire (étape 1), de la comprendre (étape 2) et de la mettre en pratique (étape 3).
Si votre documentation arrive à l'étape trois vous avez accompli ce que peu de professionnels sont capables de faire et si plusieurs personnes arrivent à l'étape trois avec votre documentation vous pouvez être sur que votre documentation est correctement conçue et rédigée, n'hésitez pas à nous la faire partager!
Et surtout n'hésitez pas à vous inscrire sur le forum et partager avec nous vos tutoriels, documentations, questions pour partager la connaissance avec le plus grand nombre.
Venez réagir sur le forum
Aucun commentaire:
Enregistrer un commentaire