Escritor técnico - Technical writer

Escritor técnico
Ocupación
Sinónimos Corresponsal técnico, editor técnico, redactor de documentación
Pronunciación
Sectores de actividad
 Software , tecnología , fabricación
Descripción
Competencias Habilidades analíticas
Pensamiento crítico
Campos de
empleo
 ONG , Corporaciones , Empresas
Trabajos relacionados
 Editor , redactor de discursos , guionista , corrector de pruebas , editor de textos

Un escritor técnico es un comunicador de información profesional cuya tarea es transferir información entre dos o más partes, a través de cualquier medio que mejor facilite la transferencia y comprensión de la información. Los escritores técnicos investigan y crean información a través de una variedad de medios de entrega (electrónicos, impresos, audiovisuales e incluso táctiles). Los tipos de información de ejemplo incluyen ayuda en línea , manuales, informes técnicos , especificaciones de diseño , planes de proyectos y planes de prueba de software. Con el auge del e-learning , los escritores técnicos se involucran cada vez más en la creación de material de capacitación en línea.

Según la Sociedad de Comunicación Técnica (STC):

La escritura técnica a veces se define como una simplificación de lo complejo. Inherente a una definición tan concisa y engañosamente simple es una amplia gama de habilidades y características que abordan casi todos los campos de la actividad humana en algún nivel. Un subconjunto significativo del campo más amplio de la comunicación técnica, la escritura técnica implica comunicar información compleja a aquellos que la necesitan para lograr alguna tarea u objetivo.

En otras palabras, los escritores técnicos toman conceptos técnicos avanzados y los comunican de la manera más clara, precisa y completa posible a su público objetivo, asegurando que el trabajo sea accesible para sus usuarios.

Kurt Vonnegut describió a los escritores técnicos como:

... entrenados para no revelar casi nada sobre ellos mismos en sus escritos. Esto los vuelve monstruos en el mundo de los escritores, ya que casi todos los demás desgraciados manchados de tinta en ese mundo revelan mucho sobre sí mismos al lector.

Los ingenieros, científicos y otros profesionales también pueden estar involucrados en la redacción técnica ( edición de desarrollo , corrección de pruebas , etc.), pero es más probable que empleen redactores técnicos profesionales para desarrollar, editar y formatear material, y asesorar sobre los mejores medios de entrega de información a sus usuarios. audiencias.

Historia de la profesión

Según la Society for Technical Communication (STC), las profesiones de comunicación técnica y redacción técnica se mencionaron por primera vez alrededor de la Primera Guerra Mundial , cuando los documentos técnicos se convirtieron en una necesidad para fines militares. El título del trabajo surgió en los EE. UU. Durante la Segunda Guerra Mundial, aunque no fue hasta 1951 que se publicó el primer anuncio de "Se busca ayuda: escritor técnico". De hecho, el título "Escritor técnico" no se agregó al Manual de empleo ocupacional de la Oficina de Estadísticas Laborales de EE. UU. Hasta 2010. Durante las décadas de 1940 y 1950, se contrató a comunicadores técnicos y escritores para producir documentación para los militares, que a menudo incluían instrucciones detalladas sobre nuevo armamento. Otros comunicadores y escritores técnicos participaron en el desarrollo de documentación para nuevas tecnologías que se desarrollaron en esta época. Según O'Hara:

La guerra fue el motor más importante del avance científico y tecnológico. El Cuerpo Médico del Ejército de los Estados Unidos luchó contra la malaria en las selvas de Panamá, el Cuerpo Químico impulsó avances químicos en explosivos y gases venenosos (y defensas contra ellos), el Distrito de Manhattan del Cuerpo de Ingenieros literalmente hizo grandes avances en la comprensión de la física y el Air Corps fue pionero en el diseño de aviación.

Al comienzo de la profesión, la mayoría de los escritores técnicos trabajaban en un entorno de oficina con un equipo de otros escritores. Al igual que los escritores técnicos de hoy, llevaron a cabo una investigación primaria y se reunieron con expertos en la materia para asegurarse de que su información fuera precisa. Durante la Segunda Guerra Mundial, una de las características más importantes para los escritores técnicos fue su capacidad para seguir las estrictas especificaciones gubernamentales para los documentos. Después de la guerra, el surgimiento de nuevas tecnologías, como la computadora, permitió a los escritores técnicos trabajar en otras áreas, produciendo "manuales de usuario, guías de referencia rápida, manuales de instalación de hardware y hojas de trucos". Durante el período posterior a la guerra (1953-1961), los comunicadores técnicos (incluidos los escritores técnicos) se interesaron en "profesionalizar" su campo. Según Malone, los comunicadores / escritores técnicos lo hicieron creando organizaciones profesionales, cultivando un "cuerpo de conocimiento especializado" para la profesión, imponiendo estándares éticos a los comunicadores técnicos, iniciando una conversación sobre la certificación de profesionales en el campo y trabajando para acreditar programas educativos. en el campo.

