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

C'est là un des malheurs des modes d'emploi : souvent, ils ne sont souvent pas lus. La culture « usenet » a d'ailleurs une réponse toute faite pour ce syndrome : RTFM, « relis ton foutu manuel » ''(read the fucking manual)''<ref>les yeux chastes liront « fameux/''fine'' » pour le F</ref>.

À partir de là, certains en sont venus à considérer que le seul intérêt d'un manuel d'utilisation était de pouvoir rétorquer à l'utilisateur : « mais si, c'est écrit page ''n'', vous n'aviez qu'à lire. ». Une manière bien pratique de ne pas se remettre en question.

Pourtant, qui n'a pas pesté contre un manuel mal traduit (ou issu d'une traduction automatique), contre un plan de montage d'un meuble en kit mal illustré ou pas assez détaillé, contre une information introuvable ?

* Utile : Uneune information exacte, mais inutile, ne fait que renforcer le sentiment d'inutilité et gêne la recherche de l'information pertinente ;

* Agréable : Quantquant à la forme, la clarté (présentation, style), mais aussi en mettant en avant les préoccupations de l'utilisateur et non pas les caractéristiques techniques du produit.

* Il 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 ?" »

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 à une tellece procéduretravail.

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 difficilevite d'avoirennuyeux à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]], 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]] (voirvoire dans un fichier spécifique).

Le manuel doit être abondamment illustré par des dessins ou des photographies clairs (pensez que certaines entreprises font des procédures sous la forme de bande dessinée pour le personnel illettré), par des dessins ou des photographies clairs.

Un manuel pédagogique est plutôt du type « incrémental » : c'est un manuel dans lequel on présente d'abord l'utilisation de manière générale, pour ensuite détailler certains points. Ce n'est plus exactement un manuel procédural, puisque l'on ne suit pas les opérations dans l'ordre. L'avantage d'un tel manuel est que lorsque l'on présente une opération détaillée, le lecteur la replace facilement dans le contexte, et connaît la finalité de l'opération. Cela permet une meilleure compréhension, une meilleure assimilation.

Par exemple, pour un logiciel de traitement de données, on ferafait une première section présentant un traitement classique : chargement des données, traitement dans un cas simple, sauvegarde et impression du résultat. PuisEnsuite, on va dans le détail : cas plus compliqués, paramètres ajustables, modifiermodification ledu format d'impression, …...

Par exemple, les règles vendues avec un échiquierjeu d'échecs sont certes complètes et pertinentes, mais ne permettent pas pour autant de progresser ; il faut pour cela avoir recours à un manuel pédagogique avec exemples et exercices.

On remarque que de plus en plus de logiciels dont la prise en main est relativement intuitive sont livrés sans manuel d'utilisation papier (mais toutefois avec une aide en ligne), leur prise en main étant relativementmais intuitive ; maison disposentdispose de nombreux livres pédagogiques, à acheter en sus. Il suffit de regarder le rayon Microsoft Word ou Adobe Photoshop d'une librairie informatique.

Ce type de manuel se veut exhaustif. On va là parcourir le produit de A à Z. L'organisation ne suit alors plus la logique dedu l'utilisateurconcepteur mais plutôtque celle dude concepteurl'utilisateur : on liste les sous-ensembles un par un.