Escritura técnica - Technical writing

La redacción técnica es redactar o redactar comunicaciones técnicas que se utilizan en campos técnicos y ocupacionales, como hardware y software , ingeniería , química , aeronáutica , robótica , finanzas , medicina , electrónica de consumo , biotecnología y silvicultura . La redacción técnica abarca el subcampo más grande de la comunicación técnica.

La Sociedad de Comunicación Técnica define la comunicación técnica como cualquier forma de comunicación que exhiba una o más de las siguientes características: "(1) comunicar sobre temas técnicos o especializados, tales como aplicaciones informáticas, procedimientos médicos o regulaciones ambientales; (2) comunicar mediante el uso de tecnología, como páginas web, archivos de ayuda o sitios de redes sociales, o (3) proporcionando instrucciones sobre cómo hacer algo, independientemente de lo técnica que sea la tarea ".

Visión general

Más información: Redactor técnico

La redacción técnica la realiza un escritor técnico (o autor técnico) y es el proceso de redactar y compartir información técnica en un entorno profesional. La tarea principal de un redactor técnico es comunicar información técnica a otra persona o parte de la manera más clara y eficaz posible. La información que comunican los escritores técnicos suele ser compleja, por lo que es esencial contar con fuertes habilidades de redacción y comunicación. Los escritores técnicos no solo transmiten información a través del texto, sino que también deben dominar las computadoras. Los escritores técnicos utilizan una amplia gama de programas para crear y editar ilustraciones , programas de diagramación para crear ayudas visuales y procesadores de documentos para diseñar, crear y formatear documentos.

Si bien la redacción técnica se asocia comúnmente con la ayuda en línea y los manuales de usuario , el término documentación técnica puede abarcar una gama más amplia de géneros y tecnologías. Los comunicados de prensa , memorandos , informes , propuestas comerciales , hojas de datos , descripciones y especificaciones de productos , documentos técnicos , currículums y solicitudes de empleo son solo algunos ejemplos de redacción que pueden considerarse documentación técnica. Algunos tipos de documentación técnica no suelen ser manejados por redactores técnicos. Por ejemplo, un comunicado de prensa suele ser redactado por un redactor de relaciones públicas, aunque un redactor técnico puede tener su opinión sobre cualquier información técnica incluida en el comunicado de prensa.

Historia

Si bien la escritura técnica solo ha sido reconocida como una profesión desde la Segunda Guerra Mundial , sus raíces se remontan a la antigüedad clásica . Los críticos citan las obras de escritores como Aristóteles como las primeras formas de escritura técnica. El trabajo de Geoffrey Chaucer , Tratado sobre el astrolabio, es un ejemplo temprano de documento técnico . Los primeros ejemplos de escritura técnica se remontan al período del inglés antiguo.

Con la invención de la imprenta mecánica , el inicio del Renacimiento y el surgimiento de la Edad de la Razón , documentar los hallazgos se convirtió en una necesidad. Inventores y científicos como Isaac Newton y Leonardo da Vinci prepararon documentos que narraban sus invenciones y descubrimientos. Si bien nunca se denominaron documentos técnicos durante su período de publicación, estos documentos desempeñaron un papel crucial en el desarrollo de formas modernas de comunicación y redacción técnicas.

El campo de la comunicación técnica creció durante la Revolución Industrial . Había una necesidad creciente de proporcionar a las personas instrucciones para utilizar las máquinas cada vez más complejas que se estaban inventando. Sin embargo, a diferencia del pasado, donde las habilidades se transmitían a través de la tradición oral, nadie más que los inventores sabía cómo usar estos nuevos dispositivos. La escritura se convirtió así en la forma más rápida y eficaz de difundir información, y se deseaban escritores que pudieran documentar estos dispositivos.

Durante el siglo XX, la necesidad de redacción técnica se disparó y la profesión fue reconocida oficialmente. Los eventos de la Primera Guerra Mundial y la Segunda Guerra Mundial llevaron a avances en la medicina, el hardware militar, la tecnología informática y las tecnologías aeroespaciales. Este rápido crecimiento, junto con la urgencia de la guerra, creó una necesidad inmediata de documentación bien diseñada para respaldar el uso de estas tecnologías. La redacción técnica tuvo una gran demanda durante este tiempo, y "escritor técnico" se convirtió en un título de trabajo oficial durante la Segunda Guerra Mundial .

