Escritura técnica - Enciclopedia

La escritura técnica es una forma de comunicación especializada utilizada por muchas organizaciones industriales y científicas de hoy en día para transmitir claramente y de manera precisa información compleja a los usuarios. Los clientes de la organización, empleados, trabajadores de ensamblaje, ingenieros y científicos son algunos de los usuarios más comunes que recurren a esta forma de contenido para completar una tarea o investigar un tema. La mayoría de la escritura técnica se basa en una gramática simplificada, apoyada por una comunicación visual fácil de entender para explicar información compleja de manera clara y precisa. La escritura técnica es una forma de escritura intensiva en términos laborales que requiere una investigación precisa del tema y la conversión de la información reunida en un formato, estilo y nivel de lectura que el usuario final pueda entender fácilmente o con el que se pueda conectar. Hay dos formas principales de escritura técnica. Sin duda, la forma más común de escritura técnica es la documentación procedimental escrita para que tanto los expertos entrenados como el público en general puedan comprenderla (por ejemplo, guías estándar paso a paso y procedimientos operativos estándar (SOP)). La escritura técnica procedimental se utiliza en todos los tipos de fabricación para explicar de manera simple y clara la operación del usuario, las instrucciones de ensamblaje, la instalación y los pasos de seguridad de los empleados. Las instrucciones escritas 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 escritura técnica y depende de los documentos procedimentales para describir la operación del usuario y las instrucciones de instalación de un programa.

En algunas aplicaciones, la escritura técnica puede ser escrita para expertos técnicos o científicos dentro de un campo de trabajo o estudio. En estas aplicaciones, se utiliza una forma de escritura técnica denominada "white paper" para describir un tema especializado y comercializar un producto/servicio o una opinión/descubrimiento a lectores seleccionados. Las organizaciones suelen usar la forma de white paper para publicar escritura técnica como artículos de revistas de la industria o artículos académicos. Esta forma de escritura está escrita para atraer a lectores familiarizados con un tema técnico. A diferencia de la escritura técnica procedimental, los white papers a menudo incluyen términos y datos únicos de la industria. A veces llamada escritura técnica científica, esta segunda forma de escritura técnica debe mostrar un conocimiento profundo del tema y del campo de trabajo con el único propósito de convencer a los lectores de estar de acuerdo con la conclusión del documento. Esta forma de escritura técnica a menudo es escrita por un escritor técnico. Un escritor técnico colabora estrechamente con el experto en el campo de la organización para escribir estos documentos, pero rara vez se acredita en la versión publicada.

Sin embargo, en la mayoría de los casos, la escritura técnica se utiliza para ayudar a transmitir temas científicos o nicho complejos a usuarios finales con una amplia gama de comprensión. Para garantizar que el contenido sea comprendido por todos, se sigue el Lenguaje Claro (PL), y solo se proporciona contenido 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 adecuada, los documentos procedimentales se escriben desde una perspectiva en tercera persona, objetiva, con un tono activo y formal. Se proporciona una descripción más completa de la gramática de la escritura técnica en el libro "The Elements of Style" de Strunk y White. La gramática de la escritura técnica es muy similar a la del periodismo impreso y sigue un estilo de gramática muy similar.

A pesar de que la escritura técnica desempeña 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 su lugar, el autor del documento debe ser un experto en escritura técnica. Las Organizaciones confían en los expertos en el tema (ESE), especificaciones internas y un proceso de revisión de ingeniería formal para asegurar la precisión. La división del trabajo ayuda a centrar la atención en ambas partes de la documentación de la organización, asegurando mayor precisión y calidad. La mayoría de los escritores técnicos poseen un título en humanidades en una disciplina de escritura, como comunicación técnica, periodismo, inglés, periodismo técnico, comunicación, etc. La escritura técnica es el segmento más grande del campo de la comunicación técnica.

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


Resumen

