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

** l'adresse de l'organisme référent pour le document, organisme auquel on peut demander un nouvel envoi si le document est défectueux, auquel adresserou des remarques et suggestions,

D'un point de vue organisationnel, il vaut parfois mieux sortir un produit avec des erreurs connues et signalées, que de faire des modifications de dernière minute sans les tester, ou bien que de faire monter le prix ou retarder la livraison : un utilisateur peut avoir un besoin immédiat d'un produit imparfait et être prêt à fonctionner en mode « dégradé » en attendant un correctif. Cela ne doit cependant pas inclure des défauts de sécurité, et êtresans utilisé avec parcimonie : cela seabus, faitcar auon risque de mécontenter l'utilisateur et d'entamer la réputation de l'organisation.

On se méfiera du jargon technique et des anglicismes. Si un concept précis nécessite un terme précis, donc peu courant, enil revanchevaut onmieux emploiele souventdéfinir dequ'employer nombreuxdes termes obscurs à tort et à travers ; un médecin parlera de « décubitus » pour la position allongée, un informaticien dira d'une fonction qu'elle est « implémentée » pour développée/implantée, …... Ce jargon non nécessaire sème le trouble dans l'esprit du lecteur, et on se rend compte qu'il n'est pas clair dans celui de l'auteur : un bon réflexe consiste à essayer d'expliquer en mots plus simples, et en français, un mot spécifique employé.

Le style utilisé doit aussi prendre en compte la culture des utilisateurs : culture professionnelle, mais aussi culture nationale, notamment lorsque l'on écrit en langue étrangère. Penser aussi que les francophones ne sont pas tous français, mais aussi belges, suisses, québécois, sénégalais, …... Par exemple, les manuels de rédaction technique anglophones recommandent, lorsque l'on représente des personnes, de ne pas se contenter d'hommes blancs, mais de représenter les deux sexes et différentes ethnies. Ils recommandent également d'alterner l'usage du masculin et du féminin pour désigner les personnes.

Les manuels d'utilisation ont fréquemment recours aux notes de marge. L'avantage est que la note est située à côté du texte qu'ilelle commente, contrairement à une note de bas de page ou de fin de chapitre. Cela permet, par exemple, de mettre la représentation d'un objet (par exemplecomme une pièce, un bouton graphique de l'interface d'un logiciel) : le dessin ne coupe pas le texte, il ne nuit pas à la continuité de lecture, mais on peut le trouver facilement. Il faut pour cela définir une marge importante pour le corps du texte, de 3 à 4 cm en plus de la marge classique (par exemple, les titres et les notes de marge sont à 2 cm du bord et le corps du texte à 5 ou 6 cm).

Les notes de marge sont fréquemment utilisées pour mettre des symboles attirant l'attention du lecteur sur le point détaillé dans le texte, ou indiquant le statut du texte (par exemple : indication de sécurité, opération délicate).

Il faut impérativement éviter les défilements horizontaux : il convient donc de contrôler la dimension d'affichage des images et des divers objets (tableaux par exemple) par rapport à la résolution des écrans. Il faut considérer que les écrans et cartes graphiques que peuvent avoir lesdes utilisateurs, qui ne sont pas forcément aussi performantes que cellesceux de l'auteur.

Le format d'aide Windows 95 ([[w:Microsoft WinHelp|WinHelp 4.0]]) possède des fonctionalités d'objets surgissantsurgissants, mais d'une part ce format est spécifique à la plateforme Windows et n'est donc pas portable, et d'autre part il n'est plus supporté par Windows Vista. Le format CHM ([[w:Microsoft Compressed HTML|Microsoft Compressed HTML]]) est du HTML, il est donc plus facilement transposable.

Le document doit posséder une page d'index, ou un outil permettant une recherche par mot-clef.