Después de la Segunda Guerra Mundial , los avances tecnológicos llevaron a un aumento de los bienes de consumo y el nivel de vida. Durante el auge de la posguerra, los servicios públicos como bibliotecas y universidades, así como los sistemas de transporte como autobuses y carreteras, experimentaron un crecimiento sustancial. Aumentaba la necesidad de que los escritores hicieran una crónica de estos procesos. También fue durante este período que las grandes empresas y las universidades comenzaron a usar computadoras. En particular, en 1949, Joseph D. Chapline fue el autor del primer documento técnico computacional, un manual de instrucciones para la computadora BINAC .

La invención del transistor en 1947 permitió que las computadoras se produjeran de manera más barata y dentro del rango de compra de las personas y las pequeñas empresas. A medida que crecía el mercado de estas " computadoras personales ", también crecía la necesidad de escritores que pudieran explicar y proporcionar documentación de usuario para estos dispositivos. La profesión de redactor técnico experimentó una mayor expansión durante los años setenta y ochenta a medida que la electrónica de consumo llegaba a los hogares de más y más personas.

En los últimos años, el protagonismo de las computadoras en la sociedad ha dado lugar a muchos avances en el campo de las comunicaciones digitales, lo que ha provocado cambios en las herramientas que utilizan los escritores técnicos. El hipertexto , los procesadores de texto , los programas de edición de gráficos y el software de diseño de páginas han hecho que la creación de documentos técnicos sea más rápida y sencilla, y los escritores técnicos de hoy en día deben dominar estos programas.

Técnicas

Una buena redacción técnica es concisa, enfocada, fácil de entender, sin errores y basada en la audiencia. Los escritores técnicos se enfocan en hacer que sus documentos sean lo más claros posible, evitando frases demasiado técnicas y elecciones estilísticas como voz pasiva y nominalizaciones. Debido a que los documentos técnicos se utilizan en situaciones del mundo real, siempre debe quedar explícitamente claro cuál es el tema de un documento técnico y cómo utilizar la información presentada. Sería desastroso si, por ejemplo, las instrucciones de un escritor técnico sobre cómo usar una máquina de rayos X de alta potencia fueran difíciles de descifrar.

La redacción técnica requiere que un escritor examine exhaustivamente a su audiencia. Un escritor técnico debe ser consciente del conocimiento existente de su audiencia sobre el material que está discutiendo, ya que la base de conocimientos de la audiencia del escritor determina el contenido y el enfoque de un documento. Por ejemplo, un informe de evaluación que discute los hallazgos de un estudio científico que se escribe para un grupo de científicos altamente capacitados se construirá de manera muy diferente a uno destinado al público en general. Los redactores técnicos no tienen por qué ser expertos en la materia (PYME) ellos mismos. A menudo colaboran con las pymes para completar tareas que requieren más conocimientos sobre un tema del que poseen.

La redacción técnica debe ser precisa. Un escritor técnico, después de analizar a su audiencia, sabe lo que necesita comunicar y luego debe transmitir el mensaje de manera precisa y ética. Pueden producirse repercusiones físicas, ambientales o financieras si un escritor hace esto incorrectamente. Conocer a la audiencia es esencial para la precisión porque el lenguaje se adaptará de acuerdo con lo que ya entienden sobre el tema en cuestión. Por ejemplo, con la compra se incluyen instrucciones sobre cómo montar una estantería de forma correcta y segura. Esas instrucciones están diseñadas para que cualquiera pueda seguirlas, incluidos detalles precisos sobre dónde va cada sujetador. Si esas instrucciones fueran inexactas, la estantería podría ser inestable y fallar.

El diseño y la disposición de los documentos también son componentes vitales de la redacción técnica. Los escritores técnicos dedican mucho tiempo a asegurarse de que sus documentos sean legibles porque un documento mal diseñado dificulta la comprensión del lector. El diseño de documentos técnicos enfatiza el uso adecuado de las opciones de diseño de documentos como viñetas, tamaño de fuente y texto en negrita. Los escritores técnicos también emplean comúnmente imágenes, diagramas y videos porque estos medios a menudo pueden transmitir información compleja, como las ganancias anuales de una empresa o las características de diseño de un producto, de manera mucho más eficiente que el texto.

Documentos técnicos