La escritura técnica se realiza más comúnmente por un escritor técnico entrenado y el contenido que producen es el resultado de un proceso bien definido. Los escritores técnicos siguen estrictas directrices para que la escritura técnica que comparten aparezca en un formato y estilo estandarizado y ampliamente utilizado (por ejemplo, DITA, formato markdown, AP Stylebook, Chicago Manual of Style). La principal tarea de un escritor técnico es comunicar información técnica de la manera más clara y efectiva posible. Para lograr el máximo nivel de claridad, la escritura técnica de una organización debe ser indistinguible para el lector, sin variaciones en el formato, gramática y / o estilo entre los autores. El tema de un escritor técnico a menudo es complejo, por lo que son esenciales las habilidades de escritura y comunicación. La escritura técnica no se limita en absoluto a la comunicación escrita. A menudo se incorpora la comunicación visual a la documentación para ayudar a simplificar temas complejos. Los escritores técnicos utilizan various programas modernos de edición de imágenes y gráficos para producir comunicación visual. Los programas para editar ilustraciones, diagramas y explosiones CAD son herramientas comunes del oficio.

En algunos casos, los ingenieros pueden realizar la escritura técnica para el proyecto en el que están trabajando, pero esto rara vez ocurre en grandes organizaciones donde los productos deben lanzarse o revisarse semanalmente. En el lado empresarial, los materiales de marketing o los comunicados de prensa suelen ser escritos por escritores entrenados en el campo del marketing y / o la escritura creativa. Sin embargo, un escritor técnico puede ser requerido para proporcionar edición y otra entrada sobre cualquier contenido técnico que una organización pueda producir.


Historia

Aunque la escritura técnica solo se ha reconocido como una profesión desde la Segunda Guerra Mundial, sus raíces pueden rastrearse hasta el antiguo Egipto, donde la comunicación visual se utilizaba regularmente para explicar procedimientos. En la antigua Grecia y Roma, la escritura técnica por obras de escritores como Aristóteles y Demócrates se cita como algunas de las primeras formas de escritura técnica escrita. Los primeros ejemplos de lo que se consideraría modernamente escritura técnica procedimental datan del principio de la alquimia. Estos científicos desarrollaron lo que ahora conocemos como "recetas". Algunas de las primeras descubrimientos de pasos procedimentales escritos en la Civilización Occidental datan del año 1100 d.C. Sin embargo, la comunicación visual se utilizaba para describir procedimientos en la India y China mucho antes.

Con la invención de la imprenta mecánica, el comienzo del Renacimiento y el ascenso de la Era de la Razón, documentar hallazgos se convirtió en una necesidad. Inventores y científicos como Isaac Newton y Leonardo da Vinci prepararon documentos que cronicaban sus inventos y hallazgos. Aunque nunca se les llamó documentos técnicos durante su período de publicación, estos documentos jugaron un papel crucial en el desarrollo de las formas modernas de comunicación y escritura técnica.

El campo de la comunicación técnica creció durante la Revolución Industrial. Había una creciente necesidad de proporcionar instrucciones para usar las máquinas cada vez más complejas que se inventaban. Sin embargo, a diferencia del pasado, donde las habilidades se transmitían a través de tradiciones orales, nadie más que los inventores sabía cómo usar estos nuevos dispositivos. Por lo tanto, la escritura se convirtió en la manera más rápida y efectiva de difundir información, y se deseaban escritores que pudieran documentar estos dispositivos.

Durante el siglo XX, la necesidad de escritura técnica aumentó exponencialmente, y la profesión se reconoció oficialmente. Los eventos de la Primera y Segunda Guerra Mundial llevaron a avances en la medicina, el hardware militar, la tecnología de computadoras y las tecnologías aeroespaciales. Este crecimiento rápido, combinado con la urgencia de la guerra, creó una necesidad inmediata de documentación bien diseñada para apoyar el uso de estas tecnologías. La escritura técnica estaba en gran demanda en este momento, y "escritor técnico" se convirtió en un título oficial durante la Segunda Guerra Mundial.

Después de la Segunda Guerra Mundial, los avances tecnológicos llevaron a un aumento en los bienes de consumo y los estándares de vida. Durante el auge posguerra, servicios públicos como bibliotecas y universidades, así como sistemas de transporte como autobuses y autopistas, vieron un crecimiento sustancial. Aumentó la necesidad de escritores para croniquen estos procesos. Fue también durante este período que las grandes empresas y las universidades comenzaron a usar computadoras. Notablemente, en 1949, Joseph D. Chapline escribió el primer documento técnico computacional, un manual de instrucciones para la computadora BINAC.

