Wikilivres

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

Navigation interactive dans l’historique
← Modification précédenteModification suivante →
Contenu supprimé Contenu ajouté
VisuelWikicode
rv
Ligne 116 :
=== Style ===
 
'''''On se méfiera du jargon technique et des anglicismes. Si un concept précis nécessite un terme précis, donc peu courant, il vaut mieux le définir qu'employer des 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é.
: « Ce que l'on conçoit bien s'énonce clairement,
: Et les mots pour le dire arrivent aisément. »
: ''Nicolas Boileau''
 
'''''
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.
 
=== Mise en forme ===
Ligne 143 ⟶ 144 :
 
==== Document électronique ====
 
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 des utilisateurs ne sont pas forcément aussi performantes que ceux de l'auteur.
 
On évitera également les défilements verticaux : on s'arrangera pour que chaque page fasse une hauteur d'écran (même remarque que ci dessus).
 
On peut utiliser des éléments surgissant, de type ''pop-up'' ou ''tooltip'' ; en HTML, on peut utiliser un titre (par exemple <code>&lt;span title="''message''"&gt;''objet''&lt;/span&gt;</code>), ou une pseudo-classe dynamique (<code>:hover</code>, <code>:active</code> ou <code>:focus</code>), ou bien du JavaScript.
 
Le format d'aide Windows 95 ([[w:Microsoft WinHelp|WinHelp 4.0]]) possède des fonctionalités d'objets surgissants, 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.
 
L'objet surgissant (image ou texte) devrait être de taille réduite, par exemple l'équivalent d'une note (note de bas de page ou note de marge).
 
Le document doit posséder une page d'index ou un outil permettant une recherche par mot-clef.
 
== Spécificité de la source unique ==
Récupérée de « https://fr.wikibooks.org/wiki/La_documentation/Rédaction_technique/Rédaction_d%27un_manuel_d%27utilisation »