Escritura técnica

La redacción técnica es la redacción de contenido técnico, particularmente relacionado con las ciencias industriales y otras ciencias aplicadas , con énfasis en contextos ocupacionales . ^[1] La gama de audiencias para la redacción técnica varía ampliamente. En algunos casos, está dirigido a personas con conocimientos especializados, como expertos o técnicos. ^[2] En otras situaciones, los redactores técnicos ayudan a transmitir temas científicos complejos o especializados a los usuarios finales que necesitan una comprensión básica de un concepto en lugar de una explicación completa de un tema. ^[3] La redacción técnica es la mayor parte de la comunicación técnica . ^[4]

Ejemplos de campos que requieren redacción técnica incluyen hardware y software de computación , arquitectura , ingeniería , química , aeronáutica , robótica , finanzas , medicina , electrónica de consumo , biotecnología y silvicultura .

Descripción general

La redacción técnica la realiza un redactor técnico (o autor técnico) y es el proceso de escribir y compartir información técnica en un entorno profesional. ^[5]^{: 4} 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 efectiva posible. ^[5]^{: 4}^[6] La información que comunican los redactores técnicos suele ser compleja, por lo que son esenciales 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 redactores 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 dar formato a documentos. ^[7]

Si bien la redacción técnica se asocia comúnmente con instrucciones y manuales de usuario , los términos redacción técnica y documentación técnica pueden cubrir una gama más amplia de géneros y formatos. memorandos , informes , propuestas comerciales , hojas de datos , descripciones y especificaciones de productos y documentos técnicos son solo algunos ejemplos de escritos que pueden considerarse documentación técnica. ^[8] Y para trabajos altamente técnicos (por ejemplo, ingeniería y otras ciencias aplicadas), algunos aspectos de los currículums y solicitudes de empleo también pueden considerarse redacción técnica.

La redacción técnica no siempre está a cargo de redactores técnicos dedicados. Por ejemplo, los ingenieros suelen necesitar escribir directamente sobre su propio trabajo. En el aspecto comercial, los materiales de marketing o los comunicados de prensa generalmente los escriben personas en esos campos, aunque es posible que un redactor técnico u otra persona técnica necesite tener aportes sobre cualquier tema técnico involucrado.

Historia

Si bien la escritura técnica sólo ha sido reconocida como profesión desde la Segunda Guerra Mundial , ^[9]^{: 2}^[10] sus raíces se remontan a la antigüedad clásica . ^[11]^{: 233} Los críticos citan las obras de escritores como Aristóteles como las primeras formas de escritura técnica. ^[11]^{: 234} La obra de Geoffrey Chaucer , Tratado sobre el astrolabio , es un ejemplo temprano de documento técnico . ^[12] Los primeros ejemplos de escritura técnica se remontan al período del inglés antiguo. ^[13]

Con la invención de la imprenta mecánica , el inicio del Renacimiento y el surgimiento de la Era 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 relataban sus inventos y hallazgos. ^[9]^{: 1} 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. ^[9]

El campo de la comunicación técnica creció durante la Revolución Industrial . ^[14]^{: 3} Había una necesidad creciente de proporcionar a la gente instrucciones para utilizar las máquinas cada vez más complejas que se estaban inventando. ^[14]^{: 8} Sin embargo, a diferencia del pasado, donde las habilidades se transmitían a través de tradiciones orales, nadie además de los inventores sabía cómo utilizar estos nuevos dispositivos. Así, la escritura se convirtió en la forma más rápida y eficaz de difundir información, y se deseaban escritores que pudieran documentar estos dispositivos. ^[14]

Durante el siglo XX, la necesidad de redacción técnica se disparó y la profesión pasó a ser reconocida oficialmente. Los acontecimientos de la Primera Guerra Mundial y la Segunda Guerra Mundial llevaron a avances en medicina, hardware militar, tecnología informática y tecnologías aeroespaciales. ^[9]^{: 2} 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 esta época, y "escritor técnico" se convirtió en un título de trabajo oficial durante la Segunda Guerra Mundial. ^[9]^{: 1}

