Está en la página 1de 18

DOCUMENTACIÓN TÉCNICA

Sesión 4 Nuevas Unidades de


Información

Lección 4.1 Introducción

Objetivo
En esta sesión aplicarás los conceptos de “bloque” y “mapa” en la elaboración
de documentos técnicos efectivos.

Contenido de la
sesión

Figura 4-1 Contenido de la sesión

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 61 


DOCUMENTACIÓN TÉCNICA

Lección 4.2 Visión general de las nuevas unida-


des

Introducción
La metodología de Mapeo de Información se basa en los principios presentados
en la sesión anterior. La aplicación rigurosa de estos principios es crítica en la
creación de documentos efectivos.
Sin embargo, para traducir estos principios en acciones y pasar de la teoría a la
práctica, se han desarrollado nuevas unidades de información que encierran los
principios básicos.

El párrafo
resulta inade-
cuado
En la redacción tradicional las unidades básicas de información son la oración y
el párrafo. No obstante, la definición de párrafo es demasiado ambigua como pa-
ra brindar un instrumento preciso y útil que permita organizar y comunicar in-
formació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 documen-
tos técnicos.

Bloques y
Mapas
El método de Mapeo de Información reemplaza al párrafo con unidades de in-
formación definidas estrictamente y llamadas bloques.
A un grupo de bloques reunidos bajo reglas estrictas se le llama mapa.

Nota
Conservamos la oración porque es una unidad de comunicación efectiva y bien
definida. La oración se define como una estructura formada por sujeto, verbo y
complemento.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 62 


DOCUMENTACIÓN TÉCNICA

En esta sesión

En esta sesión se verán los siguientes temas:

• El bloque de información.
• Ejemplos de bloques de información.
• Reglas para desarrollar bloques de información.
• Manejo del tamaño del bloque.
• El Mapa de Información.
• Ejemplo de un mapa de información.
• Reglas de formato.
• Resultado: una estructura visible.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 63 


DOCUMENTACIÓN TÉCNICA

Lección 4.3 El bloque de información

Definición
Un bloque de información es 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 con-
tenido se basa en el propósito y función de la información para el lector.

Componentes

El bloque de información consta de tres elementos:

• una unidad de información que tiene una sola idea principal relevante dirigi-
da a lograr un propósito específico,
• una etiqueta colocada en un lugar destacado que describe el propósito, fun-
ción, clase de información o contenido del bloque y
• divisiones visibles (generalmente líneas horizontales) que separan cada blo-
que de los demás.

Ejemplos
Hay ejemplos de bloques de información en la página siguiente. Observa que los
bloques constan de:
• oraciones únicamente,
• una oración y un diagrama o
• una oración y una tabla.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 64 


DOCUMENTACIÓN TÉCNICA

Lección 4.4 Ejemplos de bloques de Información

Introducción
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 re-
levante de información y una etiqueta apropiada.

Ejemplos
A continuación se presentan algunos bloques de información que un escritor rea-
lizó acerca de las Políticas para Uso del Estacionamiento.

Situación actual

La compañía Patito, S. A. recibió la semana pasada un nuevo lote de es-


pacios de estacionamiento de Ranver.

Nueva política

Como usted sabe, el largo período de construcción forzó a Patito a redu-


cir el número de autos permitidos por departamento, en los estaciona-
mientos interiores.
A partir del 15 de abril, todos los empleados con tres años o más en Pati-
to, 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:

Continúa en la siguiente página

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 65 


DOCUMENTACIÓN TÉCNICA

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
Blanca B
Café C

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 66 


DOCUMENTACIÓN TÉCNICA

Lección 4.5 Reglas para desarrollar bloques de in-


formación

Introducción
Existen algunas reglas que se deben aplicar al desarrollar bloques de informa-
ció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.

Reglas
Sigue estas reglas para desarrollar bloques efectivos:

1. Incluye únicamente información que tenga un sólo propósito o función pa-


ra el lector.
2. Excluye toda información irrelevante al propósito o función para el lector,
como gráficos excesivos, transiciones o animaciones.
3. Asegúrate de que la etiqueta del bloque refleje con exactitud el propósito,
función o contenido del mismo.
4. Separa 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, evita separar un bloque en dos o más páginas. Si
la idea es demasiado extensa, probablemente debe fragmentarse.

Dónde
poner la otra
información
Incluye la información transicional en bloques separados con su propia etiqueta.
Si la información que no encaja en el bloque no tiene una función clara para el
lector, deséchala.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 67 


DOCUMENTACIÓN TÉCNICA

Las transiciones

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:

• Introducción
• Visión general
• Antecedentes
• Comentario
• Nota

Observa que cada una de estas etiquetas indica al lector la función o clase de in-
formación incluida en el bloque.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 68 


DOCUMENTACIÓN TÉCNICA

Lección 4.6 Manejo del tamaño del bloque

