Presentación Tema y subtemas Objetivos específicos

Presentación Tema y subtemas Objetivos específicos

Semana 8
Unida d I I I. Ma peo de información
Presentación
U
n elemento importante de la documentación técnica es colocar etiquetas a
los bloques de información como un punto de identificación rápido en su
consulta. Las etiquetas deben ser muy claras para dar una verdadera idea al lector acerca de lo que contiene el bloque. Existen varios tipos de etiquetas según la
función que desempeñen, así como una serie de reglas y recomendaciones para
realizarlas. Enseguida se comentarán los tipos de etiquetas, los elementos para elaborarlas y algunos ejemplos al respecto.
Objetivos específicos
• El alumno identificará los tipos de etiquetas de bloques, sus elementos y las reglas
para su aplicación.
Tema y subtemas
III Mapeo de información
II.
III.5
Etiquetas de bloques
73
Do cumentación técnica
III.5 Etiquetas de bloques
Una idea clave del método Mapeo de Información consiste en comenzar a bosquejar bloques sin preocuparse al principio por etiquetar o escribir párrafos, es decir,
identificar el tipo de bloque y sus características. Otra idea importante es etiquetar
cada bloque (una vez desarrollado o bosquejado) para que el lector pueda identificar la estructura del documento.
Tipos de etiquetas de
bloques de información
Hay tres clases de etiquetas de bloques:
• Etiquetas independientes del tema.
• Etiquetas específicas del tema.
• Etiquetas combinadas.
Una etiqueta debe hacer que el propósito del bloque sea inmediatamente claro
para el lector. Una etiqueta debe contestar a la pregunta: ¿qué va a decir este bloque?
Reglas para etiquetar
bloques
74
Los escritores deben crear etiquetas útiles para los bloques, a través de las siguientes reglas:
1. Escribir etiquetas que describan con precisión el contenido del bloque.
2. Conservar las etiquetas cortas y concisas.
3. Conservar un vocabulario consistente en la etiqueta y en el bloque.
4. Usar palabras familiares para el lector, en lugar de la “jerga” o términos
técnicos. Excepción: se puede usar un término técnico que los lectores
lo entienden y prefieren porque es más adecuado y descriptivo que un
término común.
5. Evitar etiquetas graciosas, tramposas o triviales.
6. Conservar el lenguaje apropiado al significado real y a la importancia del
bloque. Ejemplo: “Comentario” es una buena etiqueta para un bloque que
contiene información opcional. “Precaución” o “Importante recordar” son
buenas etiquetas para bloques que contienen información significativa.
7. No usar frases de transición como “Por otro lado” o etiquetas seguidas de
puntos suspensivos (...). Comentario: colocar la información secundaria
o información sobre cómo se relacionan los bloques entre sí, en bloques
como “Visión general”, “Introducción”, “Antecedentes” o “Comentarios”.
8. Usar preguntas o frases cuando sea apropiado. Ejemplos:
•
•
•
•
¿Dónde están las respuestas?
¿Qué ayuda está disponible?
Resultados medibles
Ejerza sus derechos
¿Por qué crees que una etiqueta debe ser corta y concisa?
Unida d I I I. Ma peo de información
Una etiqueta independiente del tema es apropiada para bloques de información general, es decir, información que puede aplicarse a cualquier negocio,
empresa, organización o tema.
Etiquetas
independientes del
tema
Ejemplo 1: Escrito de negocios. En seguida se enlistan algunas etiquetas
independientes del tema que pueden aparecer en comunicados de negocios:
Ejemplos de etiquetas
independientes
•
•
•
•
•
•
•
Problema
Antecedentes
Método de análisis
Solución
Criterio
Consecuencias
Costo
Estas etiquetas son independientes del tema, pueden utilizarse en cualquier
empresa y casi para cualquier tema.
Ejemplo 2: Todos los manuales. Los siguientes son algunos tipos de etiquetas independientes del tema que pueden aparecer en casi cualquier manual de
capacitación o procedimiento:
•
•
•
•
Definición
Ejemplo
Introducción
Procedimiento
75
Ejemplo 3: Hacer preguntas. Con frecuencia, la mejor manera de crear etiquetas independientes del tema es analizar qué es lo que el lector se puede preguntar. Las respuestas a estas preguntas se transforman en etiquetas de bloque. La
siguiente tabla resume algunas de estas preguntas:
PREGUNTAS DEL LECTOR
PISTAS PARA GENERAR ETIQUETAS
¿Cuál es el propósito o la función de x?
El propósito (función) de x
¿Qué clase de información es ésta?
• Procedimiento
• Proceso
• Estructura
• Concepto
• Principio
• Clasificación
¿Cómo puedo utilizar esta información?
• Definición
• Ejemplo
• Introducción
• Antecedentes
¿Por qué escribiría esto el autor?
• Importancia
• Justificación
• Propósito
• Objetivo
Do cumentación técnica
La identificación precisa de las etiquetas independientes del tema representa
una parte importante de la propuesta de escritura. En cualquier documento, las
etiquetas independientes del tema aseguran consistencia aumentando la comprensión del lector.
Definición de etiqueta
específica del tema
Una etiqueta específica del tema es un término, frase u oración que se deriva
del tema de un bloque particular. Para crear etiquetas específicas efectivas se debe
preguntar:
1. ¿De qué se trata? (La respuesta dará una posible etiqueta para el bloque)
2. ¿Qué dice al respecto? (La respuesta dará una etiqueta más específica que
la pregunta anterior)
Ejemplos de etiquetas
específicas
El borrador de un curso de capacitación para usar una computadora puede
incluir estas etiquetas sobre el tema:
•
•
•
•
•
76
Las etiquetas sobre el tema de habilidades gerenciales pueden ser:
•
•
•
•
Características de las
etiquetas combinadas
Unidad de proceso central
Lenguaje de computadora
Monitor
Teclado
Cursor
Manejo de quejas
Actitud de los empleados
Motivación
Desarrollo profesional
Una etiqueta combinada contiene las siguientes partes:
• Una etiqueta independiente del tema (eit)
• Una etiqueta específica del tema (eet)
La parte correspondiente a la eit relaciona el bloque con otro semejante para
facilitar la búsqueda e indica su propósito o función. La correspondiente a la eet
resalta el contenido que se encuentra dentro del bloque.
Aplicación de las
etiquetas combinadas
Algunos temas se dividen fácilmente en subtemas paralelos. Una buena manera de presentarlos es crear un bloque para cada subtema y poner a los nuevos
bloques etiquetas combinadas.
Ejemplo de etiquetas
combinadas
Se debe cuidar que la parte de las etiquetas independientes del tema indique
la semejanza entre los bloques y que la parte específica resalte sus diferencias. Por
ejemplo:
• Alternativa 1: mercado de dinero
Unida d I I I. Ma peo de información
• Alternativa 2: cuentas de ahorro
La eit “Alternativa” brinda consistencia y resalta la semejanza entre bloques
en cambio, la eet “mercado de dinero” o “cuentas de ahorro” resalta la diferencia
entre ambos.
Las reglas de las etiquetas combinadas son:
Reglas de las etiquetas
combinadas
1. Las etiquetas combinadas deben ser cortas, de seis palabras cuando mucho.
2. Generalmente, concuerdan con otras dentro del mismo mapa o mapas
relacionados.
Tipos de información
Es esencial identificar el tipo de información para seguir correctamente el método Mapeo de Información, independientemente del tipo de documentación que se
debe escribir. Prácticamente todos los trabajos escritos referentes a los documentos
técnicos requieren de un conocimiento teórico de los tipos de información.
Visión general de los
tipos de información
Los tipos de información se dividen en siete categorías básicas dentro de las
cuales puede colocarse toda la información, tomando como punto de partida el
propósito fundamental para el lector.
Tipos básicos de
información
PREGUNTAS DEL
LECTOR
PISTAS PARA GENERAR ETIQUETAS
Procedimiento
Conjunto de pasos que una persona (o equipo) realiza para
obtener un resultado específico. Incluye las decisiones que se
deben tomar. Responde a la pregunta ¿cómo hacer?
Proceso
Serie de cambios que se dan en un lapso de tiempo para
lograr algún propósito.
Describen lo que pasa durante fases de tiempo o la forma
como trabaja algo.
(La mayoría de las ciencias tratan sobre descripciones de
procesos).
Responde a la pregunta: ¿cómo funciona?
Estructura
Es algo físico o que puede dividirse en partes que tienen límites físicos o identificables.
Responde a la pregunta: ¿cómo está hecho? o ¿cuáles son sus
partes?
Concepto
Grupo de objetos físicos, condiciones, relaciones, eventos
o ideas que comparten una combinación única de atributos
críticos, no compartidos por otros grupos y que pueden representarse por una o más palabras o símbolos. Responde a la
pregunta: ¿qué es? o ¿cómo se define?
77
Do cumentación técnica
Ejemplos de cada tipo
de información
Principio
Enunciado sobre lo que debe hacerse (leyes, políticas, normas), lo que está dado (generalizaciones) o lo que se supone.
Responde a la pregunta: ¿cuáles son las reglas? o ¿de dónde
se parte?
Hecho
Enunciado que se presenta sin evidencias que lo apoyen. Los
ejemplos pueden incluir: símbolos, medidas, fechas asociadas
con eventos y resultados experimentales. Responde a la pregunta: ¿qué sucede? o ¿qué sucedió?
Clasificación
Distribución de un grupo de elementos en clases o categorías,
usando uno o más factores de distribución. Responde a la
pregunta: ¿qué tipos hay? o ¿cómo se divide?
Los siete tipos de información se ejemplifican en la siguiente tabla.
TIPOS DE
INFORMACIÓN
78
EJEMPLOS
Procedimiento
Pasos para inscripción
Procedimiento administrativo
Procedimiento penal
Proceso
Proceso de digitalización
Proceso digestivo
Proceso electoral
Estructura
Estructura de un sitio web
Estructura atómica
Organigrama de una empresa
Concepto
Concepto de libertad
Definición de código fuente abierto
Qué se entiende por ciencia
Principio
Principio de Arquímedes
Regla de los tercios en fotografía
Políticas de nuestra empresa
Hecho
Antecedentes de la organización
Velocidad del microprocesador
Características de la PC
Clasificación
Clasificación de los virus
Taxonomía de Bloom
Categorías de software comercial
¿Puedes proponer un ejemplo de cada uno
de los siete tipos de información?
Unida d I I I. Ma peo de información
Reactivos de autoevaluación
Instrucciones: Escribe en la línea la letra correspondiente, F para falso y V para verdadero.
1. Etiquetar un bloque se refiere al hecho de leer el texto y colocar un nombre adecuado
a esa sección.
_____
2. Son 8 las reglas generales para elaborar etiquetas útiles para los bloques.
_____
3. Al elaborar una etiqueta debe evitarse que sean graciosas, tramposas o triviales.
_____
4. Una etiqueta independiente del tema es apropiada para bloques de información específica. _____
5. Una de las preguntas que el escritor técnico debe hacerse para elaborar etiquetas
independientes es: ¿en qué programa de cómputo se elaborará el documento?
_____
6. Para elaborar una etiqueta específica del tema vale la pena preguntarse con respecto al texto,
¿de qué se trata?
_____
7. Las etiquetas combinadas deben ser cortas, de seis palabras cuando mucho.
_____
79
8. Los tipos de información son seis categorías básicas dentro de las cuales puede colocarse
toda la información, tomando como punto de partida su propósito fundamental para
el lector.
_____
9. Descripción, narración y análisis son tres de los tipos de información en que se engloban
los mapas de información.
_____
10. El tipo de información “Hecho” es un enunciado que se presenta sin evidencias que
lo apoyen.
_____
Do cumentación técnica
Fuentes de información
González, M. (2005). Documentación. México: UNID.
80
Unida d I I I. Ma peo de información
Panel de verificación
Instrucciones: Escribe en la línea la letra correspondiente, F para falso y V para verdadero.
1. Etiquetar un bloque se refiere al hecho de leer el texto y colocar un nombre adecuado
a esa sección.
V
_____
2. Son 8 las reglas generales para elaborar etiquetas útiles para los bloques.
V
_____
3. Al elaborar una etiqueta debe evitarse que sean graciosas, tramposas o triviales.
V
_____
F
4. Una etiqueta independiente del tema es apropiada para bloques de información específica. _____
5. Una de las preguntas que el escritor técnico debe hacerse para elaborar etiquetas
independientes es: ¿en qué programa de cómputo se elaborará el documento?
F
_____
6. Para elaborar una etiqueta específica del tema vale la pena preguntarse con respecto al texto,
V
¿de qué se trata?
_____
7. Las etiquetas combinadas deben ser cortas, de seis palabras cuando mucho.
V
_____
81
8. Los tipos de información son seis categorías básicas dentro de las cuales puede colocarse
toda la información, tomando como punto de partida su propósito fundamental para
el lector.
F
_____
9. Descripción, narración y análisis son tres de los tipos de información en que se engloban
los mapas de información.
F
_____
10. El tipo de información “Hecho” es un enunciado que se presenta sin evidencias que
lo apoyen.
V
_____