2.14: Definiciones y Descripciones Técnicas
- Page ID
- 103263
\( \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}}\)
\( \newcommand{\vectorA}[1]{\vec{#1}} % arrow\)
\( \newcommand{\vectorAt}[1]{\vec{\text{#1}}} % arrow\)
\( \newcommand{\vectorB}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \)
\( \newcommand{\vectorC}[1]{\textbf{#1}} \)
\( \newcommand{\vectorD}[1]{\overrightarrow{#1}} \)
\( \newcommand{\vectorDt}[1]{\overrightarrow{\text{#1}}} \)
\( \newcommand{\vectE}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash{\mathbf {#1}}}} \)
\( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \)
\( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)
\(\newcommand{\avec}{\mathbf a}\) \(\newcommand{\bvec}{\mathbf b}\) \(\newcommand{\cvec}{\mathbf c}\) \(\newcommand{\dvec}{\mathbf d}\) \(\newcommand{\dtil}{\widetilde{\mathbf d}}\) \(\newcommand{\evec}{\mathbf e}\) \(\newcommand{\fvec}{\mathbf f}\) \(\newcommand{\nvec}{\mathbf n}\) \(\newcommand{\pvec}{\mathbf p}\) \(\newcommand{\qvec}{\mathbf q}\) \(\newcommand{\svec}{\mathbf s}\) \(\newcommand{\tvec}{\mathbf t}\) \(\newcommand{\uvec}{\mathbf u}\) \(\newcommand{\vvec}{\mathbf v}\) \(\newcommand{\wvec}{\mathbf w}\) \(\newcommand{\xvec}{\mathbf x}\) \(\newcommand{\yvec}{\mathbf y}\) \(\newcommand{\zvec}{\mathbf z}\) \(\newcommand{\rvec}{\mathbf r}\) \(\newcommand{\mvec}{\mathbf m}\) \(\newcommand{\zerovec}{\mathbf 0}\) \(\newcommand{\onevec}{\mathbf 1}\) \(\newcommand{\real}{\mathbb R}\) \(\newcommand{\twovec}[2]{\left[\begin{array}{r}#1 \\ #2 \end{array}\right]}\) \(\newcommand{\ctwovec}[2]{\left[\begin{array}{c}#1 \\ #2 \end{array}\right]}\) \(\newcommand{\threevec}[3]{\left[\begin{array}{r}#1 \\ #2 \\ #3 \end{array}\right]}\) \(\newcommand{\cthreevec}[3]{\left[\begin{array}{c}#1 \\ #2 \\ #3 \end{array}\right]}\) \(\newcommand{\fourvec}[4]{\left[\begin{array}{r}#1 \\ #2 \\ #3 \\ #4 \end{array}\right]}\) \(\newcommand{\cfourvec}[4]{\left[\begin{array}{c}#1 \\ #2 \\ #3 \\ #4 \end{array}\right]}\) \(\newcommand{\fivevec}[5]{\left[\begin{array}{r}#1 \\ #2 \\ #3 \\ #4 \\ #5 \\ \end{array}\right]}\) \(\newcommand{\cfivevec}[5]{\left[\begin{array}{c}#1 \\ #2 \\ #3 \\ #4 \\ #5 \\ \end{array}\right]}\) \(\newcommand{\mattwo}[4]{\left[\begin{array}{rr}#1 \amp #2 \\ #3 \amp #4 \\ \end{array}\right]}\) \(\newcommand{\laspan}[1]{\text{Span}\{#1\}}\) \(\newcommand{\bcal}{\cal B}\) \(\newcommand{\ccal}{\cal C}\) \(\newcommand{\scal}{\cal S}\) \(\newcommand{\wcal}{\cal W}\) \(\newcommand{\ecal}{\cal E}\) \(\newcommand{\coords}[2]{\left\{#1\right\}_{#2}}\) \(\newcommand{\gray}[1]{\color{gray}{#1}}\) \(\newcommand{\lgray}[1]{\color{lightgray}{#1}}\) \(\newcommand{\rank}{\operatorname{rank}}\) \(\newcommand{\row}{\text{Row}}\) \(\newcommand{\col}{\text{Col}}\) \(\renewcommand{\row}{\text{Row}}\) \(\newcommand{\nul}{\text{Nul}}\) \(\newcommand{\var}{\text{Var}}\) \(\newcommand{\corr}{\text{corr}}\) \(\newcommand{\len}[1]{\left|#1\right|}\) \(\newcommand{\bbar}{\overline{\bvec}}\) \(\newcommand{\bhat}{\widehat{\bvec}}\) \(\newcommand{\bperp}{\bvec^\perp}\) \(\newcommand{\xhat}{\widehat{\xvec}}\) \(\newcommand{\vhat}{\widehat{\vvec}}\) \(\newcommand{\uhat}{\widehat{\uvec}}\) \(\newcommand{\what}{\widehat{\wvec}}\) \(\newcommand{\Sighat}{\widehat{\Sigma}}\) \(\newcommand{\lt}{<}\) \(\newcommand{\gt}{>}\) \(\newcommand{\amp}{&}\) \(\definecolor{fillinmathshade}{gray}{0.9}\)Objetivos de aprendizaje
Al finalizar este capítulo, los lectores podrán:
- Explicar y aplicar las 5 características primarias de las definiciones técnicas.
- Escribir una definición usando contenido apropiado, descriptores, detalles, duración, ubicación y análisis de audiencia.
- Evite problemas comunes de definición técnica.
- Explicar y aplicar las 5 características primarias de las descripciones técnicas.
- Escribe una descripción usando las 6 partes comunes.
- Organizar una descripción de acuerdo a los 3 patrones organizacionales comunes.
Definiciones técnicas
Cuando piensas en la palabra “definición”, ¿qué te viene a la mente? Si eres como la mayoría de la gente, piensas en el contenido de un diccionario. ¿Qué contiene entonces una definición de diccionario?
Por lo general, las definiciones de diccionario incluyen una palabra
- Ortografía estándar
- Saltos de sílabas
- Pronunciación
- Parte del discurso
- Significado
- Uso actual y arcaico
- Etimología
- Sinónimos/antónimos
- Ortografía de variantes
- Variantes incluyendo sufijos
Si has usado un diccionario antes, entonces ninguno de estos artículos debería sorprenderte. Piensa, aunque... ¿Todos los diccionarios son iguales? Y ¿contienen el mismo tipo de cosas?
En realidad no. Todos los diccionarios contienen listas de palabras, pero sus contenidos son, por lo demás, marcadamente diferentes. Un diccionario infantil, por ejemplo, es mucho más simple y más corto que un diccionario “colegiado”, que es más corto y sencillo que un diccionario íntegro, que palidece en comparación con el Oxford English Dictionary, un monstruo de dos volúmenes que viene con un atril reforzado y su propia lupa.
Sin embargo, todos estos diccionarios diferentes comparten varias características, que son características de cualquier definición técnica:
- sus autores se centran en una audiencia particular;
- su contenido describe el objeto de atención;
- su contenido aclara la ambigüedad;
- los lectores pueden usar los contenidos para comunicarse a través de los niveles de experiencia; y
- los lectores pueden usar los contenidos para resolver problemas.
Al menos una de estas ideas debería sonar familiar. Por ejemplo, enfocarse en un público en particular... ¿no lo hemos mencionado en algún momento antes, en esta misma clase?
En lo que respecta a los otros cuatro elementos, la tentación es decir: “Bueno, sí, claro. Eso es lo que hace una definición”. El truco, sin embargo, es incluir la información correcta, estructurarla de la manera correcta y construir una buena definición. De eso hablaremos a continuación.
Definición Técnica Contenidos
Como el nombre podría sugerir, una definición técnica debería explicar qué es una cosa. Pero, ¿qué significa realmente “explicar lo que es una cosa”? ¿Cuánto tiempo tiene que durar la explicación? ¿Y a dónde va la explicación?
Las respuestas a estas preguntas dependen de las características enumeradas anteriormente y del sustantivo (persona, lugar, cosa, idea o proceso) que estés definiendo, y vemos las respuestas expresadas en términos de contenido, longitud y ubicación.
Descriptores
Hablemos de descriptores que se pueden utilizar al escribir una definición. Aquí hay una lista parcial de posibles elementos que puede usar para definir un sustantivo:
- características físicas (color, forma, tamaño, material, olor, sabor, textura de una cosa, etc.)
- utiliza
- funciones
- operación (cómo funciona, pero no cómo trabajarla — eso es lo que va en las instrucciones)
- efectos
- orígenes
- analogías (“Sabe a pollo”, por ejemplo)
- ejemplos específicos
- fotos
- diagramas
Existen más descriptores posibles, pero estos son los sospechosos habituales. Escogerás los adecuados en función de la situación en cuestión.
Tipo de Detalles
El tipo de detalle que incluirías en una definición técnica variará. Al igual que con todo lo que escribes, y literalmente todo, ya sea que lo estés escribiendo para esta clase, en clases futuras o durante el resto de tu vida, debes considerar a tu audiencia con mucho cuidado. Por ejemplo, ¿quién es tu público? ¿Cómo es s/él? ¿Qué tipo de lenguaje usarías? ¿A qué medio respondería mejor el público? ¿A qué tipo de palabras responderá mejor el público? Etcétera... En definitiva, analice a su audiencia cuidadosamente y adapte el contenido a esa audiencia.
Ejemplo
Como ilustración del tipo de detalles que elegiría para un público en particular, pensemos en definir el acero especial utilizado en la zona de deformación del marco de un automóvil. (Si no sabes lo que es una zona de arrugas, es una zona de un automóvil diseñada para ser aplaudido en un choque y absorber toda la energía cinética, haciendo así que los pasajeros sean más seguros).
Vamos a definir el acero en esta parte del auto para tres públicos diferentes: tú, un fabricante de automóviles y un comprador de autos.
Para ustedes, si definiera el acero como acero de alta austenita dopado con boro que sufre una transformación martensítica en un choque, eso probablemente no significaría nada porque la información es demasiado detallada. Sin embargo, si definiera el acero en la zona de deformación de un automóvil moderno como acero relativamente blando que de repente se endurece cuando se pone bajo tensión, entonces probablemente entenderías bien.
Para un fabricante de automóviles moderno, sin embargo, ninguna de esas definiciones sería lo suficientemente detallada. El fabricante necesitaría conocer detalles sobre cuánto boro entró en el acero, qué tan dúctil (flexible) es el acero, cuánto estrés puede soportar el acero antes de que se endurezca o se rompa, y qué tan rápido se endurece el acero cuando se pone bajo tensión. Para esta audiencia, necesitarías escribir una definición altamente detallada y altamente técnica.
A un comprador de autos, por otro lado, simplemente no le importa qué tipo de acero vaya a la zona de arrugado de un automóvil. Lo único que un comprador de autos quiere saber es si las calificaciones de las pruebas de choque NTSA del auto son buenas.
Otra cosa a considerar es qué tipo de objeto/proceso/cosa es que estás documentando. Algunos sustantivos simplemente no requieren ciertos tipos de descriptores.
Ejemplo
Como ilustración de los detalles necesarios para un tema en particular, volvamos a considerar el mismo ejemplo: el acero utilizado en la zona de deformación de un automóvil.
El acero de alta austenita es relativamente dúctil; su proceso de fabricación incluye laminación en frío, recocido y enfriamiento; y los fabricantes de automóviles utilizan acero de alta austenita en zonas de deformación porque este acero se vuelve más duro y rígido bajo presión, protegiendo así a los conductores.
Todas estas propiedades tienen sentido cuando hablamos de metal. En contraste, decir que cierta pieza de acero de highaustenita tiene un aspecto gris moteado, hace un ruido en la clave de C-sharp, o sabe a galletas con chispas de chocolate probablemente no sea relevante para nadie.
Largo
Como ya mencionamos, la necesidad de información de la audiencia impulsará la cantidad de información que brindes. Si la audiencia necesita y puede manejar mucha información, entonces obtenga súper detalles. Por otro lado, si el público solo necesita o solo puede manejar lo básico por cualquier razón, entonces mantenga la definición breve e incluya solo la información absolutamente necesaria.
Ejemplo
Como ilustración de la longitud, consideremos una definición de diccionario.
Una persona que consulta el Oxford English Dictionary probablemente quiera información detallada sobre las muchas formas en que se ha utilizado una palabra en particular a lo largo de los siglos. En consecuencia, la definición de OED debe ser muy larga y llena de ejemplos.
En contraste, un estudiante de secundaria que solo quiere saber pronunciar una palabra o averiguar el significado de una palabra no querrá leer páginas sobre páginas de etimología y uso. Ese estudiante solo quiere la información básica y nada más.
Colocación
La necesidad de información de la audiencia y el tipo de información que estás definiendo también conducirán a dónde coloques las definiciones. Cuatro opciones principales incluyen colocar definiciones en
- oraciones independientes
- cláusulas dependientes
- apartes entre paréntesis
- secciones separadas
Si estás usando términos relativamente simples y tienes un público bien informado, usa definiciones simples y cortas que se ajusten a una oración ordinaria. Si la definición es un poco más compleja y/o tu audiencia necesita un poco más de información, usa una declaración entre paréntesis. Si estás definiendo información complicada o detallada, incluso a un público conocedor, inserta párrafos completos o subsecciones.
A veces, dependiendo de la naturaleza del documento que contiene una definición, referirás a los lectores a secciones enteras, como notas al pie de página, un glosario al dorso de un libro de texto o apéndices al final de propuestas formales e informes (pista, pista sobre esta última parte).
Ejemplos
En una oración aparte: “La mantequilla de maní es una pasta hecha de cacahuetes molidos”.
En una cláusula dependiente: “Jim's Steakhouse usa frascos Mason de boca ancha, como los que se utilizan para conservar mermelada casera, como vasos de agua. “
En una declaración entre paréntesis: “Los gatos siameses, fácilmente identificables por sus ojos azules, sus cabezas de forma triangular, sus incesantes yowling y sus actitudes autotituladas, provienen del sudeste asiático”.
Problemas de definición técnica
Cuando escribas definiciones técnicas, presta especial atención a evitar estos tres problemas:
- audiencia-contenido inapropiado/ idioma
- definiciones circulares
- definiciones de sinónimos
Material inapropiado para la audiencia
Ya lo hemos discutido, así que voy a mantener mi rap corto: Analiza a tu audiencia y dale a los miembros de tu audiencia lo que necesitan, de una manera que puedan entenderlo.
Definiciones circulares
Algunas malas definiciones dependen de que el lector ya sepa cuál es la cosa definida es/hace.
Aquí hay un ejemplo: “La supercloración es una técnica química de piscinas que permite a los operadores lograr la cloración de punto de interrupción”. Bien... pero ¿qué es la cloración de punto de interrupción? “La cloración de punto de interrupción es un nivel elevado de cloro que los operadores de piscinas alcanzan superclorando el agua”.
*suspiro*
Definiciones Sinónimas
Otras malas definiciones sustituyen un sinónimo por otro. Aquí hay un ejemplo: “Las cloraminas son otro nombre para el cloro combinado”. Bien... pero ¿qué es el cloro combinado? Uy. Acabo de definir una cosa como si misma.
Aquí hay una versión revisada: “Las cloraminas son moléculas de 'cloro libre' (la forma químicamente activa del cloro que desinfecta, oxida y desinfecta el agua de la piscina) que se encontró con una sustancia orgánica, unida químicamente a la sustancia orgánica, se volvió químicamente neutra y comenzó a desprender un mal olor”. Esta versión es mucho mejor, ¿sí?
Descripciones técnicas
Las descripciones técnicas son similares a las definiciones técnicas. pero las descripciones técnicas pueden ser documentos independientes, mientras que las definiciones técnicas son siempre componentes de un documento más grande. Además, descripciones técnicas
- suelen ser más largas que las definiciones técnicas,
- contienen más detalles,
- centrarse en la funcionalidad,
- a menudo describen temas complicados con múltiples partes, y
- contienen definiciones técnicas.
Descripción Técnica Partes
Dado que las descripciones técnicas son más largas y detalladas que las definiciones técnicas, las descripciones contienen dos secciones principales: Introducciones y Secciones Cuerpo.
Introducción
El contenido de la introducción de una descripción técnica es muy similar al contenido de una carta formal. En el primer párrafo, es necesario
- identificar lo que se va a describir;
- proporcionar algunos antecedentes básicos (propósito de la escritura, contexto de la escritura);
- dar un breve panorama de lo que se va a describir (cómo es, cuál es su propósito);
- y previsualizar el resto del documento.
Cuerpo
Después de la Introducción, el contenido de una descripción técnica variará, dependiendo de tu audiencia y de la cosa que se describa. Sin embargo, hay algunos temas comunes en los párrafos del cuerpo de cualquier descripción técnica.
Antecedentes
Los párrafos del cuerpo encarnan la información de fondo con más detalle. Nuevamente, al igual que el cuerpo de una carta formal contiene detalles sobre el tema de la carta, el cuerpo de una descripción técnica contiene detalles sobre los antecedentes de la cosa que se está documentando. Por supuesto, adapta el contenido en función de tu audiencia y el tema en cuestión.
Piezas/Características
En los párrafos del cuerpo también se incluyen detalles sobre las diversas partes que conforman la cosa que se está describiendo. Si la cosa es un objeto físico, querrás enumerar y describir las diversas partes que componen el conjunto. Si la cosa es un lugar, entonces ¿qué lo hace diferente o similar a otros lugares? Si la cosa es un proceso, entonces ¿cuáles son sus condiciones necesarias y sus diversas etapas/pasos?
Visuales
El cuerpo de una descripción técnica también puede incluir materiales visuales (y, posiblemente, materiales de audio si la descripción es multimedia). Estos pueden ser cuadros, tablas, diagramas, tablas, gráficas... si es apropiado, ponlo adentro. Un tipo particular de material visual que necesitamos abordar bajo su propio epígrafe, sin embargo, es la especificación.
Especificaciones
La palabra “especificaciones” tiene dos definiciones. Una de las definiciones se refiere a una lista (a menudo una tabla) de detalles técnicos sobre el objeto o proceso que estás documentando. Estos pueden formar parte de una definición técnica y a menudo son necesarios en una descripción técnica.
El segundo significado, que abordaremos aquí, se refiere a imágenes que representan el tema de una descripción e incluyen llamadas (líneas o flechas con texto adjunto) para resaltar las partes constituyentes de ese objeto.
Tenga en cuenta: Las especificaciones no son descripciones. Pueden ser parte de las descripciones, pero las especificaciones no pueden estar solas.
He aquí por qué: Imagina que compraste un televisor nuevo, de primera línea. Estás bastante emocionado, ya que es un televisor tecnológicamente avanzado, con un billón de funciones que puedes programar y personalizar para la experiencia televisiva más increíble del mundo.
Desempaquetas la caja y, en lugar de un manual del propietario, todo lo que encuentras es una sola hoja de papel que imagina el control remoto del televisor, con flechas etiquetadas en cada botón. Un botón está etiquetado como “Skip”.
- ¿Qué hará el televisor si pulsas el botón?
- ¿Qué se omitirá?
- ¿Se puede deshacer un salto?
- ¿Y si presionas el botón dos veces? ¿Tres veces?
- ¿Se puede usar “Skip” mientras se ve televisión normal, o solo durante la reproducción del DVR?
- ¿Tiene “Skip” sentido para programar tu DVR?
Todas estas preguntas necesitan respuesta antes de que te atrevas a presionar el botón “Omitir”. Estarías muy infeliz si te perdieras grabar el episodio de Game of Thrones de esta semana o de alguna manera grabaras sobre el maratón de Jersey Shore...
Descripción Técnica Organización
Las definiciones técnicas largas necesitan sus propias estrategias de organización, al igual que cualquier escrito, pero las descripciones técnicas generalmente se basan en uno de tres esquemas de organización:
- general a específico
- espacial
- cronológico
Tu elección de una estrategia de organización dependerá del tipo de cosas que estés describiendo. En general, siempre querrás pasar de lo general a lo específico, pues necesitas comenzar por definir la cosa y luego proceder desglosándola temáticamente. Sin embargo, cuál es ese tema depende de la naturaleza de la cosa que se describa.
General a específico
Por ejemplo, digamos que estás documentando una bicicleta. ¿Sería de algún bien empezar a nombrar piezas? “Bien... aquí está la rueda delantera, y aquí está el asiento, y aquí está el manillar... ¡ooh! ¡Mi parte favorita, el protector de cadena! "Por supuesto que no; se necesita algún tipo de lógica interna a la lista de piezas. Un esquema lógico podría ser comenzar con sistemas principales (bastidor, ruedas, engranajes, frenos) y luego describir cómo funcionan los sistemas juntos o entrar en más detalles sobre las partes que componen cada uno de estos sistemas.
Espaciales
¿Qué tal describir la construcción de un carburador de cuatro barriles? Es probable que desee describir cómo encajan las partes, por lo que un esquema de organización espacial tendría sentido, completo con un diagrama de vista explosionada de las partes. (Como nota al margen completamente irrelevante, en el año 2000, conocí al inventor del carburador de cuatro barriles; estaba a principios de los noventa y se desempeñaba como voluntario como tutor de matemáticas en un colegio comunitario en Arizona. Era un tipo muy agradable.)
Cronológico
Pero, ¿qué pasa con describir un proceso, como fundir hierro? Dar un recorrido por la fábrica no tendría mucho sentido, ¿verdad? “Aquí está el alto horno, y por aquí está la trituradora de rocas. Y luego de este lado, tenemos el taller de fabricación de moldes y un montón de llantas de repuesto para carretillas. ”
No... querrías proceder cronológicamente, paso a paso, a través del proceso. “Primero, los camiones volquete transportan mineral crudo y lo vierten en esta papelera. Entonces usamos un cargador de cangilones para transferir el mineral a esta máquina, donde lo pulverizamos. Después cargamos el mineral triturado en estos crisoles y asamos el mineral hasta que el hierro se derrita. A partir de ese punto, nosotros... "Se entiende la idea.