7.4: Descripciones técnicas y definiciones

Última actualización
Guardar como PDF

Page ID: 102652

\( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \) \( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)\(\newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\) \( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\) \( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\) \( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\) \( \newcommand{\Span}{\mathrm{span}}\) \(\newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\) \( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\) \( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\) \( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\) \( \newcommand{\Span}{\mathrm{span}}\)\(\newcommand{\AA}{\unicode[.8,0]{x212B}}\)

La escritura técnica descriptiva utiliza una combinación de visuales y texto para “mostrar” y “informar” al lector sobre la información que se transmite. Al igual que las descripciones más creativas, las descripciones técnicas a veces se basan en los “cinco sentidos” y las comparaciones metafóricas (analogías) para permitir al lector conceptualizar completamente lo que se está describiendo. Más a menudo, sin embargo, se basan en descriptores concretos y medibles. Las descripciones técnicas pueden tomar muchas formas, dependiendo del propósito y la audiencia. Las descripciones pueden ir desde una oración breve, hasta un párrafo, una sección completa de un informe o un manual completo. Las descripciones técnicas mal escritas pueden causar confusión, perder el tiempo e incluso resultar en catástrofes. Las descripciones técnicas de los productos a menudo se requieren legalmente para garantizar la seguridad y el cumplimiento. La atención al detalle es fundamental.

Las especificaciones del producto requieren descripciones detalladas de las características del diseño; las instrucciones a menudo requieren detalles descriptivos específicos para “mostrar” al lector qué hacer. Algunas categorías generales de descripciones técnicas incluyen las siguientes:

Descripciones del mecanismo: proporcionar una descripció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. Estas podrían ser descripciones de productos para ventas o fabricación, documentación de especificaciones de diseño, infografías, etc. Este capítulo se centra en detalle en este tipo de descripción.
Descripciones de procesos: detallar una serie de eventos (fenómeno natural/biológico/ecológico, mecánico, social o psicológico) que ocurren en secuencia particular para lograr un resultado específico. Estos pueden clasificarse en procesos no instructivos (como un análisis de proceso de cómo funciona un motor de combustión interna, o procesos naturales como la fotosíntesis) y proceso de instrucción (como procedimientos recomendados/requeridos y pasos explícitos instrucciones paso a seguir). (Consulte la Sección 7.7 para obtener información detallada sobre las instrucciones de escritura).
Definiciones: aclarar el significado específico, a menudo relacionado con un contexto específico, o expresar la naturaleza esencial de los términos que se definen. Estos pueden variar en longitud desde una simple frase aclaratoria hasta un documento extendido de varias páginas. Las definiciones a menudo incluirán descripciones detalladas e imágenes para ilustrar ideas. Haga clic en el siguiente enlace para ver una presentación de PowerPoint del estudiante sobre cómo escribir definiciones efectivas con fines técnicos. Esta presentación se incluye con permiso expreso del alumno.

Definiciones en Redacción Técnica — Muestra de presentación del alumno (.pdf)

Descripción Técnica de un Mecanismo

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

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

El lector debe ser capaz de imaginar con claridad, y por lo tanto comprender, la naturaleza del objeto que se describe, qué hace y cómo funciona.

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

color	materiales	textura, olor, sabor
forma	partes componentes	acabado
tamaño	propiedades	patrones, diseños
dimensiones	principios en el trabajo	interacciones

Dependiendo de la necesidad del lector, la descripción puede variar desde una visión general que requiere solo unas pocas oraciones hasta un manual de varios capítulos que detalla cada aspecto de las partes y funciones del mecanismo para solucionar problemas técnicos y completar las reparaciones. Para un divertido ejemplo de este último, consulte el Star Trek: The Next Generation: Technical Manual (portada representada en la Figura 7.4.1), que proporciona descripciones detalladas de todos los equipos y tecnología utilizados a bordo del ficticio U.S.S. Enterprise-D.

Cubierta de manual — Figura 7.4.1 Portada de “Star Trek: La Próxima Generación: Manual Técnico”. ^[1]

Antes de comenzar a redactar tu descripción, debes considerar tu propósito y audiencia: ¿Por qué tu audiencia necesita esta descripción? ¿Para qué lo van a usar? ¿Está describiendo diferentes tipos de paneles solares para los consumidores promedio para ayudarlos a elegir el que mejor se adapte a sus necesidades? ¿Está proporcionando esquemas a técnicos e instaladores?

Una vez que tengas tu propósito y audiencia claramente enfocados, redacta una descripción que incluya los siguientes elementos:

Definición: ¿Qué es y cuál es su propósito principal?
Descripción general: Describir la apariencia general del mecanismo (“big picture” descripción de su tamaño general, forma, apariencia general).
Componentes: Describa los componentes principales en secciones etiquetadas; considere cuidadosamente el orden de la información aquí. Crear una conexión lógica entre cada componente descrito.
Explicación: ¿cómo funcionan juntas las piezas para cumplir con su función? ¿Qué principios clave rigen su funcionamiento? Considera cuántos detalles son necesarios aquí para tu público objetivo.
Visuales: incluyen gráficos que ilustren claramente el mecanismo y/o sus partes. Muestre el dispositivo como un todo; considere mostrar detalles específicos en vistas expandidas, recortes o diagramas etiquetados. Incluso puede incrustar o vincular videos que muestran el dispositivo en acción.
Conclusión: dependiendo del propósito, podrías revisar el historial del producto, disponibilidad, fabricación, costos, advertencias, etc.)
Referencias: Fuentes que ha utilizado en su descripción, o fuentes adicionales de información disponibles (si es relevante).

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

