Formation Rédaction de documents techniques : Les fondamentaux

Lors de cette formation Rédaction de documents techniques Fondamentaux, vous obtenez les compétences pour évaluer les besoins de vos utilisateurs et créer des documents techniques. Vous apprenez les mécanismes de rédaction propre à la documentation technique ainsi que les techniques de conception de documents et de mise en page, sur papier et en ligne.

Objectif opérationnel : 

Savoir évaluer et créer des dossiers techniques.

Objectifs pédagogiques :

Concrètement à l'issue de cette formation Rédaction de documents techniques Fondamentaux, vous aurez acquis les connaissances et compétences nécessaires pour :

• Être en mesure de rédiger des documents techniques clairs, tels que des rapports techniques et des manuels d'utilisateurs
• Évaluer votre lectorat et élaborer des documents qui répondent à leurs besoins
• Être capable de créer un contenu informatif et intéressant

Public :

Ce cours s'adresse à tous ceux qui doivent expliquer des informations complexes ou communiquer des instructions aux utilisateurs, et à ceux qui découvrent la rédaction technique et qui doivent créer des livres blancs ou des manuels de qualité, concis et clairs.

Bien que certains types de documents spécifiques soient traités, le cours est centré sur les principes de la rédaction technique s'appliquant à tous les environnements. Les managers responsables de la planification et de l'évaluation de documents techniques pourront également tirer parti de ce cours.

Prérequis :

Cette formation d'introduction est destinée aux participants n'ayant pas de connaissances de la rédaction technique ou qui commencent juste à développer les compétences nécessaires pour maîtriser ce domaine.

Introduction

Objectifs de la rédaction technique

Le rédacteur technique

Son profil et son rôle

Les utilisateurs

Leurs profils et leurs besoins
Leurs réactions face à un document technique
Identifier vos objectifs et ceux de votre lectorat
Créer des personas
Prendre en compte les retours utilisateurs

Les principaux types de documents techniques

Déterminer les objectifs du document
Le tutoriel
Le manuel de formation
Le manuel utilisateur
Le manuel de maintenance
Le manuel de référence
Le livre blanc

L’avant-projet

Préparer le projet

Définir les documents nécessaires
Tester le produit pour mieux le documenter
Savoir trier et exploiter les documents existants
Estimer le temps nécessaire entre rédaction, relecture et validation

Concevoir un premier plan

Définir les informations essentielles à transmettre
Définir les informations secondaires à transmettre
Comment ordonner ces informations en blocs logiques

Analyser avant de rédiger

Choisir le type d’information à transmettre
Valeurs de la répétition ou du renvoi

L’écriture technique

Spécificités de la rédaction minimaliste

Comment choisir son vocabulaire

Sigles et abréviations
Les incidences du jargon
Termes particuliers au produit
Définition des termes peu connus
Anglicisme et traduction
Le choix du mot juste

Principe de simplicité KISS

L’utilisation de la voix active
La structure en liste pour plus de clarté
Une rédaction positive et au présent
Savoir rester neutre
L’usage de la répétition

Rédiger des procédures

Définition et construction des procédures

L’intitulé de la procédure
Expliciter ses intitulés
Les instructions
Introduction ou conclusion d’une procédure

Rédaction des instructions

Définir la chronologie des actions
Numéroter les instructions
Appliquer un schéma syntaxique simplifié
Rédiger / illustrer les résultats
Tester et faire tester vos instructions

Limiter la longueur des procédures

Condenser les procédures
Diviser les procédures en étapes

Comment avertir l’utilisateur

Notes et remarques
Avertissements

Les règles de typographie et de mise en page

Concevoir une feuille de style

Les titres
Le texte courant
Les instructions et les résultats
Notes, remarques et avertissements
Les caractères
Les tableaux
Choix des polices de caractères
Choix des couleurs

Les éléments visuels

Usage des illustrations graphiques

Pour appuyer un texte
Pour remplacer un texte
Rédiger les intitulés et légendes des illustrations graphiques
Doit-on les numéroter ?

Le cas des icônes et des symboles

Perception des icônes et symboles par les utilisateurs
Penser accessibilité

Qui fait les illustrations graphiques ?

Structure d’un document technique

La couverture
La table des matières
Table des graphiques et liste des tableaux
Les conventions
Les mentions légales
L’introduction
Le glossaire
Les annexes

Élaborer une aide en ligne

Les spécificités de la lecture sur écran

Différences entre la lecture sur écran et sur papier
Structurer en fonction du format
Ligne de flottaison et construction en pyramide

Le tutoriel de présentation : la prise en main

Utilisation de la vidéo
Avantages et inconvénients du support vidéo
Utilisation des encadrés
Avantages et inconvénients des encadrés
Recommandations

Le guide détaillé : une documentation complète

L’importance des titres
L’importance des introductions
Mettre en place une navigation intuitive
Les menus de navigation : indiquer où est l’utilisateur
La navigation contextuelle
Condenser l’information

Savoir donner une réponse rapide à un problème précis

Le formulaire de contact
Les 6 préceptes de la FAQ

Conclusion

Les dix règles d’une bonne rédaction technique
Liste de contrôle pour le rédacteur

Ce stage incorpore plusieurs Ateliers Pratiques comme :
– Analyser votre lectorat pour mieux répondre à ses attentes
– Création d’une table des matières préliminaire
– Correction et rédaction de procédures
– Rédaction d’une notice complète
– Analyses de cas pratiques directement adaptés aux procédures, documentations, problématiques et environnement de travail des stagiaires.