La escritura técnica cubre muchos géneros y estilos de escritura, según la información y la audiencia. Los documentos técnicos no son producidos únicamente por redactores técnicos. Casi todo el que trabaja en un entorno profesional produce documentos técnicos de alguna variedad. Algunos ejemplos de documentación técnica incluyen:

  • Las instrucciones y los procedimientos son documentos que ayudan a los desarrolladores o usuarios finales a operar o configurar un dispositivo o programa. Ejemplos de documentos instructivos incluyen manuales de usuario y guías de resolución de problemas para programas de computadora, hardware de computadora, productos para el hogar, equipo médico, productos mecánicos y automóviles.
  • Propuestas . La mayoría de los proyectos comienzan con una propuesta: un documento que describe el propósito de un proyecto, las tareas que se realizarán en el proyecto, los métodos utilizados para completar el proyecto y, finalmente, el costo del proyecto. Las propuestas cubren una amplia gama de temas. Por ejemplo, un redactor técnico puede redactar una propuesta que describa cuánto costará instalar un nuevo sistema informático, un profesional de marketing puede redactar una propuesta con las ofertas de productos y un profesor puede redactar una propuesta que describa cómo una nueva clase de biología será estructurado.
  • Los correos electrónicos , cartas y memorandos son algunos de los documentos escritos con más frecuencia en una empresa. Las cartas y los correos electrónicos se pueden construir con una variedad de objetivos; algunos generalmente tienen como objetivo simplemente comunicar información, mientras que otros están diseñados para persuadir al destinatario de que realice una determinada tarea. Si bien las cartas generalmente se escriben a personas fuera de la empresa, los memorandos (memorandos) son documentos escritos para otros empleados dentro de la empresa.
  • Comunicados de prensa . Cuando una empresa desea revelar públicamente un nuevo producto o servicio, tendrá un escritor que redacte un comunicado de prensa . Este es un documento que describe las funciones y el valor del producto para el público.
  • Las especificaciones son esquemas de diseño que describen la estructura, las piezas, el embalaje y la entrega de un objeto o proceso con suficiente detalle para que otra parte pueda reconstruirlo. Por ejemplo, un escritor técnico podría hacer un diagrama y escribir las especificaciones de un teléfono inteligente o una bicicleta para que un fabricante pueda producir el objeto.
  • Las descripciones son explicaciones más breves de procedimientos y procesos que ayudan a los lectores a comprender cómo funciona algo. Por ejemplo, un escritor técnico puede crear un documento que muestre los efectos de los gases de efecto invernadero o demuestre cómo funciona el sistema de frenado de una bicicleta.
  • Los currículums y las solicitudes de empleo son otro ejemplo de documentos técnicos. Son documentos que se utilizan en un entorno profesional para informar a los lectores de las credenciales del autor.
  • Los informes técnicos se escriben para proporcionar a los lectores información, instrucciones y análisis de las tareas. Los informes vienen en muchas formas. Por ejemplo, un redactor técnico podría evaluar un edificio que está a la venta y producir un informe de viaje que destaque sus hallazgos y si cree que el edificio debe comprarse. Otro escritor que trabaja para una empresa sin fines de lucro puede publicar un informe de evaluación que muestre los resultados de la investigación de la empresa sobre la contaminación del aire.
  • El estudio de caso es un informe publicado sobre una persona, grupo o situación que se ha estudiado a lo largo del tiempo; también  : una situación en la vida real que se puede mirar o estudiar para aprender sobre algo. Por ejemplo, la situación desafiante de una persona en su lugar de trabajo y cómo la resolvió es un estudio de caso.
  • Los libros blancos son documentos escritos para expertos en un campo y, por lo general, describen una solución a un desafío o problema tecnológico o empresarial. Los ejemplos de libros blancos incluyen un artículo que detalla cómo hacer que una empresa se destaque en el mercado o un artículo que explica cómo prevenir ciberataques a las empresas.
  • Sitios web . La llegada del hipertexto ha cambiado la forma en que se leen, organizan y acceden a los documentos. Los escritores técnicos de hoy en día a menudo son responsables de la creación de páginas en sitios web como páginas de "Acerca de nosotros" o páginas de productos. A menudo se espera que dominen las herramientas de desarrollo web.
  • Las hojas de datos son los documentos que resumen las características, las especificaciones clave, las características técnicas, los circuitos de la aplicación y alguna otra información importante sobre el producto, la máquina, el equipo, el software, la aplicación o el sistema en resumen.
  • Las guías de API están escritas para la comunidad de desarrolladores y se utilizan para explicar las interfaces de programación de aplicaciones .
  • Los sistemas de ayuda son centros de ayuda en línea que proporcionan a los usuarios información técnica sobre productos y servicios. Proporcionan contenido como páginas web que se ven en un navegador. El contenido se puede crear en el software del centro de ayuda, como Zendesk , o en herramientas de creación de ayuda o sistemas de administración de contenido de componentes que pueden crear un centro de ayuda como una salida HTML.