La profesión ha seguido creciendo; según O'Hara, la profesión de redacción / edición, incluidos los escritores técnicos, experimentó un aumento del 22% en puestos entre los años 1994 y 2005. Los escritores técnicos de hoy en día trabajan en una variedad de contextos. Muchos redactores técnicos trabajan de forma remota mediante VPN o se comunican con su equipo a través de plataformas de videotelefonía como Skype o Zoom . Otros redactores técnicos trabajan en una oficina, pero comparten contenido con su equipo a través de complejos sistemas de gestión de contenido que almacenan documentos en línea. Los redactores técnicos pueden trabajar en informes gubernamentales, documentación interna, instrucciones para equipos técnicos, ayuda incorporada dentro de software o sistemas, u otros documentos técnicos. A medida que la tecnología continúa avanzando, la gama de posibilidades para los escritores técnicos continuará expandiéndose. Muchos redactores técnicos son responsables de crear documentación técnica para aplicaciones móviles o documentación de ayuda construida dentro de aplicaciones móviles o web. Pueden ser responsables de crear contenido que solo se verá en un dispositivo portátil; gran parte de su trabajo nunca se publicará en un folleto impreso como la documentación técnica del pasado.

Conjunto de habilidades

Además de sólidas habilidades de investigación, lenguaje, redacción y revisión, un escritor técnico puede tener habilidades en:

Un redactor técnico puede aplicar sus habilidades en la producción de contenido no técnico, por ejemplo, redactar información de alto nivel para el consumidor. Por lo general, un redactor técnico no es un experto en la materia (PYME), pero entrevista a las PYME y realiza la investigación necesaria para redactar y compilar contenido técnicamente preciso. Los escritores técnicos completan la investigación primaria y secundaria para comprender completamente el tema.

Caracteristicas

Los escritores técnicos competentes tienen la capacidad de crear, asimilar y transmitir material técnico de manera concisa y eficaz. Pueden especializarse en un área en particular, pero deben tener un buen conocimiento de los productos que describen. Por ejemplo, los redactores de API trabajan principalmente en documentos de API , mientras que otros redactores técnicos se especializan en comercio electrónico , fabricación, material científico o médico .

Los escritores técnicos recopilan información de muchas fuentes. Sus fuentes de información suelen estar dispersas por toda la organización, que pueden ir desde desarrolladores hasta departamentos de marketing.

Según Markel, los documentos técnicos útiles se miden por ocho características: "honestidad, claridad, precisión, exhaustividad, accesibilidad, concisión, apariencia profesional y corrección". Los escritores técnicos se centran en utilizar su cuidadosa investigación para crear documentos eficaces que cumplan con estas ocho características.

Roles y funciones

Para crear documentación técnica eficaz, el escritor debe analizar tres elementos que comprenden la situación retórica de un proyecto en particular: audiencia, propósito y contexto. A estos le sigue el diseño del documento, que determina lo que ve el lector.

Análisis de audiencia

Artículo principal: análisis de audiencia

Los escritores técnicos se esfuerzan por simplificar conceptos o procesos complejos para maximizar la comprensión del lector. El objetivo final de un documento en particular es ayudar a los lectores a encontrar lo que necesitan, comprender lo que encuentran y usar lo que entienden de manera apropiada. Para alcanzar este objetivo, los escritores técnicos deben comprender cómo sus audiencias usan y leen la documentación. Un análisis de audiencia al comienzo de un proyecto de documento ayuda a definir lo que requiere una audiencia para un documento en particular.

Al analizar una audiencia, el redactor técnico suele preguntar:

  • ¿Quién es el público objetivo?
  • ¿Cuáles son sus características demográficas?
  • ¿Cuál es el papel de la audiencia?
  • ¿Cómo se siente el lector sobre el tema?
  • ¿Cómo se siente el lector con respecto al remitente?
  • ¿Qué forma espera el lector?
  • ¿Cuál es la tarea de la audiencia?
  • ¿Por qué la audiencia necesita realizar esa tarea?
  • ¿Cuál es el nivel de conocimiento de la audiencia?
  • ¿Qué factores influyen en la situación?

El análisis de audiencia preciso proporciona un conjunto de pautas que dan forma al contenido, el diseño y la presentación del documento (sistema de ayuda en línea, sitio web interactivo, manual, etc.) y el tono y el nivel de conocimiento.

Objetivo