Plantilla de Descripción Técnica

Público y Propósito	¿Quién leerá esta descripción y por qué?
Definición y función	¿Qué es? ¿Qué hace? ¿Cuál es su función/propósito?
Visión general	Describir su aspecto general (forma, tamaño, color, etc.)
Componentes y explicaciones	Describa las partes componentes (elija las características más relevantes) y explique cómo funcionan juntas; trate de encontrar la forma más lógica de organizar esta explicación.
Visuales	¿Qué tipo de gráficos ilustrativos usarás? ¿Dónde? Diagramas Fotografías Vistas recortadas Vistas explosionadas
Conclusión	¿Necesitas ofrecer más información? ¿Historia? ¿Advertencias? ¿Contexto? ¿Costos? etc.
Referencias	Cualquier fuente utilizada, o fuentes suplementarias para sugerir

Descripciones de muestra

Examine la descripción del “Up Goer Five” en la Figura 7.4.2 (haga clic en la imagen para ampliarla). ¿Quién podría ser el público previsto?

Plano de cohete, etiquetado usando lenguaje simplista que suena tonta como “el fuego sale aquí” — Figura 7.4.2 Una descripción de los planos del cohete Saturn Five de la NASA usando solo las 1000 palabras en inglés más utilizadas ^[2]

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

Anote las diferencias en el nivel de detalle, vocabulario y propósito general de las descripciones. Si utilizaste la información del sitio de la NASA para rellenar la Plantilla de Descripción Técnica, podrías terminar con algo así como la siguiente tabla.

Plantilla para Descripción de Mars Curiosity Rover

Definición	Curiosity Rover: un robot de la NASA diseñado para explorar Marte
Función	Viaja alrededor del cráter Gale en Marte, recopilando datos para enviarlos de regreso a la Tierra. Su misión es ver si Marte alguna vez podría haber apoyado la vida, y si los humanos podrían sobrevivir allí algún día
Visión general	Robot de 6 ruedas del tamaño de un automóvil, de aproximadamente 7' de altura, con un chasis aproximadamente cuadrado que tiene varios apéndices conectados a él que albergan sensores de varios tipos
Componentes	El cuerpo principal protege la computadora, la electrónica y los sistemas de instrumentos “Cuello y cabeza” como un mástil que sale del centro del chasis, este alberga muchas de las cámaras del rover Seis patas - diseño de “bogie basculante” - muy separadas, permite que todas las ruedas permanezcan en terrenos irregulares Brazo — aproximadamente 7 'de largo, (con articulaciones de “hombro, codo y muñeca”), con una “mano” al final, se extiende fuera de la parte delantera del chasis. Esto contiene muchas herramientas para perforar, recolectar muestras, etc. “Cola”: contiene una fuente de energía radioisotópica que alimenta el rover
Visuales	Vista general (¿frontal y lateral? ¿Vista superior?) Vista de brazo con componentes etiquetados Vista de cabeza y cuello con componentes etiquetados
Conclusión/ Suplementario	¿Información sobre la vida útil? ¿Velocidad de desplazamiento? ¿Uso de energía?
Referencias	Sitio web de NASA — Página de Mars Curiosity

Quizás encuentres que algunos de estos elementos no son necesarios; nuevamente, considera lo que tu público objetivo ya sabe. Logre un equilibrio entre afirmar innecesariamente lo obvio y asumir incorrectamente que sus lectores tienen conocimiento que pueden carecer.

Al refinar los detalles de su descripción y sus partes componentes, considere lo siguiente:

Organización: Determine el principio más lógico para organizar su descripción
- Pasos en un proceso que completa
- De arriba a abajo (o cimentación hacia arriba)
- De izquierda a derecha (o de derecha a izquierda)
- De dentro a fuera (o de afuera a adentro)
- Las características más importantes a las menos importantes
- Componente central a periféricos
- Propiedades del material, etc.
Lenguaje: Usar términos específicos, precisos y concretos — evitar términos vagos o solapamientos generales
- Utilice la terminología correcta: defina términos según sea necesario para su audiencia
- Usar la analogía para describir algo desconocido en términos de algo familiar
- Usar lenguaje objetivo, sin “hablar publicitario” o términos subjetivos
- Usa verbos activos en tiempo presente para describir cómo aparece el dispositivo y qué hace
- Usa palabras que creen imágenes vívidas y específicas en la mente del lector.

Ejercicio\(\PageIndex{1}\): Practice technical description

Elija un objeto común y cotidiano (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. Comience imaginando un público objetivo y un propósito, y luego intente completar la Plantilla de Descripción Técnica con información detallada. Usando la información de su plantilla, redacte una breve descripción de 1-2 párrafos y agregue imágenes con los subtítulo adecuados.

Figura 7.4.3 Objetos comunes para la descripción de la práctica. ^[3]

R. Sturnback y M. Okuna, Star Trek: La próxima generación: Manual Técnico. Nueva York: Pocket Books, 1991.
R. Munroe, “Up Goer Five” [En línea]. Disponible: https://xkcd.com/1133/ Consulte también “1133 Up Goer Five - explicado”, Explique xkcd wiki [Online]. Disponible: https://www.explainxkcd.com/wiki/index.php/1133:_Up_Goer_Five. CC-BY-NC 2.5.
[Sacacorchos y imágenes de bicicleta]. [En línea]. Disponible: https://www.flickr.com/photos/dogbomb/527733767 y https://www.flickr.com/photos/8205548@N08/4607907389. CC BY 2.0.