Introducción
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, pro-
blemas 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 ela-
borado o una tabla.

Variaciones de
los bloques
Un bloque puede constar de:

• una a nueve oraciones,


• un diagrama y sus etiquetas,
• una ilustración,
• una tabla,
• una lista o
• una combinación de los anteriores.

Tres opciones

Existen tres opciones para manejar el tamaño de los bloques cuando éstos son
demasiado extensos:

1. Crea 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. Inserta subtítulos: Cuando la información esté íntimamente relaciona-
da y no se pueda dividir lógicamente en nuevos bloques.
3. Agrega espacio en blanco: Cuando no se pueda dividir el bloque de
otra manera y adviertas que la densidad del texto cansará al lector.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 69 


DOCUMENTACIÓN TÉCNICA

Reglas de
formato
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 renglones 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 con-
tenido de mayor profundidad o importancia a un bloque más extenso. Sin em-
bargo, de ningún modo debe ampliarse o reducirse la información únicamente
por este aspecto.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 70 


DOCUMENTACIÓN TÉCNICA

Lección 4.7 Ejemplos de cómo manejar el tamaño


de bloque

Introducción
A continuación se presenta un ejemplo de cada una de las tres opciones para
manejar el tamaño de los bloques.

Opción 1:
Crear un
bloque
nuevo
En este ejemplo, el escritor decidió que había suficiente información diferente
para formar un bloque nuevo:

ANTES:

Definición de un plan de negocio

Existe un propósito para el plan de negocio. El plan


ayuda a guiar a los gerentes en el proceso de toma de
decisiones y ayuda a posicionar correctamente a la
compañía. El plan en sí es un documento escrito que
define qué es la compañía y cuáles son sus metas. La
mayoría de los planes de negocio se componen de
secciones estratégicas y tácticas.

DESPUÉS:

Definición de un plan de negocio

Un plan de negocio es un documento que define qué


es la compañía y cuáles son sus metas. El plan se
compone, generalmente, de secciones estratégicas y
tácticas.

Propósito de un plan

Un plan de negocio establece metas y ayuda a posi-


cionar a la compañía. Al hacer esto, el plan ayuda a
los gerentes en el proceso de toma de decisiones.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 71 


DOCUMENTACIÓN TÉCNICA

Opción 2:
Insertar
subtítulos
A veces la información de un bloque está estrechamente relacionada y es ilógico
separarla en bloques diferentes. Sin embargo, puede haber suficientes diferen-
cias en el contenido del bloque para que se requiera una estructura adicional. En
esos casos el escritor puede agregar subtítulos. Los subtítulos se escriben subra-
yados y deben dar una información adicional acerca de la etiqueta del bloque.

ANTES:

Inscripción para
jugar basquetbol
Nuestra nueva liga de basquetbol empezará a jugar el
primero de julio. Todos aquellos que quieran jugar
deberán inscribirse. Los empleados del primer turno
que quieran jugar deberán ponerse en contacto con
Óscar Caballero a más tardar el 25 de junio. Los em-
pleados del segundo y tercer turno que quieran jugar
deberán ponerse en contacto con Anabel Moreno el
27 de junio.

DESPUÉS:

Inscripción para
jugar basquetbol
Nuestra nueva liga de basquetbol empezará a jugar el
primero de julio. Todos aquellos que quieran jugar
deberán inscribirse.
Primer turno: Los empleados que quieran jugar de-
berán ponerse en contacto con Óscar Caballero a más
tardar el 25 de junio.
Segundo y tercer turno: Los empleados de seguridad
y tercer turno que quieran jugar deberán ponerse en
contacto con Anabel Moreno a más tardar el 27 de
junio.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 72 


DOCUMENTACIÓN TÉCNICA

Opción 3:
Agregar
espacio en
blanco
En ocasiones, en un bloque bien escrito se encuentran varias oraciones íntima-
mente relacionadas y no se puede agregar un subtítulo. En este tipo de bloques el
escritor puede agregar espacio en blanco para que el texto “denso” sea más fácil
de leer. El espacio en blanco debe ser significativamente menor a un renglón,
por ejemplo, la mitad del tamaño en puntos de la letra. El siguiente ejemplo ilus-
tra el uso de espacio en blanco.

ANTES:

Ahorro potencial
de tiempo
Generalmente los empleados usan búsquedas manua-
les para hacer sus investigaciones. Estas búsquedas
tardan entre quince minutos y seis o siete horas. Una
búsqueda en línea puede proporcionar la misma in-
formación en un tiempo entre cinco minutos y dos
horas. Esta reducción en el tiempo de búsqueda libe-
ra al empleado para realizar un trabajo más creativo.
Puede obtener la información que desea sin interrup-
ciones en el proceso de pensar. Además, la exactitud
de la búsqueda en computadora es mayor que la de
una búsqueda manual.

DESPUÉS:

