stringtranslate.com

Redacción técnica

La redacción técnica es una forma especializada de comunicación que utilizan muchas de las organizaciones científicas e industriales 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 habituales 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 despiezas con leyendas son una forma común de comunicación visual que se utiliza en la redacción técnica.
Un ejemplo de un diagrama CAD "despiezado" . Las despiezas con leyendas son una forma común de comunicación visual creada por redactores técnicos a partir de modelos CAD para simplificar el contenido de la redacción técnica.

La redacción técnica es una forma de redacción que requiere mucho trabajo y que exige una investigación precisa de un tema y la conversión de la información recopilada en un formato escrito, un estilo y un nivel de lectura que el usuario final pueda comprender o con el que pueda identificarse fácilmente. Existen 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 estandarizadas paso a paso y procedimientos operativos estándar (SOP)). La redacción técnica de procedimientos se utiliza en todo tipo de fabricación para explicar el funcionamiento del usuario, el montaje, las instrucciones de instalación y los pasos de trabajo/seguridad 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 la redacción técnica y se basa en documentos de procedimientos para describir las instrucciones de instalación y funcionamiento del usuario de un programa.

En algunas aplicaciones, los textos técnicos pueden redactarse para expertos o colegas científicos dentro de un campo de trabajo o estudio. En estas aplicaciones, se utiliza una forma de "libro blanco" de redacción técnica para describir un tema especializado y comercializar un producto/servicio u opinión/descubrimiento a lectores selectos. Las organizaciones normalmente utilizan la forma de libro blanco para publicar textos técnicos como artículos de revistas de la industria o artículos académicos. La forma de libro blanco se escribe para atraer a los lectores familiarizados con un tema técnico. A diferencia de la redacción técnica de procedimiento, los libros blancos a menudo incluyen términos y datos exclusivos de la industria. A veces llamada redacción técnica científica , esta forma secundaria de redacción 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 para que estén de acuerdo con la conclusión de un artículo. [1] Esta forma de redacción técnica a menudo es escrita por un escritor técnico. Un escritor técnico colaborará estrechamente con el experto de la industria de una organización para redactar estos documentos, pero rara vez se le atribuye en la versión publicada.

En la mayoría de los casos, sin embargo, la escritura técnica se utiliza para ayudar a transmitir temas científicos complejos o de nicho a los usuarios finales en términos "para legos" e incluye contenido puramente factual. La escritura técnica procedimental 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 la gramática correcta, los documentos procedimentales se escriben desde una perspectiva objetiva en tercera persona, con una voz activa y un tono formal. Una descripción más completa del estilo de escritura técnica se proporciona en el libro de Strunk y White The Elements of Style . La gramática de la escritura técnica es muy similar a la del periodismo impreso y sigue el mismo estilo. [2] Aunque la escritura técnica juega un papel integral en el trabajo de ingeniería, atención médica y ciencia, no requiere un título en ninguno de estos campos. En cambio, el autor del documento debe ser un experto en escritura técnica. Se confía en los expertos en la materia (SME) de una organización, las especificaciones internas y un proceso de revisión de ingeniería formal para garantizar la precisión. La división del trabajo ayuda a poner más énfasis 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 redactores técnicos tienen un título en humanidades en una disciplina de redacción, 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]

Algunos ejemplos de campos que requieren redacción técnica incluyen hardware y software de computadoras , arquitectura , ingeniería , química , aeronáutica , robótica , manufactura , finanzas , medicina , leyes 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 , AP Stylebook , Manual de estilo de Chicago ). La tarea principal de un redactor técnico es comunicar la información técnica de la manera más clara y eficaz posible. [4] : 4  [5] Para lograr el mayor nivel de claridad, los autores de la redacción técnica de una organización deben ser indistinguibles para el lector, sin variaciones en el formato, la gramática y/o el estilo establecidos. El tema que comunica un redactor técnico suele ser complejo, por lo que es esencial tener buenas habilidades de redacción 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 software de gráficos más reciente es un requisito para la mayoría de la redacción técnica. [6]

En algunos casos, los ingenieros pueden encargarse de 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. En el ámbito empresarial, los materiales de marketing o los comunicados de prensa suelen estar escritos por escritores formados en el campo del marketing o la redacción creativa. Sin embargo, se puede confiar en un redactor técnico para que edite y haga otros aportes sobre cualquier contenido técnico que pueda producir una organización.