La invención del transistor en 1947 permitió que los computadores se produjeran más barato y dentro del rango de compra de individuos y pequeñas empresas. A medida que el mercado de estos "ordenadores personales" crecía, también lo hacía la necesidad de escritores que pudieran explicar y proporcionar documentación de usuario para estos dispositivos. La profesión de escritor técnico vio una expansión adicional durante las décadas de 1970 y 1980 a medida que los electrodomésticos de consumo se introdujeron en las casas de más y más personas.

En los últimos años, la prominencia de los computadores en la sociedad ha llevado a muchos avances en el campo de las comunicaciones digitales, lo que ha cambiado las herramientas que utilizan los escritores técnicos. El hipertexto, los procesadores de palabras, los programas de edición gráfica y los programas 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 escritores técnicos de hoy en día deben ser competentes en estos programas.


Documentos técnicos

La escritura técnica abarca muchos géneros y estilos de escritura, dependiendo de la información y el público. Algunos ejemplos de documentación técnica comúnmente utilizada incluyen:

Documentación de API: Utilizada principalmente en el campo del desarrollo web para documentar instrucciones de operación individuales y revisiones de aplicaciones web utilizando una interfaz de programación de aplicaciones (API). Herramientas comunes de API como Swagger y Postman permiten a los escritores técnicos producir fácilmente documentación en markdown para subir a directorios de API específicos que contienen código relacionado (por ejemplo, localización, inicio de sesión, seguridad). La documentación de API se convierte generalmente automáticamente en un formato estándar "markdown" desde dentro del editor WYSIWYG de una herramienta de API. En la mayoría de los casos, los escritores técnicos suben actualizaciones de software de directorio cuando se aplican nuevas actualizaciones de código. Los directorios de sitios web se almacenan y actualizan en "Git", lo que permite a los programadores mover fácilmente los directorios actualizados a un servidor de prueba y luego a un servidor en vivo.

Instrucciones de ensamblaje (AI): Proporciona procedimientos internos para el personal de línea de ensamblaje. Se escriben pasos individuales y se asignan a miembros de un equipo de ensamblaje. A menudo, el escritor técnico incluye explosiones CAD para simplificar ensamblajes complejos.

Estudio de caso: Un informe publicado sobre una persona, grupo o situación que ha sido estudiado a lo largo del tiempo; también una situación en la vida real que se puede analizar o estudiar para aprender sobre algo. En grandes organizaciones, los escritores técnicos solo proporcionan servicios de corrección de estilo o escritura fantasma para estudios de caso. Generalmente se requiere autoría a nivel de gestión para cumplir con estándares y códigos nacionales.

Manuales de mantenimiento de componentes (CMM): Principalmente utilizados en la aeronáutica para notificar a los clientes cuando se debe reparar o reemplazar una parte significativa de un componente. Se deben incorporar y / o referenciar todos los boletines de servicio relacionados con el componente en un CMM, junto con los últimos dibujos y información del componente. Los CMM siguen el formato de la Asociación de Transporte Aeronáutico (ATA) y el capítulo ATA Spec 100/iSpec 2200.

Manuales de instalación (IM): Procedimientos diseñados para ayudar al usuario final a instalar un producto o programa de software en el campo.

Informe de inspección: Principalmente utilizado en la construcción de edificios y la ingeniería civil, este informe detalla los problemas / defectos identificados por un inspector de campo en diversas etapas del proyecto. Los problemas / defectos identificados se capturan inicialmente en una lista de problemas. Un escritor técnico se refiere a la lista de problemas para escribir un informe de inspección. Los informes de inspección proporcionan imágenes detalladas, ubicaciones y descripciones de problemas / defectos para que los constructores entiendan mejor cómo corregir problemas o realizar reparaciones correctamente. En algunos casos, también se pueden incluir sugerencias de remedio.

