unidad iii - moodle2.unid.edu.mxmoodle2.unid.edu.mx/dts_cursos_mdl/uni/rh/dt/dts08/... ·...
TRANSCRIPT
Asignatura: Documentación Técnica
Licenciatura en Derecho 2
Unidad III: Mapeo de información
Semana 8
A. PRESENTACIÓN
Una práctica indispensable en la elaboración de documentación técnica es asociar etiquetas a cada uno de
los bloques de información, a efecto de establecer puntos de identificación inmediata y con fines de consulta.
Las etiquetas deben caracterizarse por su claridad al ofrecer al lector una idea precisa sobre la idea
expresada en cada bloque.
Las etiquetas se clasifican en varios tipos, dependiendo de la función que llevan a cabo. A continuación se
explicará las diferentes clases de etiquetas, reglas de uso y algunas sugerencias para su elaboración al
respecto.
B. OBJETIVO ESPECÍFICO
El alumno identificará los tipos de etiquetas de bloques, sus elementos y las reglas para su aplicación.
Asignatura: Documentación Técnica
Licenciatura en Derecho 3
C. TEMA Y SUBTEMAS
3. MAPEO DE INFORMACIÓN
3.5 Etiquetas de bloques.
D. MAPA MENTAL: UNIDAD III
Asignatura: Documentación Técnica
Licenciatura en Derecho 4
E. CONTENIDO
3.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, antes de otra cosa.
Otra idea importante es etiquetar cada bloque (una vez desarrollado o
bosquejado) para que el lector pueda ver de una ojeada la estructura del
documento.
Etiquetas
Hay tres clases de etiquetas de bloques:
Etiquetas independientes del tema.
Etiquetas específicas del tema.
Etiquetas combinadas.
Reglas para etiquetar bloques
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?
Los escritores deben crear etiquetas útiles para los bloques, a través de las
siguientes reglas:
1. Escribe etiquetas que describan con precisión el contenido del bloque.
2. Conserva las etiquetas cortas y concisas.
3. Conserva un vocabulario consistente en la etiqueta y en el bloque.
4. Usa palabras familiares para el lector, en lugar de la “jerga” o términos
técnicos.
Excepción: Usa un término técnico si sabes que los lectores lo
entienden y prefieren su uso porque es más adecuado y descriptivo
que un término común.
¿Por qué una etiqueta debe ser corta y concisa?
Asignatura: Documentación Técnica
Licenciatura en Derecho 5
5. Evita etiquetas graciosas, tramposas o triviales.
6. Conserva 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 uses frases de transición como “Por otro lado” o etiquetas seguidas
de puntos suspensivos (...).
Comentario: Coloca la información secundaria o información sobre
cómo los bloques se relacionan entre sí, en bloques como “Visión
general”, “Introducción”, “Antecedentes” o “Comentarios”.
8. Usa preguntas o frases cuando sea apropiado.
Ejemplos:
¿Dónde están las respuestas?
¿Qué ayuda está disponible?
Resultados medibles.
Ejerza sus derechos.
Etiquetas independientes del tema
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.
Ejemplo 1: Escrito de negocios
En seguida se enlistan algunas etiquetas independientes del tema que pueden
aparecer en comunicados de negocios:
Problema.
Antecedentes.
Método de análisis.
Solución.
Criterio.
Asignatura: Documentación Técnica
Licenciatura en Derecho 6
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.
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. Esta 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
Asignatura: Documentación Técnica
Licenciatura en Derecho 7
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 y aumentan la
comprensión del lector.
Etiquetas específicas 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.
Regla
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.).
Ejemplo 1: Capacitación para usar la computadora
El borrador de un curso de capacitación para usar una computadora puede
incluir estas etiquetas sobre el tema:
Unidad de proceso central.
Lenguaje de computadora.
Monitor.
Teclado.
Cursor.
¿Por qué escribiría esto el autor? Importancia
Justificación
Propósito
Objetivo
Asignatura: Documentación Técnica
Licenciatura en Derecho 8
Ejemplo 2: Habilidades gerenciales
Las etiquetas sobre el tema de habilidades gerenciales pueden ser:
Manejo de quejas.
Actitud de los empleados.
Motivación.
Desarrollo profesional.
Etiquetas combinadas
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
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.
Debe tratarse de que la parte de las etiquetas independientes del tema indique
la semejanza entre los bloques y la parte específica resalte sus diferencias.
Ejemplo
Un ejemplo de dos etiquetas relacionadas es:
Alternativa 1: mercado de dinero.
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
1. Las etiquetas combinadas deben ser cortas, de seis palabras cuando
mucho.
Asignatura: Documentación Técnica
Licenciatura en Derecho 9
2. Generalmente las etiquetas combinadas concuerdan con otras dentro
del mismo mapa o mapas relacionados.
Visión general de los tipos de información
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 trabajos escritos
referentes a los documentos técnicos requieren de un conocimiento teórico de
los tipos de información.
Los siete tipos básicos de información
Los tipos de información son siete 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.
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 cómo 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?
Principio Enunciado sobre lo que debe hacerse (leyes, políticas, normas); lo que
está dado (generalizaciones); o lo que se supone. Responde a la
Asignatura: Documentación Técnica
Licenciatura en Derecho 10
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?
Ejemplos de cada tipo de información
Los siete tipos de información se ejemplifican en la siguiente tabla.
Tipo de Información 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.
Asignatura: Documentación Técnica
Licenciatura en Derecho 11
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 en cada uno de los siete tipos de
información?
Asignatura: Documentación Técnica
Licenciatura en Derecho 12
F. CONCLUSIÓN
En un documento técnico, el uso de etiquetas permite identificar fácil y rápidamente puntos específicos de
información, lo cual agiliza la consulta dentro del texto.
Para la inclusión de etiquetas que identifiquen a cada bloque de información, existen reglas y
recomendaciones para su adecuada elaboración y correcto uso, sin embargo, la idea fundamental es que una
etiqueta debe describir breve y claramente el contenido principal de un bloque de información.
Asignatura: Documentación Técnica
Licenciatura en Derecho 13
G. LECTURAS COMPLEMENTARIAS
Martinez, D. (2008). Technical writing: A reference for technical writers at all levels. New York: Kaplan
Pub.
H. GLOSARIO
Término Significado
Clasificación Es la distribución de elementos en grupos o clases, con
base en las características que tienen en común.
Concepto Es la representación o idealización de un objeto.
Consulta Se refiere a la acción de búsqueda y recuperación de
datos e información específica.
Procedimiento Se refiere a un método sistemático para realizar una
tarea.
Proceso Es un conjunto de etapas o fases secuenciales, ya sea
de origen artificial o de un fenómeno natural.