10.7: Cuerpo del informe

El cuerpo del informe es por supuesto el texto principal del informe, las secciones entre la introducción y la conclusión. A continuación se ilustran páginas de muestra.

Rúbricas

En todos los reportes menos los más cortos (dos páginas o menos), usa encabezados para marcar los diferentes temas y subtemas tratados. Los encabezados son los títulos y subtítulos que ves dentro del texto real de gran parte de la escritura científica, técnica y empresarial profesional. Los encabezados son como las partes de un esquema que se han pegado en las páginas reales del documento.

Los encabezados son una característica importante de la escritura técnica profesional: alertan a los lectores sobre los próximos temas y subtemas, ayudan a los lectores a encontrar su camino en informes largos y se saltan lo que no les interesa, y rompen largos tramos de texto recto.

Los encabezados también son útiles para los escritores. Te mantienen organizado y enfocado en el tema. Cuando comienzas a usar encabezados, tu impulso puede ser abofetear los encabezados después de haber escrito el borrador preliminar. En su lugar, visualice los encabezados antes de comenzar el borrador preliminar y conéctelos mientras escribe.

Tu tarea en este capítulo es aprender a usar encabezados y aprender el estilo y formato de un diseño específico de encabezados. Aquí hay una serie de consejos útiles:

• Hacer que el fraseo de los encabezamientos se explique por sí mismo: en lugar de “Antecedentes” o “Información Técnica”, hágalo más específico, como “Física de la Fibra Óptica”.
• Hacer que los encabezados indiquen el rango de cobertura de temas en la sección. Por ejemplo, si la sección abarca el diseño y funcionamiento de un reactor de agua presurizada, el encabezamiento “Diseño del reactor de agua a presión” sería incompleto y engañoso.
• Evite los encabezados “apilados”, dos encabezados consecutivos cualesquiera sin que intervenga el texto.
• Evite la referencia del pronombre a los encabezamientos. Por ejemplo, si tienes un encabezado “Torque”, no comiences la oración que lo sigue con algo como esto: “Este es un principio de física...”
• Cuando sea posible, omita los artículos desde el inicio de los encabezamientos. Por ejemplo, “El reactor de agua presurizada” se puede cambiar fácilmente a “Reactor de agua presurizada” o, mejor aún, “Reactores de agua presurizada”.
• No utilices encabezados como lead-ins para listas o como títulos de figuras.
• Evite los encabezados “viudos”: ahí es donde aparece un encabezado en la parte inferior de una página y el texto que introduce comienza en la parte superior de la página siguiente. Mantenga al menos dos líneas de texto principal con el encabezado, u obligarlo a iniciar la nueva página.

Si formateas manualmente cada encabezado individual usando las pautas presentadas en la lista anterior, encontrarás que estás haciendo bastante trabajo repetitivo. Los estilos proporcionados por Microsoft Word, OpenOffice Writer y otro software le ahorran este trabajo. Simplemente selecciona Encabezado 1, Encabezado 2, Encabezado 3, y así sucesivamente. Notarás que el formato y el estilo son diferentes de lo que se presenta aquí. Sin embargo, puedes diseñar tus propios estilos para encabezados.

Extracto del cuerpo de un informe técnico. En un curso de redacción técnica, pregúntale a tu instructor si se requiere el estilo de numeración decimal para los encabezados. Además, es posible que se requiera un sistema de documentación diferente, no el IEEE, que es para ingenieros.

Listas numeradas y con viñetas

En el cuerpo de un reporte, también use listas con viñetas, numeradas y de dos columnas en su caso. Las listas ayudan enfatizando los puntos clave, facilitando el seguimiento de la información y rompiendo muros sólidos de texto. Siempre introduce la lista para que tu audiencia entienda el propósito y el contexto de la lista. Siempre que sea práctico, proporcionar un comentario de seguimiento, también. Aquí hay algunos consejos adicionales:

• Utilice listas para resaltar o enfatizar texto o para enumerar elementos secuenciales.
• Use un lead-in para introducir los elementos de la lista e indicar el significado o propósito de la lista (y puntúnela con dos puntos).
• Utilice espaciado consistente, sangría, puntuación y estilo de mayúsculas para todas las listas de un documento.
• Hacer que los elementos de la lista sean paralelos en fraseo.
• Asegúrese de que cada elemento de la lista se lea gramaticalmente con el lead-in.
• Evite usar encabezados como lead-ins para listas.
• Evite el uso excesivo de listas; usar demasiadas listas destruye su efectividad.
• Use tipos similares de listas de manera consistente en texto similar en el mismo documento.