Base de conocimientos o centro de ayuda: Sitios web de ayuda en línea diseñados para proporcionar a los usuarios páginas con información técnica sobre productos y / o servicios. El contenido para estos sitios se puede crear y subir a la web en SGML, XML o XHTML. Los sistemas de gestión de contenido se utilizan para gestionar y subir estos sitios web.

Lista de embalaje o lista de envío: Identifica las piezas enviadas, la información de seguridad del producto y los datos de contacto del fabricante.

Boletines de servicio (SB): Principalmente utilizados en la aeronáutica para notificar a los clientes cuando se puede necesitar una reparación y / o modificación para una parte menor de un componente. Los fabricantes escriben y emiten boletines de servicio a los propietarios de aviones. Los boletines de servicio siguen el formato de la Asociación de Transporte Aeronáutico (ATA) y el capítulo ATA Spec 100/iSpec 2200.

Especificaciones o Specs: Utilizados en la industria de la construcción para describir los estándares mínimos de instalación y requisitos. Las especificaciones se proporcionan generalmente al constructor por un gerente de proyecto y deben ser firmadas y aceptadas por el constructor como parte del contrato. Los estándares de formato se establecen por el Instituto de Especificaciones de Construcción (CSI).

Ficha técnica / Fichas técnicas o Hojas de datos: Hojas de referencia de una o dos páginas diseñadas para proporcionar características comunes de producto / servicio necesarias para aplicaciones específicas. Las características máximas y mínimas comunes de producto / servicio pueden incluir: tamaño y huella, peso, tipo de conexión o interfaces, requisitos eléctricos, velocidad, etc.

Procedimientos operativos estándar (SOP): Pasos procedimentales a los que se refieren las personas militares, de fabricación, médicas e industriales de seguridad para completar ensamblajes, procesos o cualquier otra tarea de trabajo que debe realizarse físicamente en el orden correcto.

Informe de inspección: Un documento exhaustivo de una inspección de suelo producido a partir de fotografías y datos técnicos recopilados y detallados por topógrafos.

Contenido de marketing técnico: Información escrita exclusivamente para fines de marketing. Este contenido a menudo se utiliza para describir información y especificaciones de producto en materiales de marketing y en páginas web de productos / servicios. Tradicionalmente, se contratan escritores creativos especializados en marketing para este trabajo.

Manuales de usuario (UM) o Manuales de operación: Instrucciones procedimentales para la operación de un producto o programa.

White papers: Documentos de marketing, a menudo escritos por escritores técnicos y atribuidos a expertos en un campo. Todos los white papers tienen un tema persuasivo y presentan un argumento que respalda la conclusión del experto.


Herramientas

Las siguientes herramientas se utilizan por los escritores técnicos para crear y presentar documentos:

Renderizado CAD: Los escritores técnicos que trabajan en ingeniería mecánica a menudo utilizan herramientas de renderizado CAD para "descomponer" diseños 3D CAD creados y aprobados por ingenieros. El objetivo es comunicar visualmente pasos de ensamblaje / desensamblaje procedimentales de manera más clara. Normalmente se utiliza software de comunicación técnica técnica especializado para modificar modelos CAD existentes.

Programas de software colaborativos. La escritura técnica requiere colaboración entre múltiples partes de diferentes departamentos dentro de una organización. Para aumentar la comunicación entre las partes, los escritores técnicos confían en sistemas de wiki como Confluence y espacios de trabajo de documentos compartidos.

Sistemas de gestión de contenido (CMS): La escritura técnica moderna se edita y publica en un CMS o CCMS especializado para la escritura técnica. El CMS se utiliza para publicar fácilmente y rápidamente grandes volúmenes de contenido de escritura técnica en línea. El contenido subido se convierte automáticamente en un sistema de ayuda de base de conocimientos para que los usuarios finales puedan referirse a él. Además de las características básicas de edición WYSIWYG y subida web, un CMS también proporciona características de gestión de contenido con gestión de versiones y herramientas integradas para gestionar grandes flujos de trabajo de documentación. La mayoría de los CMS utilizados para la escritura técnica se basan en SGML, XML o XHTML.

Herramientas de publicación en escritorio o procesadores de palabras: En la década de 1990, la mayoría de la escritura técnica se realizaba