« La documentation/Rédaction technique/Rédaction d'un manuel d'utilisation » : différence entre les versions

m
 
On peut envisager trois situations :
* ilIl s'agit d'un produit simple d'utilisation ;
* ilIl s'agit d'un produit complexe, mais on veut restreindre la partieles expliquéeexpliquations aux cas les plus simples, les cas complexes étant à la charge de spécialistes, ;<br /> c(C'est la cas par exemple d'un manuel d'entretient d'une voitureautomobile : Ou l'on explique, comment vérifier le niveau d'huile, changer une roue ou les ampoules, mais les réparations plus complexes sont à la charge d'un garagiste, ou d'un amateur éclairé) ;
* ilIl s'agit d'un produit complexe, dont l'utilisateur final doit tout connaître.
; La première question à se poser est donc : dans quelle situation se trouve-t-on ?
 
Ensuite, il faut se poser la question des prérequis pour l'utilisation du produit. Cela va déterminer le niveau de détail des explications, et le vocabulaire employé : faut-il en particulier définir les termes spécifiques, ou bien ceux-ci sont-ils considérés comme acquis ?
 
Par ailleurs, il faut connaître le statut légal du document, s'agit-il :
* dD'un document obligatoire d'après la législation ou la règlementation ?
* dD'un document contractuel (le contrat prévoit la fourniture de ce document) ?
* dD'un document facultatif que l'on fournit pour être agréable à l'utilisateur (pour des raisons commerciales ou bien pour l'aider à utiliser un produit libre et gratuit) ou que l'on vend à part du produit (par exemple un manuel d'utilisation d'un logiciel mais pas vendu avec).
 
En cas d'obligation légale, règlementaire ou contractuel, il faut connaître les termes de l'obligation pour s'y conformer. Il se pose également le problème de la langue dans laquelle on rédige. Dans le cadre d'une démarche qualité, il faut recueillir auprès des utilisateurs leurs attentes et avis sur la documentation, celle-ci suit un cycle d'amélioration continu.
 
 
Enfin, il faut savoir
* quiQui va rédiger le manuel : de préférence une personne proche des utilisateurs, afin de connaître leur culture, leurs préoccupations, mais en relation avec l'équipe de conception ;
* àA quel stade du projet on commence à rédiger : le manuel doit être prêt au moment de la sortie du produit, mais le produit doit être suffisamment proche de sa version finale pour que le manuel corresponde ;<br />dans le cas d'un logiciel par exemple, la rédaction peut commencer sur la base du cahier des charges (spécifications) pour ce qui est des parties générales (présentation, mise en place des grandes parties), puis sera affiné sur la base des versions bêta (la rédaction étant une occasion de tester les fonctionnalités, donc de déterminer le produit).
 
Les réponses à ces questions vont déterminer le format du manuel, l'épaisseur du livre ou le nombre d'écrans d'aide. Et cela va donc déterminer l'outil utilisé pour le créer : quel logiciel ? Un traitement de texte suffit-il ? Faut-il un logiciel de gestion de documentation ?
263

modifications