La communication technique ou de la documentation est le processus de convoyage "convivial" par écrit sur un sujet particulier à un public cible. Documentation technique varie d'un email d'affaires à des rapports d'affaires à un système mode d'emploi ou de l'aide. Beaucoup ne se tourner vers la documentation &# X201C-quand tout le reste échoue.&# X201D- Aucune documentation étonnant est souvent de mauvaise qualité à les mieux inexistante, au pire. Les sociétés d'informatique peuvent se sentir que leur logiciel est si facile, ils ne&# X2019-t besoin de documentation. Mais la documentation technique est moins cher que les appels de support technique. Avant que vous pouvez développer une bonne documentation technique, vous devez savoir que la documentation technique efficace est une mission bien planifiée et exécutée.
Déterminer objectif et le public. Vous devez 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.
Recueillir des informations. La personne qui crée la documentation est souvent un écrivain et non l'expert en la matière. Il est important de recueillir l'information de sorte que vous pouvez documenter. 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.
Organiser et présenter l'information. Vous pouvez commencer avec un document existant ou un modèle. Il&# X2019-s important d'entrer les informations que vous avez et quitter les zones vides là 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 grandes zones de l'espace vide va stimuler votre confiance que vous avancez dans le projet.
Écrivez le premier projet. Ceci est quand vous commencez à remplir les blancs et en permettant une circulation des idées pour écouter à partir de votre conscience. Ne pas arrêter ce flux en révisant à ce stade.
Réviser et modifier. Vous pouvez mettre le document de suite pour une période de temps de sorte que vous pouvez lui donner un regard neuf. Puis se concentrer sur des sujets qui ont besoin de plus attention- raccourcir, élargir ou de supprimer ou de réorganiser sections- paragraphes, des phrases, ou sujets entiers. Vous voudrez aussi pour modifier le style, la grammaire et le contexte.