Semana 7 Do cumentación técnica Presentación P ara la redacción tradicional, las unidades básicas de información son la oración y el párrafo. Sin embargo, debido a las nuevas necesidades de información breve, concreta y de rápida consulta, la estructura del párrafo no brinda un instrumento preciso y útil que permita organizar y comunicar información técnica compleja. Dado que las unidades básicas crearán la estructura de un documento, el párrafo impone una organización y una presentación imprecisas para muchos documentos técnicos. Para la documentación técnica entonces, se vuelve imprescindible el concepto de unidades de información, las cuales a su vez tienen varias características y especificaciones, mismas que se retomarán en los siguientes párrafos. Objetivos específicos 62 • El alumno identificará las unidades de información, los elementos, características, ventajas y reglas del mapeo de información. Tema y subtemas III Mapeo de información II. III.3 Unidades de información III.4 Mapeo de Información Unida d I I I. Ma peo de información III.3 Unidades de información El método de Mapeo de Información reemplaza al párrafo con unidades de información definidas estrictamente, a las cuales se les llama bloques. A un grupo de bloques reunidos bajo reglas estrictas se le llama mapa. Concepto de mapa Cabe señalar que el uso de la oración se conserva en la documentación técnica en tanto que es una unidad de comunicación efectiva y bien definida. La oración se define como una estructura formada por sujeto, verbo y complemento. Definición de oración Un bloque de información está compuesto de una o más oraciones (o un diagrama, una tabla, una lista, etc.) acerca de un tema determinado. En el método de Mapeo de Información el bloque reemplaza al párrafo. Su contenido se basa en el propósito y función de la información para el lector. Definición de bloque de información Elementos del bloque de información El bloque de información consta de tres elementos: • Una unidad de información que contiene una sola idea principal relevante dirigida a lograr un propósito específico. • Una etiqueta colocada en un lugar destacado que describe el propósito, función, clase de información o contenido del bloque. 63 • Divisiones visibles (generalmente líneas horizontales) que separan cada bloque de los demás. Cada unidad de información de esta página y de cualquier otra de estas notas es un ejemplo de un bloque de información. Cada bloque contiene un fragmento relevante de información y una etiqueta apropiada. Los bloques de información pueden estar organizados de varias formas, por ejemplo: Organización de los bloques de información • únicamente oraciones. • una oración y un diagrama. • una oración y una tabla. A continuación se presentan algunos bloques de información de una compañía acerca de las “Políticas para uso del estacionamiento”. Ejemplo de bloques de información Do cumentación técnica 64 Reglas para desarrollar bloques de información Situación actual La compañía Espacios, S. A. recibió la semana pasada un nuevo lote de espacios del estacionamiento de Keys®. Nueva política Como usted sabe, el largo período de construcción forzó a Espacios a reducir el número de autos permitidos por departamento, en los estacionamientos interiores. A partir del 20 de abril, todos los empleados con tres años o más en Espacios, deben tener una calcomanía en la ventanilla del lado izquierdo, para estacionarse en los niveles A, B y C. Colocación de la calcomanía Coloque la calcomanía en la ventanilla posterior izquierda, como se muestra en la imagen: Dónde estacionarse Estaciónese únicamente en el lugar indicado por su calcomanía: Si su calcomanía es... Estaciónese en el nivel... Azul A Roja B Negra C Existen algunas reglas que se deben aplicar al desarrollar bloques de información. Estas reglas aseguran que los bloques no sean meros párrafos separados por líneas y espacios blancos. Si se siguen dichas reglas pueden crearse bloques que aprovechen la forma en que la gente lee y entiende la información. 1. Incluir únicamente información que tenga un sólo propósito o función para el lector. 2. Excluir toda información irrelevante al propósito o función para el lector, como gráficos excesivos, transiciones o animaciones. 3. Asegurarse de que la etiqueta del bloque refleje con exactitud el propósito, función o contenido del mismo. 4. Separar visualmente todos los bloques para reforzar la percepción de que cada uno de ellos es una unidad diferente de información. 5. Siempre que sea posible, evitar separar un bloque en dos. Unida d I I I. Ma peo de información Las transiciones son también importantes puesto que sirven para pasar de un tema a otro o para introducir un nuevo aspecto. Por ello requieren de su propio bloque con etiquetas tales como: • • • • • Las transiciones en los bloques de información Introducción Visión general Antecedentes Comentario Nota Cada una de estas etiquetas indica al lector la función o clase de información incluida en el bloque. ¿Cuáles podrían ser las consecuencias al no utilizar bloques de transiciones? Al igual que sucede en una oración o en un párrafo, los bloques pueden resultar demasiado grandes y, por lo tanto, ser difíciles de leer y entender. Los escritores que empiezan a usar el método de Mapeo de Información tienen a veces problemas para determinar qué tan grande debe ser un bloque, esto es comprensible ya que un bloque puede incluir desde una simple oración hasta un diagrama elaborado o una tabla. Manejo del tamaño de los bloques de información 65 Un bloque puede constar de: • • • • • • Una a nueve oraciones Un diagrama y sus etiquetas Una ilustración Una tabla Una lista Una combinación de los anteriores Existen tres opciones para manejar el tamaño de los bloques cuando éstos son demasiado extensos: Opciones para el tamaño de los bloques de información 1. Crear bloque(s) nuevo(s): cuando el bloque contenga más de una idea principal o cuando no toda la información tenga relación directa con la etiqueta. 2. Insertar subtítulos: cuando la información esté íntimamente relacionada y no se pueda dividir lógicamente en nuevos bloques. 3. Agregar espacio en blanco: cuando no se pueda dividir. Los subtítulos se escriben subrayados y deben dar una información adicional acerca de la etiqueta del bloque. Las separaciones entre párrafos deben ser de medio renglón, de esa forma se romperá la monotonía de la lectura al alternar los ren- Reglas de formato del bloque de información Do cumentación técnica glones con estos espacios de dimensión diferente. Si bien no hay reglas estrictas acerca de esto, es conveniente procurar que todos los bloques sean más o menos del mismo tamaño ya que la gente asocia un contenido de mayor profundidad o importancia a un bloque más extenso. Sin embargo, de ningún modo debe ampliarse o reducirse la información únicamente por este aspecto. III.4 Mapeo de información Definición de mapa de información Componentes del mapa de información Como el bloque, el mapa es una unidad de información única del Método de Mapeo de Información. Un mapa de información es una colección de bloques de información relevantes acerca de un tema determinado. En algunos casos un mapa puede estar formado solamente por un bloque. Un mapa de información consta de dos elementos: • Bloques relacionados acerca de un tema en particular o un aspecto de un tema. • Un título que describe el contenido. 66 La mayor ventaja del mapa de información es que representa una unidad e información de tamaño intermedio que no se encuentra en la escritura tradicional: un tamaño entre el párrafo y el capítulo o sección. Esto le da al escritor mucha más flexibilidad, también le da al documento una estructura modular más amplia que facilita la actualización. Además, cuando el lector ve la información presentada en un mapa se beneficia de las siguientes características: CARACTERÍSTICAS VENTAJA El título identifica el tema y el propósito del mapa. El título aparece en la parte superior izquierda y destaca más que cualquier otra cosa escrita en la página, excepto un título de mayor jerarquía. El lector identifica inmediatamente el contenido de la página y el motivo del autor para escribirla. La etiqueta del bloque proporciona una visión preliminar del tema de la página o indica el propósito y contenido de la información. El lector identifica inmediatamente el propósito o contenido de cada bloque de información en el mapa. Las líneas horizontales o espacios en blanco “enmarcan” a los bloques de información en la página. El lector sabe de antemano dónde empieza y dónde termina el tema. Así, el lector puede “enmarcar” la información mientras la lee. A continuación se presenta un ejemplo de mapa de información: Unida d I I I. Ma peo de información En este documento En cualquier página de este documento puedes encontrar un mapa de información. Por lo general, los mapas deben ocupar una sola página, aunque en algunos casos es necesario ocupar más. Observaciones Observa que en todas las páginas hay un título principal. Además, hay etiquetas que identifican cada bloque, el cual está dividido por líneas y se procura que el mapa quepa en una página. Ejemplo de un mapa de información Cuando el mapa no cabe en una página, se indica en la parte inferior que continúa en la siguiente página. Cuando esto sucede, en la siguiente página se pone el título y se especifica que continúa. El método Mapeo de Información es una manera estructurada de analizar, organizar y presentar información. También representa una propuesta estructurada para el propio proceso de escribir. Los pasos son: Proceso para mapear información 1. Analizar el proyecto y a los lectores. 2. Identificar temas de conocimiento. 3. Identificar tipos de información. 4. Capturar el contenido. 5. Presentar visualmente la información. 6. Secuenciar la información. 7. Proporcionar medios de acceso. Los mapas de información son diferentes a otras formas de escribir. Esto se debe a que el método de Mapeo de Información aplica las siguientes reglas de formato, basadas en la investigación. 1. El título del mapa debe ser lo más destacado. El título del mapa debe estar en la parte alta y con tipografía grande. Al menos debe tener cuatro puntos más que el cuerpo del texto para que la diferencia sea notable. Justificación: Los títulos de mapas destacados permiten al lector identificar la estructura básica del tema mediante un vistazo rápido. 2. Las etiquetas en el margen deben ser el segundo elemento más destacado. Las etiquetas de los bloques deben ser el segundo elemento más destacado de las páginas, después del título del mapa. Deben ser más notables que el cuerpo general del texto. Justificación: Las etiquetas de los bloques son importantes para dar una organización preliminar al lector y para facilitar la búsqueda de información. Comentario: No se deben subrayar las etiquetas de los bloques ni escribirlas en mayúsculas. El subrayado y muchas mayúsculas dificultan la lectura. 67 Reglas de formato de un mapa de información Do cumentación técnica 3. Cuando sea posible, el mapa debe quedar en una sola página. Organiza cada mapa en una sola página, siempre que esto sea posible. Comentario: Los lectores han sido unánimes en su preferencia por los temas presentados en una sola página. Les gusta la sensación de que toda la información está contenida en la página. Esto, además, facilita la actualización. 4. Si es necesario, indicar que el mapa continúa. Si el mapa continúa en una segunda página, su título debe aparecer en la parte más alta de esa página con la palabra “continúa” después de éste. Las palabras “continúa en la siguiente página” también deben aparecer en la parte baja de la primera página. Justificación: El lector puede ver rápidamente que el tema continúa de la página anterior o que se extiende por varias páginas. 5. Evitar llenar la página. Conserva márgenes anchos (una pulgada o 2.5 cm. en toda la página). Deja suficiente espacio a la izquierda para las etiquetas de los bloques. Justificación: En general, si llenas una página no ganas nada y pierdes legibilidad. 68 6. Orientar todas las páginas en la misma dirección. Las páginas deben ser verticales, siempre que sea posible. Casi todas las tablas horizontales pueden hacerse en forma vertical o bien dividirse en dos páginas. Justificación: El lector no debe tener que voltear el documento de lado para leer un diagrama. Al aplicar los principios y reglas requeridos para crear bloques y mapas de información se obtiene un resultado importante. Este resultado es una estructura visible de información, lo que permite al lector conocer la estructura del tema antes de leer la página. La estructura visible de este método es lo que le da el nombre de Mapeo de Información. Cuando se observa un mapa de carretera, puede verse un área grande que incluye el lugar donde se encuentra y el lugar a donde va. Cuando se está en la carretera, sólo puede verse lo que le rodea. No se tiene la perspectiva necesaria para encontrar la ruta más corta para llegar al destino. Lo mismo sucede con la información, cuando se está dentro de un párrafo, con frecuencia no se sabe hacia dónde va, no se sabe si encontrará la información que necesita ni dónde está. Unida d I I I. Ma peo de información El método Mapeo de Información ofrece títulos de mapa, etiquetas para bloques y una jerarquía consistente que permite localizar la información necesaria de forma rápida y directa. ¿Por qué crees que los bloques deben tener etiquetas? 69 Do cumentación técnica Reactivos de autoevaluación Instrucciones: Escribe en la línea la letra correspondiente, F para falso y V para verdadero. 70 1. En el mapeo de información se usan bloques en lugar de párrafos. _____ 2. El uso de la oración como unidad de comunicación se ha eliminado en el mapeo de información y se ha sustituido por la “etiqueta”. _____ 3. Un bloque de información consta de: unidad de información, etiqueta y divisiones visibles. _____ 4. Cada bloque contiene un fragmento relevante de información y una etiqueta apropiada. _____ 5. Los bloques de información pueden estar organizados solamente de oraciones. _____ 6. Entre las 5 reglas para desarrollar bloques de información se encuentra el excluir toda información irrelevante, incluso transiciones o animaciones de texto. _____ 7. Las transiciones entre la información de bloques (pasar de un tema a otro) no son relevantes, así que pueden omitirse. _____ 8. Un bloque preferentemente no debe tener más de 9 oraciones. _____ 9. Un mapa de información es una colección de bloques de información relevante acerca de un tema determinado. _____ 10. Un mapa de información consta de bloques relacionados acerca de un tema en particular y de un título que describe el contenido. _____ 11. Son siete los pasos del proceso para elaborar mapas de información. _____ 12. Una de las siete reglas de formato indica que las etiquetas de los bloques siempre deben elaborarse en letras mayúsculas. _____ Unida d I I I. Ma peo de información Fuentes de información González, M. (2005). Documentación. México: UNID. 71 Do cumentación técnica Panel de verificación Instrucciones: Escribe en la línea la letra correspondiente, F para falso y V para verdadero. 72 1. En el mapeo de información se usan bloques en lugar de párrafos. _____ V 2. El uso de la oración como unidad de comunicación se ha eliminado en el mapeo de información y se ha sustituido por la “etiqueta”. _____ F 3. Un bloque de información consta de: unidad de información, etiqueta y divisiones visibles. _____ V 4. Cada bloque contiene un fragmento relevante de información y una etiqueta apropiada. _____ V 5. Los bloques de información pueden estar organizados solamente de oraciones. _____ F 6. Entre las 5 reglas para desarrollar bloques de información se encuentra el excluir toda información irrelevante, incluso transiciones o animaciones de texto. _____ V 7. Las transiciones entre la información de bloques (pasar de un tema a otro) no son relevantes, así que pueden omitirse. _____ F 8. Un bloque preferentemente no debe tener más de 9 oraciones. _____ V 9. Un mapa de información es una colección de bloques de información relevante acerca de un tema determinado. _____ V 10. Un mapa de información consta de bloques relacionados acerca de un tema en particular y de un título que describe el contenido. _____ V 11. Son siete los pasos del proceso para elaborar mapas de información. _____ V 12. Una de las siete reglas de formato indica que las etiquetas de los bloques siempre deben elaborarse en letras mayúsculas. _____ F