Después de la Segunda Guerra Mundial , los avances tecnológicos provocaron un aumento de los bienes de consumo y del nivel de vida. ^[9]^{: 3} 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. Aumentó la necesidad de que los escritores hicieran una crónica de estos procesos. ^[9]^{: 1} También fue durante este período que las grandes empresas y universidades comenzaron a utilizar computadoras. En particular, en 1949, Joseph D. Chapline fue autor del primer documento técnico computacional, un manual de instrucciones para la computadora BINAC . ^[15]

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 individuos y pequeñas empresas. ^[9]^{: 3} 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. ^[9]^{: 3} La profesión de escritor técnico experimentó una mayor expansión durante las décadas de 1970 y 1980 a medida que la electrónica de consumo llegó a los hogares de más y más personas. ^[9]

En los últimos años, la prominencia de las computadoras en la sociedad ha generado muchos avances en el campo de las comunicaciones digitales, lo que ha provocado cambios en las herramientas que utilizan los escritores técnicos. ^[9]^{: 3} El hipertexto , los procesadores de texto , los programas de edición de gráficos y el software de composición de páginas han hecho que la creación de documentos técnicos sea más rápida y sencilla, y los redactores técnicos de hoy deben dominar estos programas. ^[5]^{: 8–9}

Documentos técnicos

La escritura técnica cubre muchos géneros y estilos de escritura, según la información y la audiencia. ^[5]^{: 84–114} Los documentos técnicos no son producidos únicamente por redactores técnicos. Casi cualquiera que trabaje en un entorno profesional produce documentos técnicos de alguna variedad. Algunos ejemplos de documentación técnica incluyen:

Las guías API están escritas para la comunidad de desarrolladores y se utilizan para explicar las interfaces de programación de aplicaciones .
Un estudio de caso es un informe publicado sobre una persona, grupo o situación que ha sido estudiado a lo largo del tiempo; también : una situación de la vida real que se puede observar o estudiar para aprender sobre algo. ^[16] Por ejemplo, la situación desafiante de un individuo en su lugar de trabajo y cómo la resolvió es un estudio de caso.
Las hojas de datos son documentos que resumen las características, especificaciones clave, características técnicas, circuitos de aplicación y alguna otra información importante sobre el producto, máquina, equipo, software, aplicación o sistema en breve.
Las descripciones son explicaciones más breves de procedimientos y procesos que ayudan a los lectores a comprender cómo funciona algo. ^[5]^{: 564} Por ejemplo, un escritor técnico podría escribir un documento que muestre los efectos de los gases de efecto invernadero o demuestre cómo funciona el sistema de frenos de una bicicleta.
Los correos electrónicos , las cartas y los memorandos son algunos de los documentos escritos con más frecuencia en una empresa. ^[17]^{: 117} Las cartas y los correos electrónicos se pueden redactar 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 para que realice una determinada tarea. Si bien las cartas generalmente se escriben a personas ajenas a una empresa, los memorandos (memorandos) son documentos escritos a otros empleados dentro de la empresa. ^[17]^{: 118}
Los sistemas de ayuda son centros de ayuda en línea que brindan 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 un software de centro de ayuda, como Zendesk , o en herramientas de creación de ayuda o sistemas de gestión de contenido de componentes que pueden crear un centro de ayuda como salida HTML.
Las instrucciones y procedimientos son documentos que ayudan a los desarrolladores o usuarios finales a operar o configurar un dispositivo o programa. ^[17]^{: 226} Ejemplos de documentos instructivos incluyen manuales de usuario y guías de solución de problemas para programas de computadora, hardware de computadora, productos para el hogar, equipos médicos, productos mecánicos y automóviles.
Comunicados de prensa . Cuando una empresa quiere 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. ^[18]
Propuestas . La mayoría de los proyectos comienzan con una propuesta: un documento que describe el propósito, las tareas requeridas, los métodos que se utilizarán y el costo del proyecto. ^[17]^{: 191} 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 escribir una propuesta con las ofertas de productos y un profesor puede escribir una propuesta que describa cómo se desarrollará una nueva clase de biología. estará estructurado.
Los currículums y las solicitudes de empleo son otro ejemplo de documentos técnicos. ^[17]^{: 284–285} Son documentos que se utilizan en un entorno profesional para informar a los lectores sobre las credenciales del autor.
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 como para que otra parte pueda reconstruirlo. ^[19] Por ejemplo, un escritor técnico podría diagramar y escribir las especificaciones de un teléfono inteligente o una bicicleta para que un fabricante pueda producir el objeto.
Los informes técnicos se escriben para proporcionar a los lectores información, instrucciones y análisis de las tareas. ^[17]^{: 141–143} Los informes se presentan 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 debería 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.
Sitios web . La llegada del hipertexto ha cambiado la forma en que se leen, organizan y acceden a los documentos. Los redactores técnicos de hoy en día suelen ser responsables de la creación de páginas en sitios web como páginas "Acerca de nosotros" o páginas de productos. A menudo se espera que dominen las herramientas de desarrollo web. ^[20]^{: 484–504}
Los libros blancos son documentos escritos para expertos en un campo y generalmente describen una solución a un desafío o problema tecnológico o comercial. ^[17]^{: 644} Los ejemplos de documentos técnicos 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 ataques cibernéticos a las empresas.

