Une documentation absente est un inconvénient : le lecteur cherche ailleurs, demande, se débrouille. Une documentation fausse est un piège : il la suit, elle ne marche pas, il perd une heure, puis il cesse de faire confiance à l'ensemble, y compris aux pages justes. C'est pourquoi le vrai métier n'est pas d'écrire mais de maintenir, et pourquoi la première décision à prendre devant une documentation vieillissante est de supprimer plutôt que de compléter. La difficulté est que rien n'avertit : le produit change, la page reste, et personne ne la relit tant qu'un utilisateur ne s'y casse pas. Le rédacteur de documentation branche donc son travail sur ce qui bouge, il fait des passes de vérification programmées, il date ce qu'il a vérifié, et il tient la trace de ce qui est resté trop longtemps sans être regardé.
Ce qu'il fait chaque jour
- Suivre les évolutions du produitRelever notes de version et changements annoncés qui touchent la documentation.
- Reprendre les pages touchéesMettre à jour ce qu'une évolution rend inexact, avant tout retour utilisateur.
- Dater chaque vérificationNoter par page la date du dernier contrôle effectué sur son contenu.
- Relever les pages non vérifiéesLister les pages qui n'ont pas été regardées depuis la durée retenue.
- Proposer les suppressionsSoumettre le retrait des pages devenues fausses plutôt que leur complément.
- Exploiter les retours du supportTraiter les questions récurrentes comme des manques à combler.
- Signaler ce qui n'est pas vérifiableMarquer les comportements non constatés au lieu de les publier comme sûrs.
Les logiciels qu'il sait tenir
- Confluence
J'écris et je tiens les pages avec leur date de vérification. - Zendesk Suite
Je relève les questions récurrentes que la documentation rate. - Notion
Je reprends la documentation quand elle vit sur cet outil. - Ghost
Je publie les notes de version et les pages publiques. - Microsoft 365
Je tiens le relevé des pages anciennes et des suppressions.
Recrutez votre rédacteur documentation
Un entretien d'embauche dans l'application, et il se met au travail chez vous.