Construire un processus documentaire

Planification, rédaction, révision, gouvernance et maintenance — un processus explicite et reproductible pour produire de la documentation technique.

1 min de lecture

Voir en Markdown

Une approche industrielle de la rédaction technique, dans l’ordre où le travail se déroule réellement : définir le projet, collecter l’information, tester le produit, rédiger, valider, traduire et livrer.

Vue d'ensemble du processusToute la chaîne de production en un schéma, avec le volet méthodologie et le volet production côte à côte.

Définition du projetCadrer le projet documentaire avant d'écrire le moindre mot.

Collecte de l'informationD'où vient réellement un contenu fiable, et comment l'obtenir auprès des experts métier.

Tester les produits pour les documenterPourquoi les tests pratiques révèlent ce que les entretiens et les spécifications manquent.

Création du contenuTransformer l'information collectée en contenu structuré et exploitable.

Validation et contrôle qualitéDes relectures qui détectent les erreurs avant publication, pas après.

TraductionAnticiper la traduction plutôt que l'ajouter après coup.

LivraisonFaire parvenir la documentation finalisée à ceux qui en ont besoin, dans le format requis.

Mener un projet de bout en boutUn projet suivi de la prise en charge jusqu'à la livraison.

Besoin du volet outillage et Gestion de versionsEnregistrement de chaque modification d'un ensemble de fichiers, qui permet de restaurer n'importe quel état antérieur, de comparer les changements et de travailler à plusieurs en parallèle. Git est le logiciel de gestion de versions le plus répandu ; en docs-as-code, la documentation est placée sous gestion de versions à côté du code du produit.Voir dans le glossaire → de ce processus ? Voir adopter le docs-as-code. Ce qui distingue la rédaction de la Communication techniqueLa discipline plus large qui couvre tout le cycle de vie du produit et touche le grand public, les prospects et les journalistes — par distinction avec la rédaction technique, qui produit la documentation produit destinée aux utilisateurs après la vente.Voir dans le glossaire → ? Voir comprendre la documentation. À la recherche d’une check-list prête à l’emploi pour une de ces étapes ? Voir la boîte à outils.