Rédaction technique
Pages de la documentation sur le thème Rédaction technique (12 pages).
Ce thème regroupe 12 pages dans le manuel :
Collecte de l’information
ConceptParcours : 2. Construire un processus documentaire
Collecte d'information en rédaction technique : interviews d'experts, tests produit, documentation existante et observations terrain pour construire un contenu précis.
Création du contenu
ConceptParcours : 2. Construire un processus documentaire
Le rédacteur technique crée le contenu du projet de rédaction technique dans un dialogue constant avec les différents acteurs de la société : services R&D, marketing.
Parcours : 1. Comprendre la documentation
La communication technique ne se réduit pas à la rédaction produit. Découvrez leur différence de périmètre et la valeur ajoutée de la communication technique.
Définition du projet
ConceptParcours : 2. Construire un processus documentaire
Définissez votre projet de documentation technique avant d'écrire : identifiez le public cible, le périmètre, les livrables et les critères de succès du processus.
Format cible
ConceptParcours : 4. Choisir un modèle de rédactionFormats source et cible
Le format cible est celui que les utilisateurs consomment - PDF, HTML ou aide compilée - généré à partir d'une source unique. Découvrez la différence entre publication totalement automatique, semi-automatique et manuelle.
Format source
ConceptParcours : 4. Choisir un modèle de rédactionFormats source et cible
Les traitements de texte nous ont déshabitués à distinguer le fond de la forme. Mais confondre les deux entraîne beaucoup d'erreurs et de perte de temps.
Formats et outils
ConceptParcours : 4. Choisir un modèle de rédactionFormats source et cible
Pour industrialiser la rédaction technique, le format importe plus que l’outil. Comparez les formats propriétaires comme Word et FrameMaker aux standards ouverts comme DITA XML et DocBook pour votre contexte.
Parcours : 1. Comprendre la documentation
Le principe KISS appliqué à la documentation technique : architecture de l'information, réutilisation DITA et écriture de phrases simples et maintenables.
Parcours : 1. Comprendre la documentation
Comparez les trois niveaux de maturité de la documentation technique - des notes informelles au contenu modulaire structuré - et découvrez ce qui distingue chaque niveau.
Livraison
ConceptParcours : 2. Construire un processus documentaire
La livraison est l'étape finale : le contenu validé atteint ses cibles via le format et le canal définis au lancement du projet, de l'animation à la plaquette, en passant par les journaux clients, le site web et le guide imprimé ou PDF.
Parcours : 2. Construire un processus documentaire
Le rédacteur technique doit tester le produit dans des conditions proches de celles de l'utilisateur avant de le documenter, plutôt que de compiler les avis partiels des acteurs de l'entreprise - source d'erreurs et de déperdition d'information.
Parcours : 2. Construire un processus documentaire
Validez la documentation technique avant livraison : menez la validation en parallèle de la rédaction, tracez chaque demande de modification via un workflow CMS ou un système de tickets, et comparez les versions pour fiabiliser les mises à jour.