Formation
Apprendre à créer une documentation technique efficace et facile à comprendre.
Rédaction technique pour les ingénieurs - Profil du programme
Quel est l'objectif de ce programme de formation?
Ce programme vise à responsabiliser les ingénieurs, technologues, et autre personnel technique pour concevoir, créer, et maintenir une documentation technique efficace et facile à comprendre.
Les leçons se concentrent sur les choses à faire et à ne pas faire dans les publications réelles, donner aux étudiants les outils pour améliorer rapidement la qualité de leur documentation tout en économisant du temps et des ressources.
Le programme de formation couvre les plates-formes de développement de contenu les plus utilisées actuellement sur le marché: Microsoft Word ™ et Madcap Flare ™.
A qui est destiné ce cours?
Ingénieurs et technologues qui doivent rédiger des manuels et des procédures pour les clients ou à usage interne.
Le cours suppose que les étudiants sont qualifiés dans leur domaine et ont conçu ou entretenu des systèmes qui nécessitent des documents techniques décrivant leurs fonctions et capacités.
Ces documents comprennent :
Examens de conception
Manuels d'installation, Opération, et entretien
Procédures et rapports d'assurance qualité
Les procédures d'essai
Instructions de travail
Procédures d'utilisation normalisées
Rapport d'état interne
Rédaction technique pour les ingénieurs - Profil du programme
Jour 1 – Fondements de la rédaction technique
- Qu'est-ce que la rédaction technique ?
- Linéaire vs. Documents thématiques ;
- Identifier le public ;
- Les quatre W : quoi, Qui, Où, et quand;
- Collecter et sélectionner des informations ;
- Passif : comprendre les conséquences ;
- Sécurité : saisie des informations selon les normes ;
- Comprendre la « Séquence des événements » ;
- Éléments d'une rédaction technique efficace :
- Cohérence;
- Temps et conditionnels ;
- Discours direct;
- Nombres, Unités, Les mesures, Équations, et Chiffres ;
- Grammaire, Syntaxe, Ponctuation, et Abréviation ;
- Erreurs courantes : l'ingénieur ;
- Prise en main :
- Création d'un manuel d'installation ;
- Création d'un manuel d'exploitation ;
- Création d'un manuel d'entretien ;
- Table des matières, Indice, et
- Création de glossaire.
- Matériel de support (inclus) :
- Guide d'étude Flexwrite.
- Livre : « Elements of Technical Writing par Gary Blake et Robert W. Bly".
« … votre règle pourrait être celle-ci : si une phrase, peu importe à quel point il est excellent, n'éclaire pas votre sujet d'une manière nouvelle et utile, grattez-le. - Kurt Vonnegut, Jr. romancier et publiciste technique pour General Electric.
Jour 2 – MS Word avancé
- Une brève histoire du .DOC, .DOCX, et XML ;
- IHM, Ruban, et barre de péage à accès rapide ;
- Formatage et styles de texte ;
- Mise en page:
- Marges, Orientation, et tailles ;
- Marges, Onglets, Et les frontières ;
- En-têtes et pieds de page ;
- Insertions :
- Insertion et mise en forme de tableaux ;
- Trier le contenu de la table ;
- Insertion et manipulation d'illustrations;
- Autres éléments ;
- Importation et sélection de polices de caractères ;
- Légendes et références croisées ;
- Mise en page;
- Orthographe, grammaire, et les paramètres de langue ;
- Recherche et remplacement avancés ;
- Texte automatique, Pièces rapides, Blocs de construction, et champs ;
- Signets et références croisées ;
- Citations et bibliographie, et table des autorités ;
- Outils de révision.
- Matériel de support (inclus) :
- Guide d'étude Flexwrite.
- Livre : « Microsoft Word 2019 Pas à pas par Joan Lambert”
« … les informations techniques ne sont pas une lecture de loisir pour la plupart des gens… ils se tournent vers les informations techniques par besoin… pour résoudre un problème… souvent ils ont peu de temps pour trouver les informations dont ils ont besoin. - Gretchen Hargins, et al. Développer des informations techniques de qualité, Presse IBM
Jour 3 – Madcap Flare Fundamentals (Partie 1)
- Une brève histoire de Flare;
- Projets:
- Qu'est-ce qu'un projet ;
- Ouverture, création, et la modification des projets ;
- Structure de fichier de projet ;
- FlareZip;
- Volets :
- organisateur de projet ;
- Explorateur de contenu ;
- Bases de la feuille de style ;
- La boîte de dialogue Options ;
- Options d'aide ;
- Les sujets:
- Qu'est-ce qu'un sujet ?
- Créer et modifier des sujets ;
- Aperçu des sujets ;
- Saisie du contenu :
- Texte;
- Images;
- Vidéo.
"Ne me dis pas comment ça marche. Dites-moi comment l'utiliser. - Un client.
Jour 4 – Madcap Flare Fundamentals (Partie 2)
- Principaux éléments de soutien :
- TOC (table des matières) ;
- extraits ;
- Peaux;
- Conditions;
- Cibles ;
- Variables ;
- Pages maîtres et mises en page ;
- Les sorties:
- HTML5 ;
- Hébergement des sorties HTML5 (Comp., Comprimés, Téléphone (s);
- PDF ;
- livres électroniques ;
- Autres sorties ;
- Principes fondamentaux de l'approvisionnement unique ;
- Bases CSS.
- Matériel de support (inclus) :
- Guide d'étude Flexwrite.
- FUSÉE DE MADCAP 2019 r2 par Madcap Software reproduit avec permission).
« … ne radote pas, cependant… je ne vais pas radoter là-dessus. - Kurt Vonnegut, Jr. romancier et publiciste technique pour General Electric.
Sections du programme
Ce programme est divisé en trois sections: Fondements de la rédaction technique, Microsoft Word™ avancé, et les fondamentaux de Madcap Flare™.
REMARQUE: Ces cours sont présentés dans l'ordre mais peuvent être suivis individuellement.
Les cours se déroulent avec un minimum de 3 et un maximum de 8 étudiants.
Fondamentaux de la rédaction technique (un jour)
CAD 760 / DOLLARS AMÉRICAINS$ 560
Ce cours se concentre sur la planification et l'exécution de documents. Cela comprend la définition de l'audience, cibles d'utilisation et de contenu, décider de la meilleure plate-forme de création pour exécuter le projet, créer un modèle, et développer un contenu efficace à créer et efficace lorsqu'il est livré. Les étudiants apprendront à planifier et à livrer des documents techniques de haute qualité.
Microsoft Word avancé (un jour)
CAD 760 / DOLLARS AMÉRICAINS$ 560
Cette section se concentre sur l'utilisation du principal outil de création au monde en tant que plate-forme avancée pour la création et la maintenance de documents linéaires.. Le cours va beaucoup plus loin que l'utilisation régulière de MS Word, recherche d'outils et de dispositifs internes permettant d'optimiser la qualité des documents. Les étudiants apprendront à utiliser MS Word à un niveau beaucoup plus élevé que l'utilisation habituelle.
Madcap Flare Fundamentals (Deux jours)
CAD 1520 / DOLLARS AMÉRICAINS$ 1120
Les troisième et quatrième jours sont consacrés à Madcap Flare : la plateforme de création thématique la plus efficace du marché aujourd'hui. Le cours couvre tous les principaux composants de Flare et fournit des informations sur la publication à source unique et multiplateforme. Les étudiants apprendront à générer facilement des contenus en ligne et PDF à source unique.