Comment rédiger la documentation technique

Instructions

1. Déterminer objectif et le public. Vous avez besoin de savoir pourquoi vous créez cette documentation et qui sera le lisez. Le type de documentation que vous créez sera différent si votre public est un mécanicien de voiture que si votre public est un ingénieur logiciel.

2. 
   
   
   
   

   Collecter des informations. La personne qui crée la documentation est souvent un écrivain et non pas l`expert en la matière. Il est important de recueillir les informations afin que vous puissiez documenter. La collecte de l`information peut signifier faire de la recherche, une entrevue avec un expert en la matière, ou à expérimenter avec le produit lui-même, comme dans le cas d`un programme de logiciel.

3. Organiser et présenter des informations. Vous pouvez commencer par un document existant ou un modèle. Il&# X2019-s important d`entrer les informations que vous avez et quitter les zones vierges où vous avez besoin de recueillir plus d`informations. Ce sera votre document de travail, et vous appuyer sur elle. Griffonner ce que vous avez même si vous avez de grands espaces vides vont dynamiser votre confiance que vous avancez dans le projet.

4. Écrivez le premier projet. Ceci est quand vous commencez à remplir les blancs et en permettant une circulation des idées pour écouter de votre conscience. Ne pas arrêter ce flux en révisant à ce stade.

5. Réviser et modifier. Vous pouvez mettre le document absent pour une période de temps afin que vous pouvez lui donner un look frais. Puis se concentrer sur des sujets qui ont besoin de plus attention- raccourcir, développer ou supprimer sections- ou réorganiser les paragraphes, des phrases ou des sujets entiers. Vous voudrez aussi à modifier pour le style, la grammaire et le contexte.