Examinando el mundo del escritor técnico

Las personas que escriben documentos técnicos provienen de todos los ámbitos de la vida - y la mayoría no son escritores técnicos per se. Aquí hay algunas situaciones reales de personas que fueron llamados a escribir documentos técnicos en el curso de su profesión:

  • Programador: Pat se graduó con un título en ciencias de la computación y fue contratado como desarrollador de software para una compañía en la vía rápida. Varios meses más tarde, la compañía sintió una pizca financiera y despidió a los redactores 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 luchado a través de y odiaba) no prepararla para este tipo de asignación. Después de todo, Shakespeare no era una especie de técnica chico. Pobres 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 desarrolló 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. El supervisor de Bill le pidió que entregara un documento (el término de la industria para hacer una presentación técnica) en la conferencia. La audiencia podría consistir 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. Aunque Nathaniel se sintió halagado por la petición del presidente, él no sabe nada acerca de la escritura o entregar un artículo técnico.
  • Representante de ventas: Lynette era un representante de ventas para un distribuidor de equipo en todo el mundo. 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. (Se utiliza para salir de su imagen en la capa de la chimenea para que su familia no la olvidaría.) Lynette había estado leyendo sobre el floreciente campo de la escritura tecnología. Llamó a una universidad local, se llevó toda la literatura, y decidió obtener un título de maestría en la 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 están capacitados escritores se les pide constantemente para escribir documentos técnicos. Su educación y experiencia de trabajo 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 refieren a temas técnicos o complejos. A diferencia de los documentos comerciales que por lo general están escritas por una sola persona, documentos técnicos son a menudo un esfuerzo de colaboración entre un escritor, experto en la materia (SME), editor, y otros. documentos técnicos están destinados generalmente para una gran cantidad de lectores. Aquí están algunos documentos técnicos comúnmente escritos - papel y electrónica:

  • resúmenes
  • Artículos para su publicación
  • formación asistida por ordenador (CBT)
  • formularios de evaluación
  • Los resúmenes
  • Especificaciones funcionales y detalle
  • Ayuda en linea
  • presentaciones
  • cuestionarios
  • Informes
  • El material de formación (papel o electrónico)
  • Manuales de usuario
  • formación basada en web (WBT)

La asignación de la responsabilidad de los documentos técnicos

La responsabilidad para la escritura de documentos técnicos depende de la estructura y los recursos de una empresa. Aquí hay tres maneras que las empresas suelen generar los documentos técnicos:

Video: Russian

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 cohesivo. Estos “escritores técnicos” a menudo pasan por alto los pasos para compartir con sus lectores debido a que estos pasos son obvios para ellos. Y es probable que no se han identificado las necesidades de sus lectores. Ellos escriben lo que es importante para ellos.

2. Estos mismos gurús pueden redactar documentos y luego girar las corrientes de aire a los escritores técnicos para editar, formatear y esmalte. 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 son identificados por el autor 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écnico 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 debe entender lo importante que es tomar un enfoque estratégico. Por ejemplo, si se quiere diseñar una costumbre de origen, es lo primero que llama a alguien para manejar un martillo? Por supuesto 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 hace que los esquemas de trazado planes para la fontanería, electricidad, y Sistemas de calefacción y proporciona la estructura. A continuación, se llama a alguien que conozca 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 profesional técnico o un ingeniero desarrollador o software que escribe documentos técnicos, se debe planificar, diseñar y proporcionar la 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 en el software.

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

Video: El mundo que habitamos no es un Valle de Lágrimas, por Emilio Carrillo

Lo que se necesita para tener éxito

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

  • Mostrar respeto por el lector. Debe escribir siempre con respeto a su lector. Escribir con una actitud positiva, no con arrogancia. Los escritores técnicos a menudo hablan de sus lectores arrogantemente 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 presenta con algo totalmente nuevo.
  • Prestar mucha atención a los detalles. Usted muestra su buen ojo para el detalle en la forma de pensar acerca de lo que escribe. Aquí están algunos elementos con viñetas extraídas de una hoja de vida de alguien que estaba aplicando para una posición como escritor técnico:

Video: Despertando el Yo Soy por Emilio Carrillo PARTE 3

• “Colaborador en la escritura periódico semanal de la ciudad.” (¿Qué periódico? ¿Qué escribe sobre? El periódico es semanal, pero es su programa semanal de contribución? Bimestral? Mensual?)

• “informes técnicos generados.” (Lo que quiere decir con “genera”? ¿Escribió el informe o simplemente haga clic en el botón de impresión y los vomitará?)

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

  • Conocer sus lectores y sus requisitos. A diferencia de una letra que 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 apropiado.
  • Los esfuerzos de colaboración. Para ajustar la famosa cita de John Donne: Sin 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 personas dentro o fuera de la organización: Pymes, 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.
Artículos Relacionados