Herramientas

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

Herramientas de autoedición o procesadores de texto . Los redactores 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 de autoedición mejoradas como Adobe InDesign y LyX . ^[21] 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. ^[22]
Herramientas de creación de ayuda . Los redactores técnicos los utilizan para crear sistemas de ayuda que se incluyen con productos de software, se entregan a través de navegadores web o se proporcionan como archivos que los usuarios pueden ver en sus computadoras. Al escribir procedimientos de instrucción 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 contenidos de componentes . Los redactores técnicos también los utilizan para crear sistemas y documentos de ayuda. Los sistemas de gestión de contenido de componentes (CCMS) permiten a los escritores crear resultados similares a las herramientas de ayuda a la creación, 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. ^[5]^{: 306–307} 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 fotografías, iconos y diagramas.
Programas de software colaborativos. Debido a que la redacción técnica a menudo implica comunicación entre varias personas que trabajan para diferentes empresas, puede ser un asunto de colaboración. ^[5]^{: 57} Los redactores técnicos utilizan Wiki Systems y espacios de trabajo de documentos compartidos para trabajar con otros escritores y partes para construir documentos técnicos. ^[5]^{: 74}
Herramientas de desarrollo web . Los trabajos de redacción técnica ya no se limitan únicamente a producir documentos. A veces también producen contenido para los sitios web corporativos y otros sitios web profesionales de una empresa. ^[20]^{: 485} 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 redactores técnicos editar texto sin formato . Los editores de texto se pueden utilizar para cambiar contenidos 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 redactores 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. ^[5]^{: 306–307} Si bien programas como Microsoft Excel y Word pueden crear gráficos y tablas 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 es posible que deban recurrir a herramientas de gráficos y diagramas ( por ejemplo, Microsoft Visio ). ^[23]
Herramientas de captura de pantalla. Los redactores técnicos utilizan con frecuencia herramientas de captura de pantalla como Camtasia y Snagit . ^[24]^[25] Al crear instrucciones para software de computadora, puede ser más fácil para un redactor técnico simplemente grabar un video corto de sus escritorios mientras completan una tarea que escribir una larga serie de instrucciones que describan cómo funciona el software. 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

