« La documentation/Rédaction technique/Rédaction d'un manuel d'utilisation » : différence entre les versions
Contenu supprimé Contenu ajouté
m diverses retouches |
m diverses retouches |
||
Ligne 99 :
** la date de révision du manuel et/ou son numéro de version,
** d'éventuelles mentions légales, notamment relatives au droit d'auteur et de reproduction, copyright,
** 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,
** éventuellement nom de l'auteur du document ;
* la table des matières ;
Ligne 112 :
Si des défauts, des non-conformités, des erreurs ou bogues ont été constatés, ils doivent être signalés. C'est une preuve de responsabilité et de maturité plus que de faiblesse (tout le monde sait que le zéro défaut est un objectif, pas une réalité) ; on songera par exemple à la liste des effets secondaires dans la notice d'un médicament…
D'un point de vue organisationnel, il vaut parfois mieux sortir un produit avec des erreurs connues et signalées, que
=== 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,
: « 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,
=== Mise en forme ===
Ligne 131 :
{{loupe|Du bon usage d'un traitement de texte}}
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'
Avec LaTeX, on utilisera
Ligne 139 :
Avec un traitement de texte classique, on peut utiliser pour les notes de marge un tableau à deux colonnes sans filet (trait) : la colonne de gauche est dans la marge et contient les notes, la colonne de droite contient le texte.
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
Il faut adopter une présentation aérée, avec des grandes marges, et changer de page entre chaque sujet, afin d'éviter les confusions et de permettre de retrouver facilement une information.
Ligne 145 :
==== 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
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).
Ligne 151 :
On peut utiliser des éléments surgissant, de type ''pop-up'' ou ''tooltip'' ; en HTML, on peut utiliser un titre (par exemple <code><span title="''message''">''objet''</span></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
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
== Spécificité de la source unique ==
|