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

Contenu supprimé Contenu ajouté
m →‎Quelques questions préliminaires : pas de capitales dans une liste à puces
Ligne 24 :
 
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 les explications aux cas les plus simples, les cas complexes étant à la charge de spécialistes, (c'est par exemple le cas d'un manuel d'entretien d'une automobile où 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 ? »
Ligne 33 :
 
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 qui n'est pas vendu avec celui-ci).
 
En cas d'obligation légale, réglementaire ou contractuelle, 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.
Ligne 44 :
 
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 ;
* Àà 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 on l'affinera 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 ?