L'examen du monde de l'écrivain technique

Les gens qui écrivent des documents techniques viennent de tous les horizons de la vie - et la plupart ne sont pas les rédacteurs techniques en soi. Voici quelques situations réelles des personnes qui ont été appelés à rédiger des documents techniques dans le cadre de leur profession:

• Programmeur: Pat a obtenu un diplôme en informatique et a été embauché en tant que développeur de logiciels pour une entreprise dans la voie rapide. Plusieurs mois plus tard, l'entreprise a senti une pincée financière et mis à pied les rédacteurs techniques. Pat avait un grand livrable raison dans quelques mois, et son superviseur lui a dit qu'elle avait à écrire un manuel d'utilisation. Sophomore anglais (ce qui a lutté à travers Pat et détestait) n'a pas la préparer à ce type de mission. Après tout, Shakespeare était pas une sorte technique de gars. Pauvre Pat a dû se débrouiller écrit le mode d'emploi et a les cheveux gris prématurément.

• Spécialiste de la fabrication: Bill a travaillé pour une entreprise de fabrication depuis de nombreuses années et a développé une pièce d'équipement qui devait révolutionner l'industrie. L'équipement a fait ses débuts en Allemagne, à la plus grande conférence de l'industrie. Le superviseur de projet de loi lui a demandé de fournir un document (le terme de l'industrie pour une présentation technique rendant) lors de la conférence. Le public serait composé de plus de 200 professionnels de l'industrie. Non seulement le projet de loi craignent le podium plus que le forage du dentiste, il ne savait pas de préparer ou de livrer un document technique - en particulier dans un pays étranger pour un public de ce calibre.

• Scientifique fou: Tout en travaillant à une société pharmaceutique, Nathaniel avait une percée majeure sur un traitement qui a promis de prévenir la calvitie. Le président de la compagnie lui a demandé d'écrire un article pour un journal médical majeur. Bien que Nathaniel a été flatté par la demande du président, il ne savait pas la première chose à propos de l'écriture ou de soumettre un article technique.

• Commercial: Lynette était un représentant des ventes pour un distributeur informatique mondial. Elle avait souvent être loin de la maison pendant des semaines à la fois. Après 15 ans comme un guerrier de la route, Lynette a souffert d'épuisement professionnel. (Elle sert à quitter son image sur le manteau de la cheminée de sorte que sa famille ne serait pas l'oublier.) Lynette avait lu sur le domaine en plein essor de l'écriture de la technologie. Elle a appelé un collège local, a obtenu toute la littérature, et a décidé de poursuivre un diplôme de maîtrise en rédaction technique.

