Haga clic aquí para ayudar a David McMurrey a pagar el alojamiento web:
¡Done cualquier pequeña cantidad que pueda!
Online Technical Writing seguirá siendo gratuito.
El mayor obstáculo que puede enfrentar al redactar una descripción es recordar qué significa el término tal como se utiliza en este contexto. Todos usamos la palabra description de manera flexible para referirnos a prácticamente cualquier discusión o explicación. Sin embargo, en este contexto significa la discusión detallada de los aspectos físicos de un objeto. Esto implica analizar aspectos como el color, la forma, el tamaño, el peso, la altura, el ancho, el grosor, la textura, la densidad, el contenido, los materiales de construcción, entre otros.
Por ejemplo, la siguiente oración no constituye realmente una descripción en el sentido que aquí empleamos el término:
Un disquete de computadora es un dispositivo que se utiliza para almacenar datos electrónicos.
Esta oración explica la función o el propósito, pero proporciona pocos o ningún detalle físico. Sin embargo, la siguiente oración sí constituye claramente una descripción:
El disquete de computadora común de la década de 1980 medía 3.5 pulgadas por 3.5 pulgadas y tenía un grosor aproximado de 1/8 de pulgada.
Asegúrese de consultar las descripciones de ejemplo disponibles en este capítulo.
Infografía de este capítulo generada por NotebookLM
Contextos para la descripción
Como se mencionó anteriormente, las descripciones son un elemento común en la redacción técnica, aunque no exactamente del mismo modo que las instrucciones. Las descripciones aparecen con mayor frecuencia como una o dos oraciones aquí, un párrafo allá, o una sección completa en otro lugar. Ciertos tipos de redacción técnica destacan el uso de la descripción:
- Informes de accidentes que requieren abundante descripción.
- Especificaciones de productos—documentos que describen el diseño y las características de un producto nuevo o modificado—incluyen una gran cantidad de descripción.
- Las instrucciones a menudo requieren descripción para permitir que los lectores visualicen lo que están haciendo y con qué están trabajando.
Contenido y organización de las descripciones
A continuación se presenta una revisión de las secciones que comúnmente encontrará en las descripciones. A medida que lea, consulte las descripciones de ejemplo.
Introducción. Planifique cuidadosamente la introducción de su descripción. Asegúrese de que cumpla con todos los siguientes puntos (aunque no necesariamente en este orden) que se apliquen a su descripción particular:
- Indicar el objeto específico que está a punto de describirse.
- Indicar qué conocimientos y antecedentes necesita la audiencia para comprender la descripción.
- Proporcionar una descripción general del objeto.
- Incluir una visión general del contenido de la descripción.
Antecedentes. Si el objeto que está describiendo probablemente no sea familiar para la mayoría de sus lectores, considere agregar algunos antecedentes antes de adentrarse en la descripción propiamente dicha. Por ejemplo, si va a describir un medidor de densidad SGO/3 a un público no especializado, conviene primero explicar qué es ese dispositivo, qué hace y en qué parte del mundo se utiliza.
Análisis de las partes o características. La parte principal de su descripción es el análisis de cada parte o característica. Debe dividir el objeto que describe en partes, en características, o en ambas. Las partes son fáciles de identificar: por ejemplo, un lápiz de madera tiene mina, un cuerpo de madera, una goma de borrar y un clip metálico. Las características son aspectos descriptibles de un objeto, pero no son partes: por ejemplo, el lápiz tiene un peso, una longitud y un ancho determinados, entre otros. Si usted fuera un aspirante a magnate inmobiliario y tuviera que describir un terreno baldío para los archivos de la empresa, probablemente lo describiría por sus características: su ubicación, superficie, terreno, vegetación, acceso a servicios públicos, etc. (Consulte la descripción del raspador de piedra primitivo en los ejemplos; parte de ella está organizada por características y parte por componentes).
Una vez que haya dividido el objeto que describe en partes, características o ambas, su siguiente tarea es describir cada una. En el caso de objetos mecánicos, resulta eficaz comenzar definiendo la parte, es decir, explicando su función. Después de eso, describa la parte de lo general a lo específico, utilizando cualquiera de las fuentes de descripción que sean apropiadas.
Observe que, en una descripción, puede combinar otros tipos de escritura. Se encontrará explicando funciones, definiendo términos y comentando brevemente procesos mientras describe. Esto no representa un problema siempre que el enfoque principal y la mayor parte del contenido sean verdaderamente descriptivos.
Análisis de la operación o proceso relacionado. En algún punto de una descripción—con frecuencia al final—resulta útil resumir la operación o el proceso asociado con el objeto que se describe. Por ejemplo, si acaba de describir un lápiz mecánico, podría explicar brevemente cómo se utiliza. Si acaba de describir un copo de nieve, podría analizar el proceso mediante el cual se formó.
Fuentes de la descripción
Al redactar una descripción, debe pensar en los tipos de detalles descriptivos que puede proporcionar. En ocasiones, las descripciones son bastante débiles en este aspecto. Utilice la siguiente lista para planificar su descripción o para revisar una descripción que ya haya escrito. Considere las categorías de detalles descriptivos que podría aportar, o use la lista siguiente para identificar las categorías que aún no ha utilizado:
|
color altura ancho forma peso materiales textura ubicación métodos de fijación olor |
profundidad cantidad patrón, diseño ingredientes edad subcomponentes longitud acabado temperatura contenido de humedad |
Vista esquemática de las descripciones. Recuerde que este es solo un modelo típico o común para el contenido y la organización; existen muchas otras posibilidades.
Cuestiones diversas
En las descripciones, probablemente se encontrará reflexionando sobre cómo manejar los números, las abreviaturas y los símbolos:
Números. Recuerde que la redacción técnica rompe algunas de las reglas que aprendió con tanto esfuerzo en cursos anteriores de escritura. En el contexto de la redacción técnica, a menudo damos una importancia crucial a los números y queremos que destaquen. Esto significa que debe utilizar cifras en el texto continuo cuando el número indique una cantidad exacta, medida o medible, o cuando represente un valor crítico. Por ejemplo, en las siguientes oraciones parece importante que los números sean exactos:
La taza tiene un diámetro de 3 pulgadas.
Use 4 chinches para fijar el cartel a la pared.
Sin embargo, esto no significa que se deban usar cifras para valores irrelevantes. Por ejemplo, en la siguiente oración no hay nada especialmente importante en cuántas secciones contiene el informe:
El informe contiene cuatro secciones principales.
Consulte la sección sobre numbers vs. words para obtener más detalles.
Anatomía de un párrafo descriptivo. Por lo general, comienza con una afirmación sobre el propósito o la función de la parte, seguida de los detalles descriptivos. Los detalles descriptivos se basan en las “fuentes” de la descripción, como el color, la forma, el ancho y la altura.
Abreviaturas. En la redacción técnica, se espera el uso de abreviaturas. Úselas libremente en su descripción. Recuerde la regla sobre la puntuación de las abreviaturas: solo se puntúan si forman una palabra (por ejemplo, “in.”). Recuerde también que las abreviaturas no deben colocarse junto al número con el que se utilizan (por ejemplo, escriba “8 mm tape” o “8-mm tape”, pero no “8mm tape”).
Símbolos. El problema más común con los símbolos en instrucciones y descripciones tiene que ver con las pulgadas y los pies. Si está escribiendo instrucciones para un proyecto de carpintería lleno de medidas en pies y pulgadas, utilice los símbolos " (pulgadas) y ' (pies). Sin embargo, si menciona estas medidas solo unas pocas veces, utilice la palabra o la abreviatura en su lugar.
Gráficos y formato en las descripciones
En la mayoría de las descripciones, necesitará al menos una ilustración del objeto que describe, con etiquetas que señalen las partes. Consulte la sección sobre graphics para obtener más información sobre la creación de gráficos, su formato y su integración en las descripciones.
Encabezados. En las descripciones, conviene utilizar encabezados y subencabezados para delimitar el análisis de las partes o características individuales. Recuerde que, idealmente, cada parte debe describirse en un párrafo o sección independiente, y dicha discusión debe identificarse con un encabezado. Si cuenta con una sección de antecedentes, utilice también un encabezado para ella. Consulte la sección sobre headings para conocer los requisitos específicos.
Listas. Las listas no son tan importantes en las descripciones como en las instrucciones. Sin embargo, si enumera partes, subpartes o especificaciones, estas son situaciones adecuadas para utilizar listas. Consulte la sección sobre lists para conocer los requisitos específicos.
Avisos especiales. En las descripciones, los avisos especiales no desempeñan el papel crucial que tienen en las instrucciones. Al fin y al cabo, si realmente se trata de una descripción, no se espera que los lectores sigan ningún procedimiento y, por lo tanto, no deberían correr riesgos de dañar equipos, desperdiciar suministros, arruinar el procedimiento o lesionarse a sí mismos o a otros. No obstante, puede resultarle útil el aviso especial note para enfatizar puntos importantes o excepciones. Consulte la sección sobre special notices para una explicación completa del uso adecuado de estos avisos, así como de su formato y ubicación dentro de las instrucciones.
Agradecería sus opiniones, reacciones y críticas con respecto a este capítulo: respuesta—David McMurrey
