stringtranslate.com

Escritura técnica

La redacción técnica es una forma especializada de comunicación utilizada por muchas de las organizaciones industriales y científicas actuales para transmitir de forma clara y precisa información compleja a un usuario. Los clientes, empleados, trabajadores de montaje, ingenieros y científicos de una organización son algunos de los usuarios más comunes que hacen referencia a esta forma de contenido para completar una tarea o investigar un tema. La mayor parte de la redacción técnica se basa en una gramática simplificada, respaldada por una comunicación visual fácil de entender para explicar de forma clara y precisa información compleja.

Un ejemplo de un diagrama CAD "despiezado". Las explosiones con rótulos son una comunicación visual común que se utiliza en la redacción técnica.
Un ejemplo de un diagrama CAD "despiezado" . Las explosiones con leyendas son comunicaciones visuales comunes creadas por redactores técnicos, a partir de modelos CAD, para ayudar a simplificar el contenido de redacción técnica.

La redacción técnica es una forma de escritura que requiere mucha mano de obra y exige una investigación precisa de un tema y la conversión de la información recopilada a un formato, estilo y nivel de lectura escritos que el usuario final comprenderá o conectará fácilmente. Hay dos formas principales de redacción técnica. Con diferencia, la forma más común de redacción técnica es la documentación de procedimientos escrita para el público en general (por ejemplo, guías paso a paso estandarizadas y procedimientos operativos estándar (POE)). La redacción técnica de procedimientos se utiliza en todo tipo de fabricación para explicar la operación del usuario, el montaje, las instrucciones de instalación y los pasos de seguridad y trabajo del personal. Los procedimientos escritos se utilizan ampliamente en la fabricación, el desarrollo de software, la investigación médica y muchos otros campos científicos. La industria del software se ha convertido en uno de los mayores usuarios de redacción técnica y se basa en documentos de procedimiento para describir el funcionamiento del usuario y las instrucciones de instalación de un programa.

En algunas aplicaciones, los escritos técnicos pueden estar escritos para expertos o colegas científicos dentro de un campo de trabajo o estudio. En estas aplicaciones, se utiliza una forma de redacción técnica de "libro blanco" para describir un tema especializado y comercializar un producto/servicio u opinión/descubrimiento a lectores seleccionados. Las organizaciones normalmente utilizan el formulario de libro blanco para publicar escritos técnicos como artículos de revistas industriales o artículos académicos. El formulario del documento técnico está escrito para atraer a lectores familiarizados con un tema técnico. A diferencia de la redacción técnica de procedimientos, los libros blancos a menudo incluyen términos y datos únicos de la industria. A veces llamada escritura técnica científica , esta forma secundaria de escritura técnica debe mostrar un conocimiento profundo de un tema y el campo de trabajo con el único propósito de persuadir a los lectores a estar de acuerdo con la conclusión de un artículo. [1] La mayoría de los escritos técnicos, publicados en este formato, están escritos por un escritor técnico. Un redactor técnico colaborará estrechamente con el experto de la industria de una organización para redactar estos documentos, pero rara vez se le acredita en la versión publicada.

Sin embargo, en la mayoría de los casos, la redacción técnica se utiliza para ayudar a transmitir temas científicos complejos o especializados a los usuarios finales en términos "profesionales" e incluye contenido puramente fáctico. La redacción técnica procesal moderna se basa en términos simples y oraciones cortas, en lugar de explicaciones detalladas con información innecesaria como pronombres personales, palabras abstractas y acrónimos desconocidos. Para lograr el tono adecuado y la sencillez; Los documentos procesales están escritos desde una perspectiva objetiva en tercera persona y con un tono formal. Una descripción más completa de este estilo se proporciona en el libro de Strunk y White The Elements of Style . La gramática de la redacción técnica es muy similar a la del periodismo impreso y sigue el mismo estilo. [2] Aunque la redacción técnica desempeña un papel integral en el trabajo de la ingeniería, la atención médica y la ciencia; no requiere un título en ninguno de estos campos. En cambio, el autor del documento debe ser un experto en redacción técnica. Se confía en los expertos en la materia (PYME) de una organización, las especificaciones internas y un proceso formal de revisión de ingeniería para garantizar la precisión. La división del trabajo ayuda a centrarse más en los dos lados de la documentación de una organización, lo que garantiza una mayor precisión y calidad. La mayoría de los escritores técnicos tienen un título en artes liberales en una disciplina de escritura, como comunicación técnica, periodismo, inglés, periodismo técnico, comunicación, etc. La redacción técnica es el segmento más grande del campo de la comunicación técnica . [3]

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

