Examinando el mundo del escritor técnico

La gente que escribe documentos técnicos provienen de todos los ámbitos de la vida - y la mayoría no son escritores técnicos per se. Estas son algunas de las situaciones reales de las personas que fueron llamados a escribir documentos técnicos en el ejercicio de sus profesiones:

• Programador: Pat se graduó con una licenciatura en ciencias de la computación y fue contratado como desarrollador de software para una empresa en la vía rápida. Varios meses más tarde, la compañía sintió una pizca financiera y despidió a los escritores técnicos. Pat tenía una gran entrega debido en unos pocos meses, y su supervisor le dijo que tenía que escribir un manual de usuario. Sophomore Inglés (que Pat luchó a través y detestaba) no prepararla para este tipo de misiones. Después de todo, Shakespeare no era una especie técnico del chico. Pobre Pat tuvo que salir del paso de escribir el manual de usuario y tiene el pelo gris prematuramente.

• Especialista en la fabricación: Bill trabajó para una empresa de fabricación durante muchos años y ha desarrollado una pieza de equipo que se esperaba para revolucionar la industria. El equipo hizo su debut en Alemania en la conferencia más grande de la industria. Supervisor Bill le pidió que entregue un documento (el término de la industria para una presentación técnica de hacer) en la conferencia. El público consistiría en más de 200 profesionales de la industria. No sólo hizo Bill temen el podio más de taladro del dentista, no sabía para preparar o entregar un documento técnico - especialmente en un país extranjero para un público de este calibre.

• Científico loco: Mientras trabajaba en una compañía farmacéutica, Nathaniel tenía un gran avance en el tratamiento que se comprometió a prevenir la calvicie. El presidente de la compañía le pidió que escribiera un artículo para una revista médica importante. Aunque Nathaniel se siente halagado por la petición del presidente, él no sabía nada acerca de la escritura o entregar un artículo técnico.

• Representante de ventas: Lynette era un representante de ventas para un distribuidor mundial de computadoras. A menudo estaría fuera de casa durante semanas a la vez. Después de 15 años como un guerrero de la carretera, Lynette sufría de agotamiento. (Ella solía dejar su foto en la repisa de la chimenea para que su familia no se olvidaría de ella.) Lynette había estado leyendo sobre el floreciente campo de la escritura tecnología. Ella llamó a una universidad local, se llevó toda la literatura, y decidió seguir una maestría en escritura técnica.

Aunque los nombres han sido cambiados para proteger a los inocentes (Lynette, por ejemplo, no se ha convertido en su renuncia aún), escenarios como estos son típicos. Los técnicos que no son escritores capacitados se les pide constantemente para escribir documentos técnicos. Su educación y experiencia laboral rara vez a prepararse para este tipo de desafío.

Documentos de la clase técnica

La gente en campos especializados escriben los documentos que se relacionan con temas técnicos o complejos. A diferencia de los documentos de negocio que se escriben generalmente por una sola persona, los documentos técnicos son a menudo un esfuerzo de colaboración entre un escritor, experto en la materia (SME), editor, y otros. Los documentos técnicos están generalmente destinados a una gran cantidad de lectores. Estas son algunas de documentos técnicos comúnmente escritos - papel y electrónicos:

• Resúmenes

• Artículos para su publicación

• La capacitación basada en computadora (CBT)

• Formas de evaluación

• Resúmenes ejecutivos

• Especificaciones funcionales y detalle

• Ayuda en linea

• Presentaciones

• Cuestionarios

• Informes

• Material didáctico (papel o electrónico)

• Manuales de usuario

• Formación basada en Web (WBT)

Asignar la responsabilidad de documentos técnicos

La responsabilidad de la redacción de documentos técnicos depende de la estructura y los recursos de una empresa. Aquí hay tres maneras que las empresas normalmente generan documentos técnicos:

1. gurús técnicos (ingenieros, desarrolladores de software, y otros) escriben sus propios documentos. Algunas de estas personas pueden haber tomado cursos de escritura, pero la mayoría no tienen formación por escrito un documento coherente. Estos "escritores técnicos" a menudo pasan por alto pasos para compartir con sus lectores, porque estas medidas son obvias para ellos. Y probablemente no han identificado las necesidades de sus lectores. Escriben lo que es importante para ellos.