El seguimiento de una lista con texto ayuda a su lector a comprender el contexto de la información destilada en forma de lista. Los consejos anteriores proporcionan una guía práctica para dar formato a las listas.

Gráficos y títulos de figuras

En el informe técnico, es probable que necesite dibujos, diagramas, tablas y gráficos. Estos no sólo transmiten cierto tipo de información de manera más eficiente sino que también le dan a su informe un aspecto agregado de profesionalismo y autoridad. Si nunca has puesto este tipo de gráficos en un reporte, hay algunas formas relativamente fáciles de hacerlo, no necesitas ser un artista gráfico profesional. Para ver estrategias para agregar gráficos y tablas a los informes, consulte el capítulo sobre Creación y uso de imágenes. Consulte el capítulo sobre imágenes para obtener más ayuda con los principios para crear imágenes.

Conclusiones

Para la mayoría de los informes, deberá incluir una sección final. Cuando planifique la sección final de su informe, piense en las funciones que puede desempeñar en relación con el resto del informe. Una conclusión no necesariamente se limita a resumir un informe. En su lugar, use la conclusión para explicar los hallazgos más significativos que realizó en relación con el tema de su informe.

Apéndices

Los apéndices son aquellas secciones adicionales que siguen a la conclusión. ¿Qué se pone en los apéndices? Cualquier cosa que no encaje cómodamente en la parte principal del informe pero que no pueda quedar fuera del informe del todo. El apéndice se usa comúnmente para tablas grandes de datos, grandes trozos de código de muestra, mapas desplegables, fondo que es demasiado básico o demasiado avanzado para el cuerpo del informe, o ilustraciones grandes que simplemente no caben en el cuerpo del informe. Cualquier cosa que sientas que es demasiado grande para la parte principal del informe o que creas que distraería e interrumpiría el flujo del informe es un buen candidato para un apéndice. Observe que a cada uno se le da una letra (A, B, C, y así sucesivamente).

Fuentes de información

Documentar sus fuentes de información se trata de establecer, mantener y proteger su credibilidad en la profesión. Debe citar (“documento”) información prestada independientemente de la forma o forma en que la presente. Ya sea que lo cite directamente, lo parafrasee o lo resuma, sigue siendo información prestada. Ya sea que provenga de un libro, un artículo, un diagrama, una tabla, una página web, un folleto de producto, un experto al que entreviste en persona, sigue siendo información prestada.

Los sistemas de documentación varían según los profesionales y campos. Para una clase de escritura técnica en la universidad, puede estar usando el estilo MLA o APA. Los ingenieros utilizan el sistema IEEE, ejemplos del cual se muestran a lo largo de este capítulo. Otro sistema de documentación de uso común es proporcionado por la Asociación Americana de Psicología (APA).

Numeración de páginas

El estilo de numeración de páginas utilizado en el diseño tradicional de informes difiere del diseño de informes contemporáneo principalmente en el uso de números romanos en minúsculas en la materia frontal (todo antes de la introducción).

• Todas las páginas del informe (dentro pero excluyendo la portada y la contraportada) están numeradas; pero en algunas páginas no se muestran los números.
• En el diseño contemporáneo, todas las páginas a lo largo del documento utilizan números arábigos; en el diseño tradicional, todas las páginas anteriores a la introducción (primera página del cuerpo del informe) utilizan números romanos en minúscula.
• En páginas especiales, como la página de título y la página uno de la introducción, no se muestran los números de página.
• Los números de página se pueden colocar en una de varias áreas de la página. Por lo general, la mejor y más fácil opción es colocar los números de página en la parte inferior central de la página (recuerde ocultarlos en páginas especiales).
• Si coloca los números de página en la parte superior de la página, debe ocultarlos en abridores de capítulos o secciones donde un encabezado o título esté en la parte superior de la página.

Información de atribución del capítulo

Este capítulo fue derivado por Annemarie Hamlin, Chris Rubio, y Michele DeSilva, Central Oregon Community College, de Online Technical Writing by David McMurrey — CC: BY 4.0