Rédiger un manuel technique est une tâche simple qui implique l’organisation d’étapes et la création d’un libellé clair et concis. Le but d'un manuel technique est de fournir des informations sur la manière d'effectuer une opération en un minimum d'étapes et de la manière la plus claire possible. Les manuels techniques impliquent souvent la collaboration de nombreuses personnes, y compris des experts en la matière, des éditeurs et des rédacteurs techniques. Etant donné que les manuels techniques peuvent également être constamment révisés et mis à jour, la communication entre les parties impliquées est cruciale pour l'élaboration d'un manuel.
Déterminez le style du manuel technique en créant un guide de style simplifié ou en suivant un guide de style existant, tel que le Guide de style Microsoft pour les manuels techniques. Un guide de style aidera à créer le squelette du manuel et à en assurer la cohérence.
Écrivez les étapes de la procédure en commençant par un verbe. Si une consultation est nécessaire pour rédiger les étapes, interroger et poser des questions à des experts en la matière. Cela garantira la validité des procédures; sinon, les étapes pourraient ne pas être logiques et / ou en panne. Les étapes doivent être ordonnées logiquement et séparées en chapitres ou divisions logiques.
Ajoutez des graphiques et des illustrations aux étapes qui les nécessitent. N'oubliez pas d'ajouter une numérotation des figures et des titres à chaque graphique / illustration.
Créez une table des matières et un index pour pouvoir vous y référer facilement.
Ajoutez un journal des modifications ou une feuille de mise à jour qui enregistre chaque modification et mettez-le à jour dans le manuel pour les révisions et versions futures. Les manuels techniques doivent toujours être édités par une personne autre que le rédacteur technique, de préférence par un éditeur professionnel.
