4.1: Diseño de informes
- Page ID
- 103310
\( \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 hacer lo siguiente:
- Explicar la importancia del diseño efectivo de informes.
- Explicar el propósito de una carta de envío.
- Defina cuándo las cubiertas y las etiquetas son apropiadas para los informes.
- Explicar los propósitos de y escribir un resumen descriptivo y resumen ejecutivo para un informe.
- Aplicar principios de diseño de tablas de contenidos y figuras.
- Aplicar consideraciones básicas de diseño en el cuerpo de un informe.
- Definir la idoneidad de una conclusión, apéndice y fuentes de información.
Los informes técnicos (incluyendo manuales y guías) tienen varios diseños dependiendo de la industria, profesión u organización. Este capítulo te muestra un diseño tradicional. Si estás tomando un curso de redacción técnica, asegúrate de que el diseño presentado en este capítulo sea aceptable. Lo mismo es cierto si estás redactando un informe técnico en un contexto científico, empresarial o gubernamental.
Los informes técnicos tienen especificaciones al igual que cualquier otro tipo de proyecto. Las especificaciones para los informes implican el diseño, organización y contenido, formato de encabezamientos y listas, el diseño de los gráficos, etc. La ventaja de una estructura y formato requeridos para los informes es que usted o cualquier otra persona pueden esperar que se diseñen de una manera familiar, ya sabe qué buscar y dónde buscarlo. Los informes generalmente se leen con prisa: la gente tiene prisa por llegar a la información que necesita, los hechos clave, las conclusiones y otros elementos esenciales. Un formato de reporte estándar es como un vecindario familiar.
Cuando analices el diseño de un reporte técnico, observa cuán repetitivas son algunas secciones. Esta duplicación tiene que ver con cómo la gente lee los informes. No leen los informes directamente: pueden comenzar con el resumen ejecutivo, saltarse y probablemente no leer todas las páginas. Tu reto es diseñar informes para que estos lectores encuentren tus hechos y conclusiones clave, sin importar cuánto del informe lean o en qué orden lo lean.
Los componentes estándar del reporte técnico típico se discuten en este capítulo. Las siguientes secciones le guían a través de cada uno de estos componentes, señalando las características clave. Al leer y utilizar estos lineamientos, recuerde que estos son lineamientos, no mandamientos. Diferentes empresas, profesiones y organizaciones tienen sus propias y variadas pautas para los informes; tendrás que adaptar tu práctica a las que se presentan aquí.
Carta de envío
La carta de transmisión es una carta de presentación. Por lo general, se adjunta al exterior del informe con un clip, pero puede encuadernarse dentro del informe, como una especie de prefacio del autor. Se trata de una comunicación de usted, el redactor del informe, al destinatario, a la persona que solicitó el informe y que incluso puede estar pagando por su consulta experta. Esencialmente, dice “Bien, aquí está el informe que acordamos que completaría para tal y tal fecha. Brevemente, contiene esto y aquello, pero no abarca esto o aquello. Avísame si satisface tus necesidades”. En la carta de envío se explica el contexto, los hechos que dieron origen al reporte. Contiene información sobre el reporte que no pertenece al reporte.
Utilice el formato estándar de carta comercial para cartas de presentación. Si escribes un informe interno, usa en su lugar el formato memorándum; en cualquier caso, el contenido y la organización son los mismos:
- Primer párrafo. Cita el nombre del informe, poniéndolo en cursiva. También menciona la fecha del acuerdo para redactar el informe.
- Párrafo (s) medio (s). Se centra en el propósito del informe y ofrece una breve reseña del contenido del informe.
- Párrafo final. Alienta al lector a ponerse en contacto si hay preguntas, comentarios o inquietudes. Se cierra con un gesto de buena voluntad, expresando la esperanza de que el lector encuentre satisfactorio el informe.
Al igual que con cualquier otro elemento de un informe, es posible que tenga que modificar el contenido de esta carta (o memo) para situaciones específicas. Por ejemplo, es posible que desee agregar un párrafo que enumere preguntas que le gustaría que los lectores consideren al revisar el informe.
Cubierta y Etiqueta
Si tu reporte tiene más de diez páginas, atalo de alguna manera y crea una etiqueta para la portada.
Cubiertas
Las cubiertas dan a los informes un aspecto sólido y profesional así como protección. Puedes elegir entre muchos tipos de fundas. Ten en cuenta estos consejos:
- Las mejores cubiertas utilizan una encuadernación en espiral (mejor) o de plástico “peine” (segunda mejor) y papel grueso de cartulina para las cubiertas. Estas fijaciones permiten que los informes permanezcan abiertos por sí mismos, son económicos y se suman a la profesionalidad de su trabajo. Cualquier copiería puede hacer una para usted.
- Las carpetas de tres anillos (también llamadas cuadernos de hojas flojas) son una segunda opción decente. Permiten que su informe quede plano, pero a menudo son demasiado voluminosos para informes cortos, y los agujeros de la página tienden a romperse. Sin embargo, si la audiencia quiere eliminar o reemplazar páginas, entonces una carpeta de tres anillas es una opción apropiada.
- Las carpetas de tres agujeros que usan claveles para mantener juntas las páginas son una tercera opción distante. Son menos voluminosos que las carpetas de tres anillas, pero evitan que las páginas queden planas, y los lectores deben pesar o arrugar las páginas. Si usa uno de estos, agregue media pulgada adicional al margen izquierdo para dar cuenta de la “cuneta” entre páginas.
- Las fundas deslizantes de plástico transparente (o coloreadas) con la funda de plástico en el borde izquierdo nunca son apropiadas para un informe profesional. Estos son como algo fuera de la escuela primaria, y son agravantes de usar. No van a quedar planos, por lo que los lectores deben luchar para mantenerlos abiertos, y generan electricidad estática, lo que hace que las páginas se peguen juntas.
Etiquetas
Asegúrate de diseñar una etiqueta para la portada de tu reporte. Es un paso que algunos redactores de reportajes olvidan. Sin etiqueta, un reporte es anónimo; se ignora.
La mejor manera de crear una etiqueta es usar su software de procesamiento de textos para diseñar uno en una página estándar con una caja gráfica alrededor de la información de la etiqueta. Imprímela, luego vaya a una copiería y haga que se fotocopie directamente en la portada del reporte.
No hay requisitos estándar para la etiqueta, aunque su empresa u organización debe tener sus propios requisitos. Los elementos comunes a incluir son
- el título formal del informe
- el destinatario previsto
- los autores (o, a menudo, la organización del autor)
- un número de seguimiento del informe
- la fecha de presentación
Figura\(\PageIndex{1}\)
Resumen y Resumen Ejecutivo
La mayoría de los reportes técnicos contienen un resumen descriptivo o un resumen ejecutivo, y en ocasiones ambos. Cada elemento resume el contenido de un informe, pero lo hacen de diferentes maneras y para diferentes propósitos.
Abstracto descriptivo
Este breve párrafo proporciona una cápsula de visión general de la finalidad y el contenido del informe. Por lo general, es un solo párrafo. En muchos diseños de reportes, el resumen descriptivo aparece en la parte inferior de la página de título (no la portada), como se muestra en el siguiente ejemplo.
Ejemplo
Reactores nucleares de agua ligera
presentado a
Sr. David A. McMurrey
Consultores de Investigación Energética, Inc.
Austin (Texas)
27 de abril de 19XX
por Jeffrey D. Lacruz
Este informe examina los reactores de agua ligera como una posible fuente alternativa de energía para Luckenbach, Texas. Se describen ambos tipos de reactores de agua ligera y se presenta una explicación de cómo cada reactor produce electricidad. Los sistemas de seguridad y los aspectos económicos concluyen la discusión principal del informe.
Abstracto descriptivo
Resumen Ejecutivo
Otro elemento común en la cuestión frontal de un informe es un resumen ejecutivo, que también resume los hechos y conclusiones clave que contiene el informe. Su propósito es permitir que un ejecutivo ocupado absorba los principales hallazgos del informe sin tener que atravesar páginas de detalles. Un resumen ejecutivo típico va de media página a dos páginas, pero puede ser más largo si el informe es muy largo.
Tabla de Contenido y Tabla de Figuras
Tabla de Contenidos
Cualquier documento técnico de más de unas pocas páginas que incluya distintas secciones principales debe incluir una tabla de contenido (TdC), y cada sección principal debe comenzar en una nueva página.
La TdC no debe incluir la portada ni la carta/nota de portada. Si la propuesta incluye un resumen abstracto y/o ejecutivo, esas secciones deben aparecer en la TdC, y es costumbre paginarlas con números romanos en minúscula. El TdC no debe incluirse a sí mismo. Trátelo como página cero.
Siempre incluya al menos los dos niveles superiores de encabezados, pero la cantidad de niveles de subtítulo que incluya en una TdC depende de usted. Un informe largo y complejo con múltiples subtítulos puede necesitar una entrada de TdC para cada subtítulo, pero este enfoque puede resultar en un TdC extremadamente largo y confuso. Una solución potencial es crear dos TOC, uno que enumere solo los dos niveles superiores de encabezados y otro que enumere todos los niveles de encabezados.
Una nota final: Asegúrese de que las palabras del TdC sean las mismas que en el texto. Al escribir y revisar, es posible que cambie algunos de los títulos, no olvide actualizar la TdC en consecuencia. Consulte la Figura 3 para ver un ejemplo de un TdC y resumen ejecutivo:
Figura\(\PageIndex{2}\)
Ejemplo descargable de resumen ejecutivo
Tabla de figuras
La tabla de figuras (ToF), a veces llamada “lista de figuras”, tiene muchas de las mismas consideraciones de diseño que la tabla de contenido. Los lectores utilizan el ToF para encontrar las ilustraciones, diagramas, tablas y gráficos en su informe.
Tenga en cuenta que las tablas y figuras son cosas diferentes. Estrictamente hablando, las figuras son ilustraciones, dibujos, fotografías, gráficas y tablas. Las tablas son filas y columnas de palabras y números; no se consideran figuras.
Para informes más largos que contengan múltiples figuras y tablas, cree listas separadas de figuras y tablas. Póngalos en una página separada de la TdC, pero póngalos juntos en la misma página si encajan. Se pueden identificar las listas por separado, como Tabla de Figuras y Tabla de Tablas.
Introducción
En un informe técnico, la introducción prepara al lector para leer el cuerpo principal del informe. Introduce el propósito del informe, especifica la audiencia prevista del informe, proporciona una descripción limitada del contexto y antecedentes del informe, pronostica el alcance del informe y previsualiza el contenido y/o la organización del informe.
Figura\(\PageIndex{3}\)
Ejemplo descargable de introducción
Si la introducción, el resumen ejecutivo y la carta de transmisión le parecen repetitivos, recuerde que los lectores no necesariamente comienzan al principio de un informe y leen página por página hasta el final. Se saltan: pueden escanear el índice; suelen hojear el resumen ejecutivo en busca de hechos y conclusiones clave. Podrán leer atentamente sólo una o dos secciones del cuerpo del informe, para luego omitir el resto. Por estas razones, los informes están diseñados con duplicación masiva para que los lectores estén seguros de ver la información importante sin importar dónde se sumerjan en el informe.
Consideraciones principales de diseño
Esta parte del capítulo describe varios temas relacionados con el diseño que probablemente deba considerar al crear un informe.
Encabezados. 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 permiten a los lectores hojear su informe y sumergirse en aquellos puntos en los que presenta la información que desean.
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.
Símbolos, números y abreviaturas. Las discusiones técnicas normalmente contienen muchos símbolos, números y abreviaturas. Recuerda que las reglas para usar números en contraposición a palabras son diferentes en el mundo técnico. La antigua regla general sobre escribir todos los números por debajo de 10 no siempre se aplica en los informes técnicos.
Gráficos y títulos de figuras. En un reporte técnico, es probable que necesites 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.
Figura\(\PageIndex{4}\)
Referencias cruzadas. Es posible que deba señalar a los lectores información estrechamente relacionada dentro de su informe, o a otros libros e informes que tengan información útil. A estas se les llama referencias cruzadas. Por ejemplo, se puede señalar a los lectores de la discusión de un mecanismo a una ilustración del mismo. Puede apuntar a los lectores a un apéndice donde aparece el fondo sobre un tema (fondo que simplemente no encaja en el texto). Y puede señalar a los lectores fuera de su informe otra información, a artículos, informes y libros que contengan información relacionada con la suya.
Numeración de páginas. Todas las páginas del informe (excluyendo la portada y la contraportada, la portada y la TdC) están numeradas. Use números romanos en minúsculas para paginar el material que aparece antes de la TdC. No numeres el TdC; es la página cero. Use números arábigos para paginar el material que aparece después de la TdC.
Los informes más largos suelen utilizar el estilo de numeración de páginas conocido como enumeración folio-por-capítulo o doble enumeración (por ejemplo, las páginas del Capítulo 2 estarían numeradas 2-1, 2-2, 2-3, y así sucesivamente, y las páginas del Apéndice B estarían numeradas B-1, B-2, etc.). De igual manera, las tablas y figuras usarían este estilo de numeración. Este estilo facilita el proceso de agregar y eliminar páginas.
Si los números de página aparecen en un encabezado en ejecución, no muestre los números en las páginas donde un encabezado o título esté en la parte superior de la página (como abridores de capítulos o secciones).
Conclusiones
Para la mayoría de los informes, deberá incluir una sección final en la que resuma el contenido del informe y proporcione una “comida para llevar” para el lector. Cuando planifique esta sección final de su informe, piense en las funciones que puede desempeñar en relación con el resto del informe.
Apéndices
Un apéndice es una sección “extra” que aparece después del cuerpo principal de la propuesta. Cualquier contenido útil que sientas que es demasiado grande para la parte principal de la propuesta o que creas que distraería e interrumpiría el flujo de la propuesta debería entrar en un apéndice. Ejemplos comunes de material apropiado para el apéndice son 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 principal.
Use apéndices separados para cada ítem o categoría de ítems, y etiquete cada uno alfabéticamente, como “Apéndice A: (título descriptivo del contenido)” y así sucesivamente. Si solo tienes un apéndice, continúa con el esquema de numeración de páginas de la propuesta. Si tiene varios apéndices, puedes numerar las páginas de cada apéndice por separado, como A-1, A-2, y así sucesivamente.
Fuentes de Información
Si su propuesta cita, paráfrasis o resume información proveniente de fuentes externas, cite las fuentes apropiadamente en el texto principal e incluya información bibliográfica en una sección separada al final de la propuesta. Utilice cualquier formato de cita que sea apropiado para la profesión y el campo de su audiencia. Los formatos comunes incluyen IEEE, MLA, APA, CSE, Chicago y Turabian.