Technical Writing Essentials

La escritura técnica descriptiva utiliza una combinación de elementos visuales y texto para «mostrar» y «contar» al lector la información que se transmite. Al igual que las descripciones más creativas, las descripciones técnicas a veces recurren a los «cinco sentidos» y a comparaciones metafóricas (analogías) para que el lector pueda conceptualizar plenamente lo que se describe. Sin embargo, lo más frecuente es que se basen en descriptores concretos y medibles. Las descripciones técnicas pueden adoptar muchas formas, según el objetivo y la audiencia. Las descripciones pueden abarcar desde una breve frase hasta un párrafo, una sección completa de un informe o un manual entero. Las descripciones técnicas mal redactadas pueden causar confusión, perder tiempo e incluso provocar una catástrofe. Las descripciones técnicas de los productos son a menudo un requisito legal para garantizar la seguridad y el cumplimiento de la normativa. La atención a los detalles es fundamental.

Las especificaciones de los productos requieren descripciones detalladas de las características del diseño; las instrucciones suelen requerir detalles descriptivos específicos para «mostrar» al lector lo que debe hacer. Algunas categorías generales de descripciones técnicas son las siguientes:

• Descripciones de mecanismos: proporcionan una visión detallada de los aspectos físicos de una herramienta, máquina u otro dispositivo mecánico que tiene partes móviles y está diseñado para realizar una función específica. Pueden ser descripciones de productos para la venta o la fabricación, documentación de especificaciones de diseño, infográficos, etc. Este capítulo se centra en detalle en este tipo de descripciones.
• Descripciones de procesos: detallan una serie de eventos (fenómenos naturales/biológicos/ecológicos, mecánicos, sociales o psicológicos) que suceden en una secuencia particular para lograr un resultado específico. Pueden clasificarse en procesos no instructivos (como un análisis de procesos sobre el funcionamiento de un motor de combustión interna, o procesos naturales como la fotosíntesis) y procesos instructivos (como procedimientos recomendados/requeridos e instrucciones explícitas paso a paso que deben seguirse). (Véase la sección 7.7 para obtener información detallada sobre la redacción de instrucciones).
• Definiciones: aclaran el significado específico, a menudo relacionado con un contexto concreto, o expresan la naturaleza esencial de los términos que se definen. Su extensión puede variar desde una simple frase aclaratoria hasta un documento extenso de varias páginas. Las definiciones suelen incluir descripciones detalladas y elementos visuales para ilustrar las ideas. Haga clic en el siguiente enlace para ver una presentación en PowerPoint de un estudiante sobre cómo redactar definiciones eficaces con fines técnicos. Esta presentación se incluye con el permiso expreso del estudiante.

Definiciones en la escritura técnica – Muestra de la presentación del estudiante (.pdf)

Las descripciones de los mecanismos deben proporcionar una clara comprensión del objeto que se describe, incluyendo

• Aspecto general y propiedades físicas
• Función general/propósito
• Partes componentes
• Cómo las partes interactúan para crear un todo funcional.

El lector debe ser capaz de imaginarse claramente, y por lo tanto entender, la naturaleza del objeto que se describe, lo que hace y cómo funciona.

Para lograr esta claridad para el lector, el escritor debe elegir detalles significativos y organizar la información de forma lógica. Seleccione detalles que puedan describirse de forma precisa y mensurable, como

En función de las necesidades del lector, la descripción puede ir desde una visión general que sólo requiera unas pocas frases hasta un manual de varios capítulos en el que se detallen todos los aspectos de las piezas y funciones del mecanismo para solucionar problemas técnicos y realizar reparaciones. Un ejemplo divertido de esto último es el manual técnico de Star Trek: The Next Generation: Technical Manual (cuya portada se muestra en la Figura 7.4.1), que ofrece descripciones detalladas de todo el equipo y la tecnología utilizados a bordo de la ficticia U.S.S. Enterprise-D.

