« La documentation/Rédaction technique/Rédaction d'un manuel d'utilisation » : différence entre les versions
Contenu supprimé Contenu ajouté
? Annulation des modifications 458478 de 193.194.132.76 (discussion) |
|||
Ligne 64 :
Un manuel de type procédural est un manuel pas à pas. Dans le cas d'un produit complexe, il ne va pas expliquer la totalité du produit, mais simplement les principales utilisations. Il faut pour cela commencer par identifier lesdites utilisations.
Ce type de manuel doit permettre à une personne de prendre en main le produit rapidement. Il est bien adapté pour une personne non qualifiée (opérateur ne maîtrisant pas la théorie sous-jacente à l'utilisation du produit), un débutant ou un travailleur intérimaire, un stagiaire, en cas de départ de la personne utilisant habituellement le produit. Les entreprises écrivent fréquemment des procédures, le manuel doit pouvoir servir de base à ce travail.
Il ne faut pas hésiter à répéter les informations : si une personne utilise le produit en ayant le manuel à la main, il est vite ennuyeux de devoir tourner les pages pour trouver une autre information, puis de revenir. Si une opération est présente dans plusieurs procédures, on ne fera pas de référence croisée (de type « voir la section 1.7 p. 28 »), l'opération sera donc écrite intégralement à chaque fois. Si le manuel est rédigé avec un logiciel de type [[MediaWiki pour débutants|MediaWiki]], on pourra utiliser les [[w:Aide:Modèle|modèles]]. Avec LaTeX, on pourra mettre l'opération dans une [[Programmation LaTeX/Mise en forme du texte#Commandes personnelles|commande personnelle]] (voire dans un fichier spécifique).
| |||