Un escritor técnico analiza el propósito (o función) de una comunicación para comprender lo que debe lograr un documento. Determinar si una comunicación tiene como objetivo persuadir a los lectores para que "piensen o actúen de cierta manera, les permitan realizar una tarea, les ayuden a comprender algo, a cambiar su actitud", etc., guía al redactor técnico sobre cómo dar formato a su comunicación, y el tipo de comunicación que eligen (sistema de ayuda en línea, informe técnico, propuesta, etc.).

Contexto

El contexto son las circunstancias físicas y temporales en las que los lectores utilizan la comunicación, por ejemplo: en sus escritorios de oficina, en una planta de fabricación, durante los lentos meses de verano o en medio de una crisis empresarial. Comprender el contexto de una situación le dice al escritor técnico cómo los lectores usan la comunicación. Este conocimiento influye significativamente en cómo el escritor formatea la comunicación. Por ejemplo, si el documento es una guía rápida de resolución de problemas de los controles de una embarcación pequeña, el escritor puede plastificar las páginas para aumentar la vida útil.

Diseño de documentos

Una vez que se ha recopilado la información anterior, el documento está diseñado para una legibilidad y usabilidad óptimas. Según un experto, los escritores técnicos utilizan seis estrategias de diseño para planificar y crear la comunicación técnica: disposición, énfasis, claridad, concisión, tono y espíritu.

Arreglo
El orden y la organización de los elementos visuales para que los lectores puedan ver su estructura: cómo se unen en grupos, cómo se diferencian entre sí, cómo crean capas y jerarquías. Al considerar los arreglos, los redactores técnicos observan cómo usar encabezados, listas, gráficos e imágenes para aumentar la usabilidad.
Énfasis
Cómo un documento muestra secciones importantes a través de la prominencia o la intensidad. Al considerar el énfasis, los escritores técnicos deben ver cómo pueden mostrar a los lectores secciones importantes, advertencias, consejos útiles, etc. mediante el uso de ubicación, negrita, color y tamaño de letra.
Claridad
Estrategias que “ayudan al receptor a decodificar el mensaje, a comprenderlo rápida y completamente y, cuando sea necesario, a reaccionar sin ambivalencia”. Cuando se considera la claridad, el escritor técnico se esfuerza por reducir el ruido visual, como las relaciones de bajo contraste, los cuadros o gráficos demasiado complejos y la fuente ilegible, todo lo cual puede dificultar la comprensión del lector.
Concisión
El "volumen y complejidad visual" del diseño, por ejemplo, el número de encabezados y listas, líneas y recuadros, detalles de dibujos y presentaciones de datos, variaciones de tamaño, ornamentación y espaciado de texto. Los escritores técnicos deben considerar todas estas estrategias de diseño para garantizar que la audiencia pueda usar fácilmente los documentos.
Tono
El sonido o la sensación de un documento. El tipo de documento y la audiencia dictan si la comunicación debe ser formal y profesional, o alegre y divertida. Además de la elección del idioma, los escritores técnicos marcan el tono de la comunicación técnica mediante el uso de espacios, imágenes, tipos de letra, etc.
Carácter distintivo
El grado de credibilidad que alcanza el lenguaje visual en un documento. Los escritores técnicos se esfuerzan por crear documentación profesional y sin errores para establecer credibilidad con la audiencia.

Calificaciones

Los escritores técnicos normalmente poseen una combinación de habilidades técnicas y de escritura. Por lo general, tienen un título o certificación en un campo técnico, pero pueden tener uno en periodismo, negocios u otros campos. Muchos escritores técnicos cambian de otro campo, como el periodismo, o un campo técnico como la ingeniería o la ciencia, a menudo después de aprender importantes habilidades adicionales a través de clases de comunicación técnica.

Metodología (ciclo de vida de desarrollo de documentos)

Para crear un documento técnico, un escritor técnico debe comprender el tema, el propósito y la audiencia. Recopilan información mediante el estudio del material existente, entrevistando a las pymes y, a menudo, utilizando el producto. Estudian a la audiencia para conocer sus necesidades y su nivel de comprensión técnica.

El ciclo de vida del desarrollo de una publicación técnica generalmente consta de cinco fases, coordinadas con el plan general de desarrollo del producto:

  • Fase 1: Recopilación y planificación de información
  • Fase 2: Especificación de contenido
  • Fase 3: desarrollo e implementación de contenido
  • Fase 4: Producción
  • Fase 5: Evaluación

El ciclo de vida del desarrollo de documentos generalmente consta de seis fases (esto cambia de organización a organización, cómo están siguiendo).

  1. Perfilado de la audiencia (identificar la audiencia objetivo)
  2. Análisis de tareas de usuario (analizar tareas e información en función del público objetivo)
  3. Arquitectura de la información (diseño basado en análisis, cómo preparar documento)
  4. Desarrollo de contenido (desarrollar / preparar el documento)
  5. Revisiones técnicas y editoriales (revisión con personal de nivel superior: gerentes, etc.)
  6. Formatear y publicar (publicar el documento).

