Construire un processus documentaire

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.

De la rédaction à la communication techniqueEn quoi cette discipline diffère du marketing et de la rédaction générale, et pourquoi cette distinction compte pour la conception du processus.

Besoin du volet outillage et gestion de versions de ce processus ? Voir adopter le docs-as-code. À la recherche d’une check-list prête à l’emploi pour une de ces étapes ? Voir la boîte à outils.