Ahorro potencial
de tiempo
Generalmente los empleados usan búsquedas manua-
les para hacer sus investigaciones. Estas búsquedas
tardan entre quince minutos y seis o siete horas. Una
búsqueda en línea puede proporcionar la misma in-
formación en un tiempo entre cinco minutos y dos
horas.
Esta reducción en el tiempo de búsqueda libera al
empleado para realizar un trabajo más creativo. Pue-
de obtener la información que desea sin interrupcio-
nes en el proceso de pensar. Además, la exactitud de
la búsqueda en computadora es mayor que la de una
búsqueda manual.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 73 


DOCUMENTACIÓN TÉCNICA

Lección 4.8 El mapa de información

Introducción
Al igual que el bloque, el mapa es una nueva unidad de información única del
Método de Mapeo de Información.

Definición
Un mapa de información es una colección de bloques de información relevan-
tes acerca de un tema determinado.
Nota: En algunos casos un mapa puede estar formado por un solo bloque.

Componentes
Un mapa de información consta de dos elementos:
Bloques relacionados acerca de un tema en particular o un aspecto de un tema y
Un título que describe le contenido común de los bloques y/o el propósito para escribir todos los
bloques

Características
y ventajas
La mayor ventaja del mapa de información es que representa una unidad y ven-
tajas de 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 escri-
tor mucha más flexibilidad. También le da al documento una modularidad más
amplia que facilita la actualización. Además, cuando el lector ve la información
presentada en un mapa, aprovecha las siguientes características:

Características Ventaja
El título del mapa identifica el tema y el El lector conoce inmediatamente el
propósito del mapa. El título aparece en la contenido de la página y el motivo que
parte superior izquierda y es más destaca- tuvo el autor para escribirla.
do que cualquier otra cosa escrita en la
página, excepto un título de mayor jerarqu-
ía.
La etiqueta del bloque proporciona una El lector conoce inmediatamente el
visión preliminar del tema de la página o propósito o contenido de cada bloque
indica el propósito y contenido de la in- de información en el mapa.
formación.
Las líneas horizontales o espacios en El lector sabe de antemano dónde em-
blanco “enmarcan” a los bloques de in- pieza y dónde termina el tema. Al saber
formación en la página. esto, el lector puede “enmarcar” la
información mientras la lee.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 74 


DOCUMENTACIÓN TÉCNICA

Lección 4.9 Ejemplo de un mapa de información

En este
documento
En cualquier página de este documento puedes encontrar un mapa de informa-
ció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, cada bloque está dividido por líneas y se procura
que el mapa quepa en una página. Cuando el mapa no cabe en una página, se in-
dica 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.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 75 


DOCUMENTACIÓN TÉCNICA

Lección 4.10 Reglas de formato

Introducción
Puedes notar que los mapas de información se ven diferentes a otras formas de
escribir. Esto se debe a que el método de Mapeo de Información aplica las si-
guientes reglas de formato, basadas en la investigación.

Reglas
1. Haz que el título del mapa sea lo más destacado. El título del mapa debe es-
tar en la parte alta y con la tipografía más negra y más grande. Al menos de-
be 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. Haz que las etiquetas en el margen sean 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 or-
ganización preliminar al lector y para facilitar la búsqueda de información.
Comentario: No subraye las etiquetas de los bloques ni las escriba en
mayúsculas. El subrayado y muchas mayúsculas dificultan la lectura.

3. Cuando sea posible, haz que el mapa quede 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 infor-
mación está contenida en la página. Esto, además, facilita la actualización.

4. Si es necesario, indica que el mapa continúa. Si el mapa continúa en una se-


gunda 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 él. 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 se extiende por varias páginas.

Continúa en la siguiente página

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 76 


DOCUMENTACIÓN TÉCNICA

5. Trata de no 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 etique-
tas de los bloques.
Justificación: En general, si llenas una página no ganas nada y pierdes legi-
bilidad.

6. Orienta todas las páginas en la misma dirección. Las páginas deben ser ver-
ticales, 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.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 77 


DOCUMENTACIÓN TÉCNICA

Lección 4.11 Resultado: Una estructura visible

Resultado
importante
Obtenemos un resultado importante al aplicar los principios y reglas que hemos
discutido para crear bloques y mapas de información. Este resultado es una es-
tructura visible de información.

Ventaja
Una estructura visible de información permite al lector conocer la estructura del
tema al ver la página antes de leerla.

Analogía
La estructura visible de este método 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 dónde va.
Cuando estás en la carretera, sólo puedes ver lo que le rodea. No tienes la pers-
pectiva que necesitas para encontrar la ruta más corta para llegar a su destino.
Lo mismo es cierto para la información. Cuando uno está dentro de un párrafo,
con frecuencia no sabe a dónde va. Uno no sabe si va a encontrar la información
que necesita y, en tal caso, dónde está.
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.

MAESTRÍA EN TECNOLOGÍAS DE INFORMACIÓN - PÁGINA 78 

También podría gustarte