Bien que les noms ont été changés pour protéger les innocents (Lynette, par exemple, n'a pas encore tourné sa démission), des scénarios comme ceux-ci sont typiques. Les gens techniques qui ne sont pas formés écrivains sont constamment invités à rédiger des documents techniques. Leur formation et leur expérience de travail dont les préparer rarement pour ce type de défi.

Documents de la nature technique

Les gens dans des domaines spécialisés écrire des documents qui se rapportent à des sujets techniques ou complexes. Contrairement documents commerciaux qui sont généralement écrits par une seule personne, les documents techniques sont souvent un effort de collaboration entre un écrivain, expert en la matière (PME), rédacteur en chef, et autres. Les documents techniques sont généralement destinés à un bon nombre de lecteurs. Voici quelques documents techniques couramment écrites - papier et électronique:

• Résumés

• Des articles pour publication

• Formation assistée par ordinateur (CBT)

• Les formulaires d'évaluation

• Des résumés

• Spécifications fonctionnelles et de détail

• Aide en ligne

• Présentations

• Questionnaires

• Rapports

• Le matériel de formation (papier ou électronique)

• Manuels d'utilisation

• Formation sur le Web (WBT)

Attribution des responsabilités pour les documents techniques

La responsabilité de la rédaction de documents techniques dépend de la structure et des ressources d'une entreprise. Voici trois façons dont les entreprises génèrent habituellement des documents techniques:

1. gourous techniques (ingénieurs, développeurs de logiciels, et autres) écrivent leurs propres documents. Certaines de ces personnes ont peut-être pris des cours d'écriture, mais la plupart ont aucune formation en rédaction d'un document cohérent. Ces «rédacteurs techniques" donnent souvent des étapes de partager avec leurs lecteurs, car ces étapes sont évidentes pour eux. Et ils ont probablement pas identifié les besoins de leurs lecteurs. Ils écrivent ce qui est important pour eux.

2. Ces mêmes gourous peuvent rédiger des documents, puis tournez les projets au cours de rédacteurs techniques pour modifier, le format, et polonais. À moins que le rédacteur technique a l'occasion d'apprendre le sujet intimement, la plupart des étapes qui peuvent avoir été négligés par le gourou ne sont pas identifiés par l'auteur ou de l'éditeur. Ce processus ne produit cependant un document qui peut être plus agréable à l'œil - pour ce que ça vaut.

3. Un rédacteur technique est appelée depuis le début d'un projet. L'écrivain travaille avec le développeur qui est le spécialiste en la matière (PME). Ils travaillent comme une équipe de collaboration, chacun ajoutant leur expertise au projet. Cette approche est généralement le meilleur de tous les mondes possibles.

Stratégie, pas de logiciel

Toute personne qui rédige des documents techniques doit comprendre comment il est essentiel d'adopter une approche stratégique. Par exemple, si vous concevez un accueil personnalisé, avez-vous d'abord appelez quelqu'un à manier un marteau? Bien sûr que non. Un marteau est simplement un outil. Pour concevoir un accueil personnalisé, vous appelez un architecte - un professionnel qualifié qui conçoit layout- rend plans pour la plomberie, l'électricité et le chauffage SYSTÈMES et fournit la structure. Ensuite, vous appelez quelqu'un qui sait marteaux.

La même chose est vraie en rédaction technique. Documents techniques efficaces exigent un architecte de l'information - un rédacteur technique. Si cette personne est un rédacteur technique professionnel ou un développeur d'ingénieur ou logiciels qui rédige des documents techniques, elle doit planifier, concevoir et fournir une structure logique. Tout le monde peut apprendre à utiliser le logiciel pour créer le document. Tout comme le marteau, le logiciel est simplement un outil. La clé de la rédaction d'un grand document est stratégie, pas de logiciel.

Très peu de gens ont cette large base de connaissances. Rédaction technique consiste à utiliser stratégie et les ressources à rédiger des documents clairs, exacts et logiques. Si vous appliquez une stratégie logique et vous prévaloir des ressources, vous pouvez écrire à peu près tout - de tourner sur votre ordinateur pour l'assemblage d'un avion à réaction.

Qu'est-ce que vous avez besoin pour réussir

Voici un aperçu de ce qu'il faut pour rédiger des documents techniques clairs et compréhensibles:

• Montrer du respect pour votre lecteur. Vous devez toujours écrire avec respect pour votre lecteur. Ecrire avec une attitude positive, non pas avec arrogance. Les rédacteurs techniques parlent souvent de leurs lecteurs arrogance avec des remarques telles que: «Nous ne écrivons ces documents pour des idiots. Si ils sont si stupides, ils ne devraient pas utiliser ce produit." (Eh bien, moi excuuuuse!) Même les plus brillants humanoïde peut ressentir une confusion lorsqu'ils sont présentés avec quelque chose d'entièrement nouveau.

• Faites attention désireux de détails. Vous montrez votre sens aigu du détail dans la façon dont vous pensez à ce que vous écrivez. Voici quelques éléments à puces extraites d'un CV de quelqu'un qui a été une demande pour un poste de rédacteur technique:

# 8226- "Contribution à la rédaction hebdomadaire journal de la ville." (Quel journal? Que fait-il écrire? Le journal est hebdomadaire, mais est son hebdomadaire de contribution? Bimestriel? Mensuel?)

# 8226- "Généré rapports techniques." (Qu'est-ce qu'il veut dire par «généré»? At-il rédiger le rapport ou simplement cliquer sur le bouton Imprimer et crachent-ils?)

# 8226- Cet écrivain était pas en mesure d'identifier les détails qui un employeur potentiel veut répondu. Par conséquent, il était évident qu'il ne pouvait pas identifier les détails que son public a besoin. Vous devez être capable d'anticiper les questions que vos lecteurs se poser, et vous devez y répondre.

• Connaissez vos lecteurs et de leurs exigences. Contrairement à une lettre que vous pouvez écrire pour un lecteur spécifique, vous écrivez souvent un document technique pour un groupe diversifié de lecteurs. Vous devez comprendre leurs besoins afin de déterminer la façon dont vous écrivez le document et si médias imprimés ou électroniques est approprié.

• Les efforts de collaboration. Pour modifier la citation célèbre de John Donne: Aucun écrivain tech est une île. Même si vous êtes le seul écrivain tech sur votre projet, vous travaillez avec des gens à l'intérieur ou à l'extérieur de l'organisation: les PME, éditeurs, spécialistes publication / électroniques, et les utilisateurs finaux.

• Démontrer la capacité de la jambe-o votre ego. Last but not least, vous devez être capable de laisser votre ego à la porte. Votre document final sera souvent très différent de votre projet initial. Toute personne qui examine le document se sent obligé de prendre un stylo et de marquer le haut. Tout cela fait partie du processus - de la nécessité d'apporter une contribution. Alors, préparez-vous à avoir votre ouvrage édité, réédité, et peut-être déchiré en lambeaux.