Examinar el mundo del escritor técnico

  1. Educación
  2. Artes del Lenguaje
  3. Escritura expositiva
  4. Examinar el mundo del escritor técnico

Libro Relacionado

Redacción técnica para tontos

Por Sheryl Lindsell-Roberts

Las personas que escriben documentos técnicos provienen de todos los ámbitos de la vida, y la mayoría no son escritores técnicos en sí mismos. He aquí algunas situaciones reales de personas que fueron llamadas a escribir documentos técnicos en el curso de sus profesiones:

  • Programador de computadoras: Pat se graduó con un título en ciencias de la computación y fue contratada como desarrolladora de software para una empresa en la vía rápida. Varios meses más tarde, la compañía sintió un aprieto financiero y despidió a los escritores técnicos. Pat tenía un gran entregable que entregar en pocos meses, y su supervisor le dijo que tenía que escribir un manual de usuario. El inglés de segundo año (por el que Pat luchó y odiaba) no la preparó para este tipo de tarea. Después de todo, Shakespeare no era un tipo técnico. La pobre Pat tuvo que arreglárselas para escribir el manual de usuario y se encaneció prematuramente.
  • Especialista en fabricación: Bill trabajó para una compañía manufacturera durante muchos años y desarrolló un equipo que se esperaba revolucionara la industria. El equipo hizo su debut en Alemania en la mayor conferencia 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. El público estaría compuesto por más de 200 profesionales de primera línea de la industria. Bill no sólo temía el podio más que el taladro del dentista, sino que no sabía que debía 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 tuvo un gran avance en un tratamiento que prometí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 sintió halagado por la petición del presidente, no sabía nada sobre cómo escribir o enviar un artículo técnico.
  • Representante de ventas: Lynette era representante de ventas de un distribuidor mundial de computadoras. A menudo estaba fuera de casa durante semanas. Después de 15 años como guerrera de la carretera, Lynette sufrió de agotamiento. (Solía dejar su foto en el manto de la chimenea para que su familia no la olvidara.) Lynette había estado leyendo sobre el floreciente campo de la escritura tecnológica. Llamó a una universidad local, obtuvo toda la literatura y decidió obtener una maestría en escritura técnica.

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

Documentos de carácter técnico

Las personas que trabajan en campos especializados escriben documentos que se relacionan con temas técnicos o complejos. A diferencia de los documentos comerciales que generalmente son escritos por una sola persona, los documentos técnicos son a menudo un esfuerzo de colaboración entre un escritor, un experto en la materia (SME), un editor y otros. Los documentos técnicos están generalmente destinados a muchos lectores. Aquí están algunos documentos técnicos comúnmente escritos – en papel y electrónicos:

  • Formación por ordenador (CBT)
  • Especificaciones funcionales y de detalle
  • Material de formación (en papel o electrónico)

Asignar la responsabilidad de los documentos técnicos

La responsabilidad de redactar los documentos técnicos depende de la estructura y los recursos de la empresa. He aquí tres maneras en las que las empresas suelen generar documentos técnicos:

1. Los 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 capacitación para escribir un documento coherente. Estos “escritores técnicos” a menudo pasan por alto pasos para compartir con sus lectores porque estos pasos son obvios 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 entregarlos a redactores técnicos para que los editen, formateen y pulan. A menos que el escritor técnico tenga la oportunidad de aprender el tema íntimamente, muchos de los pasos que pueden haber sido pasados por alto por el gurú no son identificados por el escritor o editor. Este proceso, sin embargo, produce un documento que puede ser más agradable a la vista – por si sirve de algo.

3. Se llama a un redactor técnico desde el inicio de un proyecto. El escritor trabaja con el desarrollador que es el experto en la materia (PYME). Trabajan como un equipo de colaboración, cada uno de los cuales aporta su experiencia al proyecto. Este enfoque es generalmente el mejor de todos los mundos posibles.

Estrategia, no software

Cualquiera que redacte documentos técnicos debe entender lo crítico que es adoptar un enfoque estratégico. Por ejemplo, si usted diseña una casa personalizada, ¿llama primero a alguien para que empuñe un martillo? Por supuesto que no. Un martillo es simplemente una herramienta. Para diseñar una casa personalizada, usted llama a un arquitecto – un profesional capacitado que diseña el diseño; hace planes para los sistemas de plomería, electricidad y calefacción; y provee la estructura. Entonces llama a alguien que sepa de martillos.

Lo mismo ocurre con la escritura técnica. Los documentos técnicos eficaces requieren un arquitecto de la información – un escritor técnico. Ya sea que esta persona sea un escritor técnico profesional o un ingeniero o desarrollador de software que escribe documentos técnicos, debe planificar, diseñar y proporcionar una estructura lógica. Cualquiera puede aprender a utilizar el software para crear el documento. Al igual que el martillo, el software es simplemente una herramienta. La clave para escribir un gran documento es la estrategia, no el software.

Muy pocas personas tienen una base de conocimientos tan amplia. La redacción técnica trata sobre el uso de estrategias y recursos para escribir documentos claros, precisos y lógicos. Si aplica una estrategia lógica y aprovecha los recursos, puede escribir casi cualquier cosa, desde encender el ordenador hasta montar un avión a reacción.

Lo que necesitas para tener éxito

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

  • Muestre respeto por su lector. Siempre debes escribir con respeto a tu lector. Escriba con una actitud positiva, no con arrogancia. Los escritores técnicos a menudo hablan arrogantemente de sus lectores con comentarios como: “No escribimos estos documentos para idiotas. Si son tan estúpidos, no deberían usar este producto”. (¡Bueno, discúlpenme!) Incluso el humanoide más brillante puede experimentar confusión cuando se le presenta algo completamente nuevo.
  • Preste mucha atención a los detalles. Muestras tu aguda visión de los detalles en la forma en que piensas sobre lo que escribes. Aquí hay algunos artículos con viñetas extraídos de un currículum vitae de alguien que estaba solicitando un puesto como escritor técnico:

– “Escritor colaborador del semanario de la ciudad.” (¿Qué periódico? ¿Sobre qué escribe? El periódico es semanal, ¿pero su contribución es semanal? ¿Bimensualmente? ¿Mensual?)

– “Generación de informes técnicos”. (¿Qué quiere decir con “generado”? ¿Escribió el informe o simplemente hizo clic en el botón Imprimir y lo escupió?)

– Este escritor no fue capaz de identificar los detalles que un empleador potencial quiere que se contesten. Por lo tanto, era obvio que no podía identificar los detalles que su público necesitaba. Usted debe ser capaz de anticipar las preguntas que sus lectores harán, y usted debe responderlas.

  • Conozca a sus lectores y sus necesidades. A diferencia de una carta que se 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 para determinar cómo escribir el documento y si los medios impresos o electrónicos son apropiados.
  • Esfuerzos de colaboración. Para modificar la famosa cita de John Donne: Ningún escritor técnico es una isla. Incluso si usted es el único escritor de tecnología en su proyecto, trabajará con gente dentro o fuera de la organización: PYMES, editores, especialistas en publicaciones/electrónica y usuarios finales.
  • Demostrar la habilidad para mantener tu ego. Por último, pero no menos importante, debes ser capaz de dejar tu ego en la puerta. Su documento terminado será a menudo muy diferente de su borrador original. Todos los que revisan el documento se sienten obligados a tomar un bolígrafo y marcarlo. Todo es parte del proceso – la necesidad de hacer una contribución. Por lo tanto, prepárese para que su trabajo sea editado, reeditado y tal vez hecho jirones.

Reply