Comment écrire un document technique

Recherche sur le public cible de votre document technique. Mode d`emploi utilisent un langage différent de notes de publication et rapports scientifiques. Votre public va dicter la langue que vous utilisez.

Créer un plan. Le plan devrait préciser clairement dans les étapes de ce que vous espérez accomplir dans le document technique. Par exemple: la première étape, introduire le public à l`étape deux par produit, détail ce que le produit peut DO- étape trois, comment installer l`étape par produit quatre, dépanner le produit.

Rester simple. Un document technique devrait être éducatif, et l`utilisateur ne doit jamais être deviner ce que vous voulez dire. Si vous le souhaitez pour mettre l`appareil de conditionnement d`air, vous devez indiquer quelle température l`unité doit être réglée sur et quand il doit être allumé.

Créer un projet de travail. Utilisez le plan pour créer une table des matières. Dans de nombreux cas, votre écriture technique va être lu par un certain nombre d`autres. Votre document devrait expliquer clairement le problème, pourquoi le problème et la solution sont intéressants, pourquoi le problème n`a pas été résolu précédemment et les éléments clés nécessaires pour atteindre les résultats.

Modifier le papier. La revue "The Elements of Style" par Strunk et blanc pour la gestion de style de papier. Éliminez tous les détails inutiles ou ambiguës. Les documents techniques peuvent sembler sec, mais ils doivent toujours être direct et au point.