Descripción general

La redacción técnica suele ser realizada por un redactor técnico capacitado y el contenido que produce es el resultado de un proceso bien definido. Los redactores técnicos siguen pautas estrictas para que la información técnica que comparten aparezca en un formato y estilo único, estandarizado y de uso popular (por ejemplo, DITA , formato Markdown , libro de estilo AP , Manual de estilo de Chicago ). La tarea principal de un redactor técnico es comunicar información técnica de la manera más clara y efectiva posible. [4] : 4  [5] Para lograr el más alto nivel de claridad, los autores de los escritos técnicos de una organización deben ser indistinguibles para el lector, sin variaciones en el formato, gramática y/o estilo establecidos. El tema que comunica un escritor técnico suele ser complejo, por lo que son esenciales fuertes habilidades de escritura y comunicación. Los redactores técnicos no solo transmiten información a través del texto, sino que también deben dominar el software de gráficos más reciente. Los redactores técnicos utilizan una amplia gama de programas para crear y editar ilustraciones , diagramas y explosiones CAD . El dominio del último software de gráficos es un requisito para la mayoría de los escritos técnicos. [6]

En algunos casos, los ingenieros pueden realizar la redacción técnica del proyecto en el que están trabajando, pero esto rara vez ocurre en organizaciones grandes donde los productos deben lanzarse o revisarse semanalmente. Desde el punto de vista comercial, los materiales de marketing o los comunicados de prensa generalmente los escriben redactores capacitados en un campo de marketing, aunque se puede confiar en un redactor técnico para que proporcione edición y otros aportes sobre cualquier contenido técnico que una organización pueda producir.

Historia

Al igual que la escritura técnica que Ikea proporciona con sus productos, los escritores técnicos del antiguo Egipto a menudo se basaban exclusivamente en la comunicación visual para explicar un procedimiento.

Si bien la escritura técnica solo ha sido reconocida como profesión desde la Segunda Guerra Mundial , sus raíces se remontan al antiguo Egipto, donde la comunicación visual se utilizaba regularmente para explicar los procedimientos. En la época griega y romana antigua, la escritura técnica de las obras de escritores como Aristóteles y Demócrata se citan como algunas de las primeras formas de escritura técnica escrita. Los primeros ejemplos de lo que se consideraría escritura técnica procedimental moderna se remontan a los primeros alquimistas . Estos primeros científicos desarrollaron lo que hoy conocemos como " recetas ". Algunos de los primeros descubrimientos de pasos procesales escritos en la civilización occidental se remontan al año 1100 d.C. Sin embargo, la comunicación visual se utilizó para describir procedimientos en la antigua India y China mucho antes.

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. [7] : 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. [7]

El campo de la comunicación técnica creció durante la Revolución Industrial . [8] : 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. [8] : 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. [8]

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. [7] : 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. [7] : 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. [7] : 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. [7] : 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 . [9]

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. [7] : 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. [7] : 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. [7]

En los últimos años, la prominencia 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 redactores técnicos. [7] : 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. [4] : 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. Algunos ejemplos de documentación técnica de uso común incluyen:

Herramientas

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

Lista de asociaciones

Referencias

  1. ^ Hamlin, Annemarie; Rubio, Chris; Desilva, Michele (2015). "Análisis de audiencia".
  2. ^ Marshall, Carrie (2018). Redacción técnica para empresarios (1ª ed.). Swindon Reino Unido. pag. 1.
  3. ^ "Comunicaciones técnicas - ¿Qué es? - Tech Writer Today".
  4. ^ abcdef Mike Markel (2012). Comunicación Técnica 10ª Edición . Bedford/St. Martín.
  5. ^ "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 .
  6. ^ 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 .
  7. ^ abcdefghij 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 .
  8. ^ 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 .
  9. ^ "Historia de la escritura técnica". Proeditar . 14 de septiembre de 2012 . Consultado el 9 de mayo de 2014 .
  10. ^ "Diccionario y tesauro". Merriam Webster . Consultado el 22 de enero de 2016 .
  11. ^ 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.
  12. ^ Hewitt, John (18 de enero de 2005). "Cómo los escritores 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 .
  13. ^ Brierley, Sean (2002). Capturas de pantalla 102 (PDF) . STC Carolina (Reporte). págs. 5–8 . Consultado el 9 de mayo de 2014 .
  14. ^ 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