Esto es similar al ciclo de vida del desarrollo de software.

Los documentos técnicos bien redactados suelen seguir normas o directrices formales. La documentación técnica viene en muchos estilos y formatos, según el medio y el área temática. La documentación impresa y en línea puede diferir de varias maneras, pero aún así se adhiere a pautas en gran medida idénticas para la prosa, la estructura de la información y el diseño. Por lo general, los redactores técnicos siguen las convenciones de formato descritas en una guía de estilo estándar . En los EE. UU., Los escritores técnicos suelen utilizar The Associated Press Stylebook o el Manual de estilo de Chicago (CMS). Muchas empresas tienen guías de estilo corporativas internas que cubren cuestiones corporativas específicas, como el uso del logotipo, la marca y otros aspectos del estilo corporativo. El Manual de estilo de Microsoft para publicaciones técnicas es típico de ellos.

Los proyectos de ingeniería, en particular los proyectos relacionados con la defensa o la industria aeroespacial, a menudo siguen estándares de documentación nacionales e internacionales, como ATA100 para aeronaves civiles o S1000D para plataformas civiles y de defensa.

Medio ambiente

Los escritores técnicos a menudo trabajan como parte de un equipo de redacción o desarrollo de proyectos. Por lo general, el redactor termina un borrador y se lo pasa a una o más PYMES que realizan una revisión técnica para verificar la precisión y la integridad. Otro escritor o editor puede realizar una revisión editorial que verifique la conformidad con los estilos, la gramática y la legibilidad. Esta persona puede solicitar aclaraciones o hacer sugerencias. En algunos casos, el escritor u otros prueban el documento en miembros de la audiencia para realizar mejoras de usabilidad . Una producción final generalmente sigue una lista de verificación de inspección para garantizar la calidad y uniformidad del producto publicado.

Crecimiento profesional

No existe una carrera profesional estándar única para los escritores técnicos, pero pueden pasar a la gestión de proyectos por encima de otros escritores. Un escritor puede avanzar a un puesto de escritor técnico senior, manejando proyectos complejos o un pequeño equipo de escritores y editores. En grupos más grandes, un administrador de documentación puede manejar varios proyectos y equipos.

Los escritores técnicos también pueden adquirir experiencia en un dominio técnico particular y ramificarse en formas relacionadas, como el análisis de la calidad del software o el análisis empresarial. Un escritor técnico que se convierte en un experto en la materia en un campo puede pasar de la redacción técnica a trabajar en ese campo. Los escritores técnicos suelen producir capacitación para las tecnologías que documentan, incluidas las guías para el aula y el aprendizaje electrónico, y cierta transición para especializarse como capacitadores profesionales y diseñadores instruccionales.

Los escritores técnicos con experiencia en habilidades de redacción pueden unirse a empresas de medios impresos o electrónicos, lo que puede brindar una oportunidad para ganar más dinero o mejorar las condiciones de trabajo.

En abril de 2021, el Departamento de Trabajo de EE. UU. Esperaba que el empleo de redactores técnicos creciera un siete por ciento de 2019 a 2029, un poco más rápido que el promedio de todas las ocupaciones. Esperan que las oportunidades laborales, especialmente para los solicitantes con habilidades técnicas, sean buenas. El BLS también señaló que la expansión de los "productos científicos y técnicos" y la necesidad de que los redactores técnicos trabajen en el "soporte de productos basado en la web" impulsarán la creciente demanda.

A partir de junio de 2021, el salario promedio anual de un escritor técnico independiente en los Estados Unidos es de $ 70,191 según ZipRecruiter .

Escritores técnicos notables

Títulos similares

Los escritores técnicos pueden tener varios títulos de trabajo, incluido comunicador técnico, desarrollador de información , desarrollador de contenido técnico o especialista en documentación técnica . En el Reino Unido y algunos otros países, un escritor técnico a menudo se denomina autor técnico o autor del conocimiento .

  • Comunicador técnico
  • Autor técnico
  • Escritor de tecnología
  • Desarrollador de contenido técnico
  • Desarrollador de contenido
  • Diseñador de contenido
  • Desarrollador de información técnica
  • Arquitecto de información
  • Ingeniero de informacion
  • Diseñador de información
  • Desarrollador de información
  • Especialista en documentación
  • Especialista en gestión documental
  • Responsable de documentación
  • Ingeniero de textos

Ver también

Referencias

enlaces externos