La documentation technique

Le travail du rédacteur technique est varié :

Création de personas

En menant des entretiens ou sur la base de données émanant des services marketing, après-ventes ou pièces détachées, le rédacteur technique établit des personas qui correspondent aux utilisateurs principaux de sa documentation tout en tenant compte du contexte d’utilisation, du niveau de connaissance et de la culture de l’utilisateur.

Le conducteur souhaite savoir comment utiliser la machine en toute sécurité.
Persona d'un manuel d'utilisateur de machine, le conducteur
Il veut connaître la périodicité des opérations de maintenance et comment les réaliser.
Persona d'un manuel de maintenance, le technicien du client qui possède la machine
Il veut accéder rapidement à l’information ou une procédure fiable.
Persona d'un manuel de réparation, le technicien SAV du constructeur de la machine

Modélisation orientée tâche utilisateur et architecture de l'information

Cette phase consiste à modéliser les tâches que peut accomplir l’utilisateur et de définir le scénario d’usage sous forme d’arborescence. De ce schéma, en découle la structure de la documentation ou de l’interface.

Utilisation de langages contrôlés et guide de rédaction

Étude des normes pour connaître les éléments à mentionner, les obligations légales et les mentions de sécurités obligatoires.

Utilisation d’un guide de rédaction pour la formulation des instructions et emploi d’un langage contrôlé pour avoir un vocabulaire adapté et compréhensible par l’utilisateur comme l'ASD-STE 100.

Illustrations

À partir de photos ou de fichiers 3D, réalisation d’illustrations pour clarifier une instruction.

Vue des différentes touches d'une machine-outil et leurs fonctions.
Commandes d'une machine
Vue en éclaté de la nacelle d'une éolienne.
Catalogue de pièces détachées
Manuel complet d'une éolienne qui comprend l'installation, l'utilisation, la réparation et le démenbrement.
Couverture d'un manuel complet
Description du contenu de la boîte et prise en main.
Manuel d'utilisation d'un reader

Data modules

Chaque procédure constitue une unité indépendante qui sont assemblées en fonction de différents critères (les options de la machine, le niveau de l’utilisateur) pour constituer un document unique à la manière des pièces d’un puzzle.

Utilisation d’XML pour la structuration (langages DITA et S1000D) et XSL-FO/XSLT comme feuille de style et de transformation.