Antes de empezar a redactar su descripción, debe considerar su propósito y su audiencia: ¿Por qué necesita su público esta descripción? ¿Para qué la van a utilizar? ¿Está describiendo diferentes tipos de paneles solares para ayudar a los consumidores medios a elegir el que mejor se adapte a sus necesidades? Una vez que tenga claro el objetivo y la audiencia, redacte una descripción que incluya los siguientes elementos:

1. Definición: ¿Qué es y cuál es su objetivo principal?
2. Descripción general: Describa el aspecto general del mecanismo («panorama general»).
3. Componentes: Describa las principales partes componentes en secciones etiquetadas; considere el orden de la información cuidadosamente aquí. Cree una conexión lógica entre cada componente descrito.
4. Explicación: ¿cómo trabajan las partes juntas para cumplir su función? Qué principios clave rigen su funcionamiento? Considere cuántos detalles son necesarios aquí para el público al que va dirigido.
5. Visuales: incluya gráficos que ilustren claramente el mecanismo y/o sus partes. Muestre el dispositivo en su conjunto; considere la posibilidad de mostrar detalles específicos en vistas ampliadas, cortes o diagramas etiquetados. Incluso puede incrustar o enlazar a vídeos que muestren el dispositivo en acción.
6. Conclusión: dependiendo del propósito, podría revisar la historia del producto, la disponibilidad, la fabricación, los costes, las advertencias, etc.)
7. Referencias: Fuentes que ha utilizado en su descripción, o fuentes adicionales de información disponibles (si son relevantes).

Podría considerar el uso de una plantilla, como la Plantilla de Descripción Técnica que aparece a continuación, teniendo en cuenta que aunque las plantillas pueden ser guías útiles, no proporcionan mucha flexibilidad y pueden no funcionar para todas las situaciones.

Descripciones de ejemplo

Examine la descripción del «Up Goer Five» de la figura 7.4.2 (haga clic en la imagen para ampliarla). ¿A quién va dirigido?

Compare la descripción de la Figura 7.4.2 con la información dada en el sitio web de la NASA sobre el Mars Curiosity Rover.

Nota las diferencias en el nivel de detalle, el vocabulario y el propósito general de las descripciones. Si utilizas la información del sitio de la NASA para rellenar la plantilla de descripción técnica, podrías acabar con algo como el siguiente cuadro. Objetivos

Puede que algunos de estos elementos no sean necesarios; de nuevo, considere lo que su público objetivo ya sabe. Busque un equilibrio entre afirmar innecesariamente lo obvio y asumir incorrectamente que sus lectores tienen conocimientos de los que carecen.

Al perfeccionar los detalles de su descripción y las partes que la componen, tenga en cuenta lo siguiente:

• Organización: Utilice un principio lógico para organizar su descripción
  • De arriba a abajo (o de la base hacia arriba)
  • De la izquierda a la derecha (o de la derecha a la izquierda)
  • De dentro a fuera (o de fuera a dentro)
  • Características más importantes a las menos importantes
  • Componente central a los periféricos
  • Propiedades del material, etc.
• Lenguaje: Utilice términos específicos, precisos y concretos – evite términos vagos o demasiado generales
  • Utilice una terminología correcta – defina los términos según sea necesario para su audiencia
  • Utilice la analogía para describir una cosa desconocida en términos de una cosa conocida
  • Utilice un lenguaje objetivo – sin «ad speak» ni términos subjetivos
  • Utilice el tiempo presente, verbos activos para describir cómo aparece el dispositivo y lo que hace
  • Use palabras que creen imágenes vívidas y específicas en la mente del lector.

Elija un objeto común y corriente (como uno de los objetos de la figura 7.4.3) y redacte una descripción técnica para un público que no esté familiarizado con el objeto. Empiece por imaginar un público objetivo y un propósito, y luego intente rellenar la plantilla de descripción técnica con información detallada. Utilizando la información de su plantilla, redacte una breve descripción de 1 a 2 párrafos y añada elementos visuales debidamente subtitulados.