Historia

Al igual que la redacción técnica que Ikea proporciona con sus productos, los escritores técnicos del antiguo Egipto a menudo dependían puramente de la comunicación visual para explicar un procedimiento.

Aunque la redacción 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 con regularidad para explicar procedimientos. En la época de la antigua Grecia y Roma, la redacción técnica de las obras de escritores como Aristóteles y Demócrata se cita como algunas de las primeras formas de redacción técnica escrita. Los primeros ejemplos de lo que se consideraría redacción técnica procedimental moderna se remontan a los primeros alquimistas . Estos primeros científicos desarrollaron lo que ahora conocemos como " recetas ". Algunos de los primeros descubrimientos de pasos procedimentales 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 registraban sus inventos y hallazgos. [7] : 1  Si bien nunca se los llamó 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 escritura técnica. [7]

El campo de la comunicación técnica creció durante la Revolución Industrial . [8] : 3  Hubo una creciente necesidad de proporcionar a las personas instrucciones para usar 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 usar estos nuevos dispositivos. La escritura se convirtió así en la forma más rápida y eficaz de difundir información, y se necesitaban 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 y la Segunda Guerra Mundial condujeron a avances en la medicina, el hardware militar, la tecnología informática y las 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 "redactor técnico" se convirtió en un título laboral oficial durante la Segunda Guerra Mundial. [7] : 1 

Después de la Segunda Guerra Mundial , los avances tecnológicos llevaron a un aumento de los bienes de consumo y los niveles 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 autopistas, experimentaron un crecimiento sustancial. La necesidad de escritores que registraran estos procesos aumentó. [7] : 1  También fue durante este período que las grandes empresas y universidades comenzaron a utilizar computadoras. Cabe destacar que 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 al alcance de los compradores individuales y de las pequeñas empresas. [7] : 3  A medida que el mercado de estas " computadoras personales " creció, también lo hizo la necesidad de escritores que pudieran explicar y proporcionar documentación de usuario para estos dispositivos. [7] : 3  La profesión de redacción técnica experimentó una mayor expansión durante las décadas de 1970 y 1980 a medida que la electrónica de consumo se abría camino en los hogares de cada vez más personas. [7]

En los últimos años, la prominencia de las computadoras en la sociedad ha llevado a muchos avances en el campo de las comunicaciones digitales, lo que ha llevado a cambios en las herramientas que utilizan los escritores técnicos. [7] : 3  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 deben ser competentes en estos programas. [4] : 8–9 

Documentos técnicos

La redacción técnica abarca muchos géneros y estilos de redacción, según la información y la audiencia. Algunos ejemplos de documentación técnica de uso común son:

Herramientas

Los escritores 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". Redacción técnica. Pressbooks .
    Parece que el pasaje respaldado se basa en una síntesis de la fuente más que en una declaración atribuida directamente.
  2. ^ Marshall, Carrie (2018). Redacción técnica para gente de negocios (1.ª ed.). Swindon, Reino Unido. pág. 1.
  3. ^ "Comunicaciones técnicas: ¿qué son? - Tech Writer Today".
  4. ^ abcdef Mike Markel (2012). Comunicación técnica, décima edición . Bedford/St. Martins.
  5. ^ "Technical Writers: Occupational Outlook Handbook: Oficina de Estadísticas Laborales de Estados Unidos". www.bls.gov . Consultado el 14 de febrero de 2024 .
  6. ^ Johnson, Tom (19 de diciembre de 2011). "What Tools Do Technical Writers Use" (¿Qué herramientas utilizan los redactores técnicos?). I'd Rather Be Writing (Prefiero 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) . Montana State University Billings . Consultado el 22 de abril de 2014 .
  8. ^ abc Crabbe, Stephen (2012). "Construcción de una historia contextual de la redacción 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 redacción técnica". Proedit . 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?". Prefiero 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 redactores técnicos utilizan Microsoft Visio». Poe War . 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 (Informe). págs. 5–8 . Consultado el 9 de mayo de 2014 .
  14. ^ Johnson, Tom (19 de diciembre de 2011). "What Tools Do Technical Writers Use" (¿Qué herramientas utilizan los redactores técnicos?). I'd Rather Be Writing (Prefiero estar escribiendo) . Consultado el 4 de mayo de 2014 .

Enlaces externos