Instrumentos

Los redactores técnicos utilizan las siguientes herramientas para crear y presentar documentos:

  • Herramientas de autoedición o procesadores de texto . Los escritores técnicos utilizan procesadores de texto como Scrivener, Microsoft Word , Apple Pages y LibreOffice Writer para crear, editar, diseñar e imprimir documentos. Dado que la redacción técnica tiene que ver tanto con el diseño de la página como con el lenguaje escrito,también se utilizanherramientas mejoradas de autoedición como Adobe InDesign y LyX . Estos programas funcionan de manera similar a los procesadores de texto, pero brindan a los usuarios más opciones y características para el diseño del documento y automatizan gran parte del formato.
  • Ayuda a las herramientas de autoría . Estos son utilizados por redactores técnicos para crear los sistemas de ayuda que vienen empaquetados con productos de software, entregados a través de navegadores web o proporcionados como archivos que los usuarios pueden ver en sus computadoras. Al escribir procedimientos instructivos para describir programas mecánicos, eléctricos o de software, los redactores técnicos utilizan estas herramientas para ayudarlos a simplificar los procesos de ensamblaje, operación o instalación.
  • Sistemas de gestión de contenido de componentes . Estos también los utilizan los redactores técnicos para crear sistemas de ayuda y documentos. Los sistemas de gestión de contenido de componentes (CCMS) permiten a los escritores crear resultados similares a las herramientas de creación de ayuda, pero también proporcionan funciones de gestión de contenido, como gestión de versiones y flujos de trabajo integrados.
  • Software de edición de imágenes . A menudo, las imágenes y otros elementos visuales pueden comunicar información mejor que los párrafos de texto. En estos casos, los redactores técnicos utilizan software de edición de imágenes como Adobe Photoshop y GIMP para crear y editar los aspectos visuales de documentos como fotos, iconos y diagramas.
  • Programas de software colaborativos. Debido a que la redacción técnica a menudo implica la comunicación entre varias personas que trabajan para diferentes empresas, puede ser un asunto de colaboración. Los escritores técnicos utilizan sistemas Wiki y espacios de trabajo de documentos compartidos para trabajar con otros escritores y partes para construir documentos técnicos.
  • Herramientas de desarrollo web . Los trabajos de redactor técnico ya no se limitan a producir documentos. A veces también producen contenido para sitios web corporativos y otros sitios web profesionales de una empresa. Por lo tanto, se puede esperar que los escritores técnicos dominen las herramientas de desarrollo web como Adobe Dreamweaver .
  • Editores de texto . Programas como Microsoft Notepad , TextEdit o Wordstar permiten a los escritores técnicos editar texto sin formato . Los editores de texto se pueden utilizar para cambiar contenido, como archivos de configuración , archivos de documentación y código fuente del lenguaje de programación . Los editores de texto son ampliamente utilizados por escritores técnicos que trabajan con contenido en línea.
  • Software de gráficos. Para comunicar información estadística como el número de visitas a un restaurante o la cantidad de dinero que gasta una universidad en sus programas deportivos, los redactores técnicos utilizan gráficos y diagramas de flujo. Si bien programas como Microsoft Excel y Word pueden crear gráficos y cuadros básicos, a veces los redactores técnicos deben producir gráficos más complejos y detallados que requieren funciones que no están disponibles en estos programas y pueden necesitar recurrir a herramientas de gráficos y diagramas (por ejemplo, Microsoft Visio ).
  • Herramientas de captura de pantalla. Los escritores técnicos utilizan con frecuencia herramientas de captura de pantalla como Camtasia y Snagit . Al crear instrucciones para software de computadora, puede ser más fácil para un escritor técnico simplemente grabar un video corto de sus computadoras de escritorio mientras completan una tarea que escribir una larga serie de instrucciones que describan cómo se debe realizar la tarea. Las herramientas de captura de pantalla también se utilizan para tomar capturas de pantalla de programas y software que se ejecutan en las computadoras de los usuarios y luego para crear diagramas adjuntos.

Lista de asociaciones

Referencias

enlaces externos