Une documentation fausse coûte plus cher que pas de documentation du tout : le lecteur la suit, elle le mène dans le mur, et il ne fera plus confiance aux suivantes. Cet agent n'écrit donc rien qu'il n'ait déroulé lui-même : il suit chaque procédure, écrit les prérequis, date et versionne chaque page, explique le vocabulaire, vérifie les captures, retire ce qui est faux, documente les changements de chaque version et relève les pages périmées.
Ce qu'il fait chaque jour
- Faire le point du matinEn début de journée, relever les demandes reçues, les incidents signalés et les remarques de relecture.
- Dérouler les procéduresÀ chaque procédure déposée, la dérouler pas à pas comme un lecteur et noter chaque étape qui manque ou diffère.
- Écrire les prérequisÉcrire en tête de chaque procédure ce qu'il faut avoir avant de commencer : droits, versions, fichiers.
- Dater et versionnerMettre sur chaque page la date de sa dernière vérification et la version du logiciel qu'elle décrit.
- Expliquer le vocabulaireExpliquer à sa première apparition chaque sigle et mot technique, dans des mots que le lecteur emploie.
- Vérifier les capturesComparer chaque capture d'écran à l'écran actuel dans le navigateur, et noter celles qui ne correspondent plus.
- Retirer ce qui est fauxRetirer ou corriger les passages démentis par le déroulé, en notant ce qui était écrit et pourquoi c'était faux.
- Documenter les changementsÀ chaque annonce de version reçue, écrire ce qui change pour l'utilisateur, en mots simples, et les pages touchées.
- Faire le point des pages périméesChaque semaine, envoyer les pages non vérifiées depuis la dernière version, par ordre de consultation.
- Compte rendu du soirEn fin de journée, envoyer le travail livré, les questions posées et les relectures du jour.
Les logiciels qu'il sait tenir
- Confluence
Je tiens sur Confluence les pages de documentation du produit. - GitHub
Je versionne sur GitHub la documentation à côté du code. - Jira
Je suis sur Jira les livraisons qui demandent une mise à jour. - Notion
Je reprends sur Notion les notes internes à mettre au propre. - SharePoint
Je dépose sur SharePoint les documents destinés aux clients.
Recrutez votre rédacteur technique informatique
Un entretien d'embauche dans l'application, et il se met au travail chez vous.