Verificar contenidos
Una de las maneras más importantes de revisar un borrador es comprobar el contenido— ¡qué obvio es eso! Todas las buenas transiciones, buena organización y una estructura de oraciones clara en el mundo no pueden ayudar a un documento técnico que no tiene el contenido correcto. El contenido de un documento técnico puede ser "incorrecto" de varias maneras:
- Puede faltar por completo: por ejemplo, imagina que alguien escribió un informe sobre "comunidades virtuales" pero nunca se molestó en definir lo que significa ese término. Sería complicado desde el principio de ese informe.
- Está ahí, pero no es suficiente: toma el mismo ejemplo—imagina que el escritor solo hizo algunas afirmaciones vagues sobre comunidades virtuales. Lo que se necesitaba era al menos un párrafo sobre el tema, si no una sección completa de 3 o 4 páginas.
- Está ahí, pero en el nivel equivocado para la audiencia: También es posible presentar información en el nivel equivocado en términos de conocimientos, antecedentes o necesidades de los lectores. Imagina que el escritor incluyó una sección de 3 páginas sobre caché de datos, pero escrita para el desarrollador de producto (una __ENTIDAD_0__experto__ENTIDAD_1__) cuando el informe realmente estaba destinado a no especialistas.
Si puedes tener una idea de cómo la información es inadecuada en un borrador del informe, deberías estar bien encaminado para saber qué hacer específicamente para revisarlo. Una herramienta útil de lluvia de ideas es pensar en términos de tipos de contenido.
Usa las preguntas proporcionadas en contenido del documento para revisar tu borrador para tipos de información que agregar o cambiar.
Revisa la estructura de tus contenidos
Hay dos formas de ver la organización de la información en un documento:
- uno, cubierto en la siguiente sección, implica observar la secuencia de fragmentos de información, ver si están en el orden correcto.
- Otro tiene que ver con los niveles de información. Puedes observar las oraciones o párrafos en un borrador y ver que algunas oraciones abordan un nivel más profundo de discusión sobre el tema que otras. Otras oraciones actúan como el marco sobre el cual dependen esas oraciones de nivel más profundo. Al mirar la estructura de esta manera, no solo revisas su organización, sino que también obtienes muchas buenas ideas sobre cómo mejorar el contenido del texto.
Se proporciona una explicación mucho más detallada en coordinación y subordinación en párrafos.
Verificar organización
Si tienes el contenido correcto en un informe, al menos tienes todas las "cosas adecuadas" disponibles para los lectores. Sin embargo, aún puede que no esté adecuadamente organizado—como cuando acabas de mudarte y todo está desordenado o aún en cajas. Necesitas dos habilidades esenciales para revisar la organización de un borrador:
- Identificar el tema de fragmentos de información en varios niveles. Para evaluar la organización de una serie de párrafos, comienzas pensando en una palabra o frase para identificar el tema de cada párrafo — en otras palabras, entender cada uno. Luego te alejas de esas palabras o frases, considerando si están en la secuencia correcta. Sin embargo, eso es solo un nivel. También puedes mirar dentro un párrafo individual para su organización. En este caso, identificas el tema de cada oración y consideras la secuenciación de esas oraciones.
- Elige la mejor secuencia para los fragmentos de información. Una vez que conozcas el tema de cada uno de los fragmentos de información (en el nivel que estés investigando), entonces podrás decidir si están en la secuencia correcta. Esta decisión implica conocer los patrones de secuenciación comunes; aquí tienes algunos ejemplos:
- General → específico: Una forma común de organizar es disponer fragmentos de contenido de lo general a lo específico. Por ejemplo, definiendo todo Los colectores solares son una discusión más general que discutir los diferentes tipos de colectores solares. Y describir el funcionamiento de un tipo específico de colector solar es aún menos general. Este patrón se ilustra aquí:
Revisión con el patrón organizativo de general a específico. es una progresión más natural comenzar definiendo qué hacen todos los colectores solares, y luego pasar a sus diferentes tipos. - Simple, básico → complejo: Otra forma de organizar las unidades de una discusión es comenzar con las simples, básicas y fundamentales, y luego pasar a las más complejas y técnicas.
- Cosa-en-reposo → cosa-en-movimiento: Otro patrón de organización implica primero describir la cosa (como si estuviera en una fotografía), luego discutir su operación o proceso (como si estuviera en un video). Este enfoque podría funcionar bien para una discusión sobre un sistema de inyección de combustible.
- Movimiento espacial: — Si estás describiendo los detalles físicos de algo, puede que quieras usar algún patrón de movimiento físico, por ejemplo, de arriba a abajo, de izquierda a derecha, o de afuera hacia adentro.
- Movimiento temporal: — Uno de los patrones más comunes se basa en el movimiento a través del tiempo; organiza la discusión de eventos en relación con la secuencia temporal.
- Aplicación del concepto →, ejemplosUn patrón organizacional común es discutir un concepto en términos generales y luego discutir una aplicación de este. Por ejemplo, otro capítulo de este libro discute las propuestas primero de manera conceptual y luego discute ejemplos de propuestas.
- Datos → conclusiones: Otro medio de organizar la información es presentar los datos (observaciones, datos experimentales, resultados de encuestas) y luego pasar a las conclusiones que se pueden extraer de esos datos. (Y este patrón a veces se invierte: presentar primero la conclusión, luego los datos que la apoyan.)
- Problema, pregunta → solución, respuesta: También puedes organizar la información primero discutiendo un problema o planteando una pregunta y luego pasando a la solución o respuesta.
- Versión simplificada → versión detallada: Una manera útil de explicar asuntos técnicos a los no especialistas es comenzar hablando de una versión simplificada de la cosa, establecer una comprensión sólida de ella, y luego volver a explicarlo todo pero esta vez agregando los detalles técnicos de manera densa y pesada.
- Más importante → menos importante: Un método de organización más "retórico" es comenzar con la información más importante, la más llamativa, la más dramática primero y luego pasar a información que sea progresivamente menos impactante. (Y este patrón puede invertirse: puedes construir hasta un clímax, en lugar de comenzar con él.)
- Más convincente → menos convincente: — De manera similar, puedes comenzar con el argumento más convincente para tu posición — para captar la atención de todos — y luego pasar a los menos y menos convincentes. (Este patrón también puede ser invertido: puedes ir construyendo hasta tus argumentos más convincentes.)
- General → específico: Una forma común de organizar es disponer fragmentos de contenido de lo general a lo específico. Por ejemplo, definiendo todo Los colectores solares son una discusión más general que discutir los diferentes tipos de colectores solares. Y describir el funcionamiento de un tipo específico de colector solar es aún menos general. Este patrón se ilustra aquí:
Estas son solo algunas posibilidades. Cuando el objetivo es informativo, organizes la información de manera que asegures que los lectores comprendan lo básico antes de pasar a lo complicado y técnico. Cuando el objetivo es persuasivo, organizas las cosas para maximizar el efecto persuasivo en los lectores, por ejemplo, poniendo los argumentos más fuertes primero.
Y en cualquier caso, evitas mezclar estos enfoques—por ejemplo, descartando algunos datos, luego enunciando algunas conclusiones, y luego haciendo esto de manera desordenada. ¡Mantén las manzanas separadas de las naranjas!
Fortalecer oraciones temáticas y resúmenes
Una de las mejores cosas que puedes hacer es regresar a través de un borrador y verificar si puedes insertar oraciones temáticas y visiones generales en puntos clave. Cuando escribimos, normalmente no estamos seguros de exactamente a dónde va un párrafo o sección en términos de su contenido y lógica. Una vez que ha "llegado allí," a menudo es necesario regresar al principio y agregar algún tipo de visión general o modificar lo que ya está allí para hacer la visión general más clara. Los lectores necesitan saber hacia dónde van en un informe, qué viene a continuación y, para ese caso, dónde acaban de estar.
Tener una visión general en un informe es como tener un mapa cuando estás en una ciudad nueva. Las oraciones temáticas y las visiones generales ofrecen una perspectiva sobre qué hay donde: el tema, los subtemas, el propósito de la discusión que viene, su relación con la sección anterior y con el documento en su conjunto. (Ahora, parte de esto implica transiciones, que es el siguiente elemento a revisar.)
Para un tratamiento detallado de este tema, vea oraciones temáticas y resúmenes.
Fortalece la coherencia, las transiciones.
Puedes tener la información correcta en un informe y tenerla organizada adecuadamente, pero algo importante aún puede salir mal. Los lectores pueden perder el "flujo" de las ideas, tener dificultades para percibir cómo los bloques de información están relacionados o conectados entre sí. Lo que los lectores necesitan es una guía continua—que es lo que tú, el escritor, proporcionas. Y lo que utilizas para proporcionar esa guía se llama transiciones—varios dispositivos que ayudan a los lectores a lo largo de un documento. Hay (o ciertamente debería haber) una lógica que conecta cada oración en un documento y que dicta una cierta secuencia a esas oraciones.
Vea el capítulo sobre coherencia y transiciones para una discusión detallada y ejemplos.
Verifica la longitud del párrafo.
Una última forma de revisar tu borrador en el nivel de estructura es comprobar cómo has definido los saltos de párrafo. Los párrafos son criaturas extrañas—algunos académicos de la escritura creen que no existen y son solo puntos de ruptura arbitrarios que los escritores insertan cuando y donde les plazca. Lo siento—en la escritura técnica, el párrafo es un jugador clave en la lucha por la claridad y la comprensión. Aunque no siempre es posible, los párrafos deben ocurrir donde haya un cambio en el tema o subtema o algún cambio en la forma en que se está discutiendo un tema.
En una página completa de escritura a interlineado sencillo, busca al menos uno a cuatro saltos de párrafo—no hay nada mágico en ese promedio, así que no lo trates como si fuera ley. Solo echa un segundo vistazo a esos párrafos largos y verifica la posibilidad de saltos de párrafo.
Agradecería tus pensamientos, reacciones, críticas sobre este capítulo: tu respuesta—David McMurrey.