^ "¿Qué es la redacción técnica? - Tech Writer Today".
^ Hamlin, Annemarie; Rubio, Chris; Desilva, Michele (2015). "Análisis de audiencia".
^ Marshall, Carrie (2018). Redacción técnica para empresarios (1ª ed.). Swindon Reino Unido. pag. 1.
^ "Comunicaciones técnicas - ¿Qué es? - Tech Writer Today".
^ abcdefghi Mike Markel (2012). Comunicación Técnica 10ª Edición . Bedford/St. Martín.
^ "Redactores técnicos: Manual de perspectivas ocupacionales: Oficina de estadísticas laborales de EE. UU.". www.bls.gov . Consultado el 14 de febrero de 2024 .
^ Johnson, Tom (19 de diciembre de 2011). "¿Qué herramientas utilizan los redactores técnicos?". Preferiría estar escribiendo . Consultado el 4 de mayo de 2014 .
^ Perelman, Leslie C.; Barrett, Eduardo; Paradis James. "Tipos de documentos". El manual de redacción científica y técnica de Mayfield . Consultado el 4 de mayo de 2014 .
^ abcdefghijk O'Hara, Fredrick M. Jr. "Una breve historia de la comunicación técnica" (PDF) . Facturaciones de la Universidad Estatal de Montana . Consultado el 22 de abril de 2014 .
^ Alamargot, Denis; Terrier, Patrice; Cellier, Jean-Marie, eds. (1 de octubre de 2007). Documentos escritos en el lugar de trabajo. doi :10.1163/9789004253254. ISBN 9780080474878.
^ ab Doody, Aude; Follinger, Sabine; Taub, Liba (8 de febrero de 2012). "Estructuras y estrategias en la escritura técnica griega y romana antigua: una introducción" (PDF) . Estudios de Historia y Filosofía de la Ciencia . Universidad de Cambridge. 43 (2): 233–236. Código Bib : 2012SHPSA..43..233D. doi :10.1016/j.shpsa.2011.12.021. Archivado desde el original (PDF) el 3 de agosto de 2012 . Consultado el 22 de abril de 2014 .
^ "El camino a las estrellas: construye tu propio astrolabio". Colegio de San Juan . Consultado el 22 de abril de 2014 .
^ Hagge, John (julio de 1990). "El primer escritor técnico en inglés: un desafío a la hegemonía de Chaucer". Revista de Redacción y Comunicación Técnica . 20 (3): 269–289. doi :10.2190/vwcw-xkmv-949f-vlf7. ISSN 0047-2816. S2CID 170879476.
^ abc Crabbe, Stephen (2012). "Construcción de una historia contextual de la escritura técnica en inglés" (PDF) . Universidad de Portsmouth . Archivado desde el original (PDF) el 12 de mayo de 2014 . Consultado el 30 de abril de 2014 .
^ "Historia de la escritura técnica". Proeditar . 14 de septiembre de 2012 . Consultado el 9 de mayo de 2014 .
^ "Diccionario y tesauro". Merriam Webster . Consultado el 22 de enero de 2016 .
^ abcdefg Tebeaux, Elizabeth; Dragga, Sam (2010). Los fundamentos de la comunicación técnica . Prensa de la Universidad de Oxford.
^ Perelman, Leslie C., Barrett, Edward y Paradis James. "Presione jaylan peregrino". Manual de redacción científica y técnica de Mayfield grave naba . Consultado el 4 de mayo de 2014.
^ Perelman, Leslie C., Barrett, Edward y Paradis James. "Especificaciones." El manual de redacción científica y técnica de Mayfield . Consultado el 4 de mayo de 2014.
^ ab Anderson, Paul V. (2007). Comunicación técnica [Un enfoque centrado en el lector] 6.ª edición . Thompson Wadsworth.
^ Johnson, Tom "¿Qué herramientas utilizan los redactores técnicos?". Preferiría estar escribiendo . 19 de diciembre de 2011. Consultado el 4 de mayo de 2014.
^ "¿Qué es LyX?". LyX . Consultado el 9 de mayo de 2014.
^ Hewitt, John (18 de enero de 2005). "Cómo los redactores técnicos utilizan Microsoft Visio". Guerra de Poe . Archivado desde el original el 12 de mayo de 2014 . Consultado el 9 de mayo de 2014 .
^ Brierley, Sean (2002). Capturas de pantalla 102 (PDF) . STC Carolina (Reporte). págs. 5–8 . Consultado el 9 de mayo de 2014 .
^ Johnson, Tom (19 de diciembre de 2011). "¿Qué herramientas utilizan los redactores técnicos?". Preferiría estar escribiendo . Consultado el 4 de mayo de 2014 .

enlaces externos

Redacción técnica en Curlie
Programas de educación en escritura técnica - Capítulo de Los Ángeles, Sociedad de Comunicación Técnica (LASTC)
Transacciones IEEE sobre comunicación profesional
Cursos de redacción técnica de Wikiversity