Techniques de rédaction du manuel

Rédaction manuels techniques ou d'instruction appels à concis , facile à comprendre le langage et la présentation . Il existe plusieurs techniques de base qui aident à créer ce type de présentation . Chaque aide à présenter clairement les informations dans le manuel . Toutefois, le processus de rédaction de manuels efficaces commence par la recherche efficace du sujet . Comprendre le sujet et ensuite utiliser ces techniques pour présenter l'information de manière aussi efficace que possible . Présentation

L'intro définit le manuel . Expliquer qui devrait lire le document et qui est-il pas fait pour , les informations incluses et dans quelles circonstances est-il utile . Pour les manuels des produits , supposons que le lecteur a acheté le produit et est prêt à apprendre comment l'utiliser . Gardez la courte introduction afin que l'utilisateur obtient les aspects techniques du manuel le plus rapidement possible .
Outlines

Les manuels techniques sont souvent posées dans les sections et sous-sections , qui font également un aperçu idéal . Liste de toutes les sections prévues pour le manuel et inclus paragraphes détaillés le cas échéant . Ne pas avoir peur de réorganiser les sections que vous progressez. Juste parce que vous pensiez de sujet Un premier ne signifie pas que le lecteur a besoin que peu d'informations de première . L'ordonnance définitive des sections devrait refléter la progression naturelle l'utilisateur fera tout en apprenant le sujet . Utilisez un nom et du verbe dans le titre de section pour définir l'objet et l'action au sein de la section .
Être actif

Chaque étape d'un manuel technique charge le lecteur en une seule opération qui , lorsqu'elle est réalisée avec d'autres étapes , conduit à une action complète . Nombre des étapes ou des graphiques ont «balles » pour indiquer les étapes . Dans certains cas, les étapes peuvent être sous-étapes identifiées par des chiffres ou des lettres dans les étapes de base . Les écrivains ont une certaine latitude dans la façon dont ils s'identifient pas, mais devraient être compatibles dans le manuel.
Keep It Simple

Utiliser le langage le plus simple qui exprime adéquatement l'information . Vous ne savez pas qui va lire le manuel et la façon dont ils sont versés dans le jargon technique du sujet . Évitez de hauts niveaux de détail ou détails pas nécessaire pour transmettre l'information . Les longues peines , plus de 20 mots , ont tendance à décourager les lecteurs . Les peines de moins de 10 mots peuvent donner le document un son hacher
. Illustrer le sujet

Utilisez des photographies, des graphiques ou des diagrammes pour illustrer le sujet . Ces images peuvent être vaut mille mots et ont tendance à attirer l' œil du lecteur . Si les images graphiques ne sont pas possible , utiliser des phrases descriptives . Exemples verbales et illustrations permettent également au lecteur de visualiser le sujet .