Comment écrire un manuel technique From Scratch

La rédaction d'un manuel technique est une tâche simple qui consiste à organiser les étapes et la création, la formulation claire et concise. L'objectif d'un manuel technique est de fournir des informations sur la façon d'effectuer une opération en un minimum d'étapes et de la manière la plus claire possible. Manuels techniques impliquent souvent la collaboration de nombreuses personnes, y compris les experts en la matière, les éditeurs et les rédacteurs techniques. Depuis manuels techniques peuvent également objet de révisions et mises à jour constante, la communication entre les parties concernées est essentielle au développement d'un manuel.

Instructions

  1. Déterminer le style du manuel technique soit en créant un guide de style simplifié ou en suivant un guide de style existant, comme le Guide Microsoft de style pour les manuels techniques. Un guide de style aidera à créer le squelette de l'emploi et d'assurer la cohérence.




  2. Ecrire les étapes de la procédure en commençant par un verbe. Si la consultation est nécessaire pour écrire les étapes, interviewer et poser des questions aux experts en la matière. Cela permettra d'assurer la validité des procedures- contraire, des mesures peuvent ne pas être logique et / ou sur commande. Des mesures devraient être logiquement ordonnés et séparés en chapitres ou divisions logiques.

  3. Ajouter des graphiques et des illustrations pour des mesures qui les obligent. Pensez à ajouter numérotation et les titres figure pour chaque graphique / illustration.




  4. Créer une table des matières et un index pour faciliter la consultation.

  5. Ajouter un journal des modifications ou de la feuille de mise à jour qui enregistre chaque changement et mise à jour du manuel pour les révisions et les versions futures. Les manuels techniques doivent toujours être édités par quelqu'un d'autre que le rédacteur technique, de préférence par un éditeur professionnel.

» » » » Comment écrire un manuel technique From Scratch