Comment rédiger un document technique

Recherche sur le public cible de votre document technique. guides de l'utilisateur utilisent un langage différent de notes de version et des rapports scientifiques. Votre public va dicter la langue que vous utilisez.

Créer un plan. Le contour doit détailler clairement dans les étapes que vous espérez accomplir dans le document technique. Par exemple: la première étape, présenter à l'auditoire l'étape par produit deux, détail ce que le produit peut DO- troisième étape, comment installer l'étape par produit quatre, dépanner le produit.

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

Créez 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éressantes, 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. Examen "The Elements of Style" par Strunk et blanc pour la gestion de style de papier. Éliminez tous les détails inutiles ou ambigus. Des documents techniques peuvent sembler sec, mais ils doivent toujours être direct et au point.