2. Estos mismos gurús pueden redactar documentos y luego gire los borradores a los escritores técnicos para editar, formato y polaco. A menos que el escritor técnico tiene la oportunidad de aprender la materia íntimamente, muchos de los pasos que pueden haber sido pasados ​​por alto por el gurú no identificado por el escritor o editor. Este proceso, sin embargo, producir un documento que puede ser más agradable a la vista - por lo que vale la pena.

3. Un escritor técnica se llama desde el inicio de un proyecto. El escritor trabaja con el desarrollador que es el experto en la materia (SME). Trabajan como un equipo de colaboración, cada uno añadiendo su experiencia al proyecto. Este enfoque es generalmente el mejor de los mundos posibles.

Estrategia, no de software

Cualquier persona que escribe documentos técnicos deben entender lo importante que es tomar un enfoque estratégico. Por ejemplo, si se diseña una casa personalizada, es lo que primero llama a alguien para manejar un martillo? Por supuesto que no. Un martillo es más que una herramienta. Para diseñar una costumbre de origen, se llama a un arquitecto - un profesional capacitado que esquemas de trazado hace planes para la plomería, electricidad y calefacción Sistemas y proporciona la estructura. Luego de llamar a alguien que sabe martillos.

Lo mismo es cierto en la redacción técnica. Documentos técnicos eficaces requieren un arquitecto de información - un escritor técnico. Si esta persona es un escritor técnico profesional o un desarrollador de ingeniero o de software que escribe documentos técnicos, se debe planificar, diseñar y proporcionar estructura lógica. Cualquier persona puede aprender a utilizar el software para crear el documento. Al igual que el martillo, el software no es más que una herramienta. La clave para escribir un gran documento es estrategia, no software.

Muy pocas personas tienen esa amplia base de conocimientos. La escritura técnica es sobre el uso estrategia y recursos escribir documentos claros, precisos y lógicas. Si se aplica una estrategia lógica y servirse de los recursos, puede escribir cualquier cosa - se convierta en el equipo para el montaje de un avión a reacción.

Lo que usted necesita para tener éxito

He aquí una instantánea de lo que se necesita para escribir documentos técnicos claros y comprensibles:

• Mostrar respeto por el lector. Siempre se debe escribir con respeto a su lector. Escribir con una actitud positiva, no con arrogancia. Los escritores técnicos hablan de sus lectores con arrogancia con comentarios tales como: "No escribimos estos documentos para idiotas. Si son tan estúpidos, que no deberían usar este producto." (Bueno, me excuuuuse!) Incluso el humanoide más brillante puede experimentar confusión cuando se le presenta algo totalmente nuevo.

• Preste mucha atención a los detalles. Usted muestra su buen ojo para el detalle en la forma de pensar sobre lo que escribes. Aquí hay algunos elementos con viñetas extraídas de una hoja de vida de alguien que estaba solicitando un puesto como escritor técnico:

• "Contribuir escritor semanario de la ciudad." (¿Qué periódico? ¿Qué quiere escribir sobre? El periódico es semanal, pero es su contribución semanal? Bimestral? Mensual?)

• "Generated informes técnicos." (¿Qué quiere decir con "generada"? ¿Escribió el informe o simplemente haga clic en el botón Imprimir y arrojan a cabo?)

• Este escritor no fue capaz de identificar los detalles que un posible empleador quiere responder. Por lo tanto, era obvio que no podía identificar a los detalles que su audiencia necesita. Usted debe ser capaz de anticipar las preguntas que sus lectores se pida, y debes responderlas.

• Conozca a sus lectores y sus necesidades. A diferencia de una carta que usted puede escribir para un lector específico, a menudo se escribe un documento técnico para un grupo diverso de lectores. Usted debe entender sus necesidades con el fin de determinar la forma de escribir el documento y si medio impreso o electrónico es el adecuado.

• Los esfuerzos de colaboración. Para ajustar la famosa cita de John Donne: Ningún escritor de tecnología es una isla. Incluso si usted es el único escritor de tecnología en su proyecto, que vamos a trabajar con la gente dentro y fuera de la organización: las PYME, editores, especialistas publicación / electrónicos, y los usuarios finales.

• Demostrar la capacidad de la pierna-o su ego. Por último, pero no menos importante, debe ser capaz de dejar su ego en la puerta. El documento final será a menudo muy diferente de su proyecto original. Todo el que revisa el documento se siente obligado a coger un bolígrafo y se marca para arriba. Todo esto es parte del proceso - la necesidad de hacer una contribución. Por lo tanto, estar preparado para tener su trabajo editado, re-editado, y tal vez trizas.