Presentación Tema y subtemas Objetivos específicos

Transcripción

Semana 9
Do cumentación técnica
Presentación
P
ara dar forma a la estructura de un documento técnico, es preciso identificar
cuál es la información clave y agruparla en bloques, para ello, se ubica el tipo
de información con la que se cuenta, los bloques a elaborar y los tipos de mapas en
los que se colocarán.
En los siguientes párrafos se detallan los tipos de información y bloques clave
a emplear en distintos mapas de información como el de procedimiento, proceso,
estructura, concepto, principio y clasificación. Según sea el tipo de mapa, será la
forma en que se organicen sus bloques.
Objetivos específicos
82
• El alumno identificará la importancia de los tipos de información y bloques claves
en el mapeo de información.
• El alumno analizará las reglas para aplicar los bloques clave en cualquier tipo de
texto.
Tema y subtemas
III Mapeo de información
II.
III.6
Tipos de información y bloques clave
Unida d I I I. Ma peo de información
III.6 Tipos de información y bloques
clave
Los conceptos de tipos de información y bloques clave son esenciales para el método Mapeo de Información. Cuando se aplican para escribir todo tipo de documentación permiten a los escritores reunir, analizar, organizar y presentar información. Estos dos conceptos y las reglas para aplicarlos son apropiados para escribir cualquier tipo de información, sin importar qué tan compleja o técnica sea.
Aplicación de los
tipos de información y
bloques clave
La mayoría de los trabajos escritos con este método de escritura requieren
tanto de un conocimiento teórico de los tipos de información, como de una habilidad práctica para esbozar los bloques clave.
Bloques clave
Los bloques clave son bloques de información que ayudan al escritor a recopilar
y analizar el contenido crítico y lo presentan de la manera más adecuada para el
lector. A cada tipo de información se asocian uno o más bloques clave. El bloque
clave es el más importante del mapa y contiene la información fundamental, el
resto de los bloques se llaman bloques de apoyo y auxilian a la mejor comprensión del contenido del bloque clave.
Definición de bloques
clave
Existen bloques clave específicos asociados a cada uno de los siete tipos de
información y también algunas reglas para esbozar bloques clave.
Bloques clave en
relación con los tipos de
información
83
A continuación se describen a detalle los tipos de información y los bloques
clave asociados a ellos, pero antes analicemos el siguiente ejemplo.
Un escritor que tomó un seminario de Mapeo de Información necesitaba escribir un instructivo para armar aparatos de sonido. El escritor estaba familiarizado con los bloques clave y usó este conocimiento para analizar el proyecto y
determinar dónde empezar.
Análisis del escritor:
• La parte más importante de este proyecto es cómo hacerlo, por ello, voy a
usar el tipo de información “procedimiento”.
• Escogeré un bloque clave de entre aquellos asociados con ese tipo de información.
• Esbozaré el bloque clave apropiado que represente la mayor parte de la
información que el lector necesita para armar un aparato de sonido.
• Ya que el bloque clave de procedimiento será el más importante, colocaré
alrededor bloques de apoyo para crear un mapa de procedimiento
Ejemplo de uso de
bloques clave
Mapas de procedimiento
Bloques clave del mapa
de procedimiento
Los bloques clave del mapa de procedimiento pueden ser:
•
•
•
•
•
•
Tabla de procedimiento
Tabla de procedimiento (con bloques lineales)
Tabla de decisión o Tabla “Si... Entonces...” (con bloques de alternativas)
Hoja de trabajo (formatos para vaciar información)
Lista de verificación (check list)
Tabla de procedimientos extendida
Diagrama de flujo
1. La tabla de procedimiento contiene tareas a realizar ordenadas en una
secuencia lógica. Se debe presentar con:
• Un bloque de apoyo antecedente que contenga la frase introductoria o las
condiciones iniciales para realizar el procedimiento.
• El título de la tabla.
• La tabla de procedimiento.
Puede contener bloques de apoyo adicionales con ejemplos y/o contraejemplos. Se recomienda:
•
•
•
•
•
•
Conservar la regla de 7 más/menos 2 divisiones.
Iniciar cada frase con un verbo en imperativo (conecte, reemplace, etc.).
No usar ejemplos demasiado detallados.
Si el procedimiento es muy complejo, no explicarlos en una sola tabla.
Evitar detalles innecesarios.
Agregar observaciones en una columna a la derecha de la tabla, si es
necesario.
• Cuando existan acciones que pueden realizarse en forma simultánea, citarlas en orden de importancia o del tiempo que requieren.
• Revisar la consistencia en la redacción de los pasos.
• Si es necesario, agregar ilustraciones.
84
Ejemplo de tabla de
procedimiento
A continuación se presenta un ejemplo de la tabla de procedimiento: “Método de los siete pasos para el mejoramiento de procesos”:
PASO
ACCIÓN
1
Defina el proyecto
2
Estudie la situación actual
3
Analice las causas potenciales
4
Implemente una solución
5
Verifique los resultados
6
Estandarice la mejora
7
Haga planes para el futuro
2. La tabla de decisión es muy similar a la tabla de procedimiento pero incluye, además, las siguientes condiciones:
Definición de la tabla
de decisión
• Lectura horizontal, de izquierda a derecha.
• En la primera columna la condición “Si...”
• En la segunda columna, la decisión “Entonces...”
Esta tabla puede formar parte de una tabla de procedimiento. Se recomienda:
• Conservar la regla de siete más/menos dos divisiones.
• Aunque no requiera un orden particular, es conveniente colocar primero
lo que ocurre con más frecuencia o lo más importante.
• Agrupar las tablas de decisión de acuerdo con alguna categoría como:
tipo de falla, diagnóstico preliminar, etc.
• Conservar las ramificaciones en divisiones sucesivas, cuando esté dentro
de otra tabla.
• Ubicar la tabla en el lugar en que sea más útil para el lector, es decir, en el
momento en que se toman las decisiones.
Pasos para verificar los resultados de una solución:
SI…
ENTONCES
Los datos obtenidos después de implementar la solución indican mejora con respecto
a la situación inicial.
Haga que la solución propuesta se
convierta en permanente.
Los datos obtenidos después de implementar la solución indican resultados iguales o
más deficientes que la situación inicial.
Busque otra solución factible.
3. La hoja de trabajo consiste en un formato que debe llenarse. Se debe presentar con:
• Un título.
• Una serie de frases a completar por el lector que sigue el procedimiento
relacionado en la hoja.
Ejemplo de la tabla de
decisión
85
Descripción de la hoja
de trabajo
La hoja puede requerir una tabla de decisiones. Por ejemplo, el fragmento de
hoja para el pago de impuesto sobre la renta.
Ejemplo de hoja de
trabajo
Descripción de la lista
de verificación
86
IMPUESTO SOBRE LA RENTA
A. (Anote la suma de los campo e + i)
110035
B. PARTE ACTUALIZADA DEL IMPUESTO (se anotará la diferencia entre su
impuesto y el mismo ya actualizado,
conforme lo dispone el CFF)
100025
C. RECARGOS
100009
D. MULTA POR CORRECCIÓN FISCAL
100013
E. TOTAL DE CONTRIBUCIONES
(A + B + C + D)
201011
F. CRÉDITO AL SALARIO (Sin exceder
de E)
950018
G. OTROS ESTÍMULOS (Sin exceder de
E - F)
950020
4. La lista de verificación (también llamada check list) sirve para asegurarse
de que se siguió correctamente un procedimiento. Su presentación es similar a la
tabla de procedimientos, pero contiene espacios (cuadros o círculos, por ejemplo)
para marcar las actividades que ya se han realizado, generalmente con símbolos
como:
Por ejemplo: la lista de verificación para analizar la accesibilidad de un sitio
Web:
En general (Prioridad 2)
Si
No
N/A
2.2 Asegure que las combinaciones de los colores de fondo
y primer plano tengan suficiente contraste para que sean
percibidas por personas con deficiencias de percepción de
color o por pantallas en blanco y negro (Prioridad 2 para las
imágenes. Prioridad 3 para los textos).
3.1 Cuando exista un marcador apropiado, use marcadores en
vez de imágenes para trasmitir la información.
3.2 Cree documentos que estén validados por las gramáticas
formales publicadas.
3.3 Utilice hojas de estilo para controlar la maquetación y la
presentación.
3.4 Utilice unidades relativas en lugar de absolutas al especificar los valores en los atributos de los marcadores de
lenguaje y en los valores en las propiedades de las hojas
de estilo.
Descripción de la tabla
de procedimiento
extendida
5. La tabla de procedimiento extendida consiste en una combinación de
varias tablas de procedimiento. Se utiliza para agregar anotaciones que no son generales sino relativas a un paso en particular. Pueden usarse también dentro de la
hoja de trabajo.
La siguiente tabla indica cómo clasificar y distribuir el correo matutino. Observa que aparece una tabla dentro de otra tabla:
PASO
ACCIÓN
1
Vaya al cuarto de correo después de las 10 a.m. y solicite la orden del Departamento.
Nota: El cuarto de correo se localiza en la oficina número 1593
2
Abra todo el correo menos el que diga “personal”.
3
Clasifique el correo en los siguientes grupos:
A. cuentas por pagar
B. preguntas sobre nuestros productos
C. propaganda
D. cartas dirigidas al departamento
E. cartas dirigidas a personas en particular
Ejemplo de tabla
de procedimiento
extendida
Maneje el correo clasificado de la siguiente manera:
Grupo
4
Acción
A
Entregue a P. James
B
Entregue a G. Elliot
C
Tire la basura
D
Entregue a S. Gould
E
Entregue al destinatario
6. El diagrama de flujo consiste en una serie de bloques de acciones y decisiones. Se debe presentar con:
• Bloques de acciones
• Bloques de decisiones
Debe contener frases o preguntas completas. Cada bloque debe explicarse
por sí solo.
Por ejemplo: diagrama de flujo para distribuir el correo matutino:
Inicio
Solicite los paquetes
de correo
¿Es propaganda?
No
Revise el primer
paquete
Pase al digrama 2
Si
Tire a la basura
Descripción del
diagrama de flujo
87
Mapas de proceso
Bloques clave de mapas
de proceso
Los bloques clave del Mapa de Proceso pueden ser:
•
•
•
•
•
•
•
Definición de
descripción
Descripciones
Tabla de etapas
Tabla del tipo “Cuando.../Entonces...”
Diagrama de bloques
Diagrama de ciclo
Diagrama “Cuando...” o “Si...”
Diagrama de flujo
1. Una descripción es un conjunto de enunciados que enumera los pasos del
proceso. Por ejemplo: proceso digestivo
El proceso digestivo comprende una etapa de preparación del alimento, que tiene lugar en la boca; otra de tratamiento del alimento mediante una serie de acciones físicas y químicas que se efectúan en el estómago y primera parte del intestino;
una tercera en que los componentes útiles y asimilables se separan de los residuos
e ingresan en la sangre; y por último, la fase en la que esos desechos son excretados del cuerpo.
88
de etapas
Descripción de la
tabla “Cuando.../
Entonces...”
2. La tabla de etapas refleja la secuencia en la cual se van dando los eventos.
Por ejemplo:
ETAPA
DESCRIPCIÓN
1) Preparación
Tiene lugar en la boca.
2) Tratamiento
Acciones físicas y químicas que se efectúan en el estómago y
primera parte del intestino.
3) Separación
Los componentes útiles y asimilables se separan de los residuos
e ingresan en la sangre.
4) Excreción
Los desechos son excretados por el cuerpo.
3. La tabla “Cuando.../Entonces...” relaciona los eventos que ocurren sin intervención del lector. Dentro de la tabla debe continuarse la redacción de los títulos de
manera concordante. Por ejemplo:
Cuando...
Entonces...
1) La calificación de alumno sea menor
que 6.0
El alumno estará suspendido.
2) La calificación del alumno sea mayor o
igual que 6.0
El alumno estará aprobado.
4. Los diagramas de bloques explican el proceso a través de rectángulos y flechas. Son muy utilizados en las certificaciones iso. Por ejemplo en el proceso de
contratación
Entrevista
Registro
Descripción del
diagrama de bloques
Documentación
5. El diagrama de ciclo es semejante al diagrama de bloque, pero se cierra o se
repite en algún momento para señalar precisamente la existencia de un ciclo repetitivo. Ejemplo:
6. El diagrama “Cuando...” o “Si...”explica cómo se pasa de una etapa a otra, es
decir, cómo funciona.
Descripción del
diagrama de ciclo
Descripción del
diagrama “Cuando” o
“Si”
89
Cuando se encienda
el foco de la cafetera
El café estará listo
Si se enciende el foco
de la impresora
Significa que hace
falta papel
7. El diagrama de flujo describe las diferentes secuencias posibles de un
proceso.
Descripción del
diagrama de flujo
Mapas de estructura
En virtud de que el mapa de estructura tiene como objetivo describir la forma en
que un objeto (físico o abstracto) está construido, su bloque clave obligatorio es el
Bloque clave del mapa
de estructura
diagrama. Puede tener como bloques de apoyo: tablas de partes, funciones, definiciones, etcétera.
A continuación se muestra un ejemplo de mapa de estructura con su bloque
clave de diagrama.
Ejemplo del mapa
de estructura
1) Lente: es una de las piezas más importantes y frágiles. Desde este lugar será
enviada la luz de la escena fotografiada hacia los sensores de la cámara.
2) Flash: permite disparar una luz artificial para iluminar correctamente las escenas. Su disparo se produce por una descarga eléctrica dentro de un tubo lleno
de gas halógeno, generalmente xenón.
3) Disparador: es el que nos permitirá enfocar un motivo y realizar la fotografía.
90
4) Pixeles: generalmente en el frente de la cámara encontramos la referencia
acerca de la definición en megapixeles de la cámara.
Mapas de concepto
Bloques clave de mapas
de concepto
Los mapas de concepto pueden tener como bloques clave:
• Definición
• Atributos
• Características
Bloques de apoyo para
los mapas de concepto
Estos mapas suelen ser los primeros que se enuncian en un documento. Los
bloques de apoyo usuales para los mapas de concepto son:
• Ejemplos
• Contraejemplos
En este documento encontrarás muchos ejemplos de mapas de concepto.
El siguiente mapa de concepto explica las oportunidades iguales de empleo.
El bloque clave es la Definición. Los bloques de apoyo son Introducción, Ejemplo
1, Ejemplo 2 y Contraejemplo.
Oportunidades iguales de empleo
Introducción
Las prácticas de contratación tradicionales han creado con frecuencia situaciones en las que las oportunidades efectivas de trabajo
dadas a varios grupos étnicos, fueron menos que proporcionales a
la parte que representan en la fuerza de trabajo total.
Definición
Oportunidades iguales de empleo (oif) es un compromiso de reclutar, contratar, promover y proveer de iguales condiciones de trabajo a todas las personas, sin distinciones de raza, color, edad, sexo,
religión, nacionalidad originaria, estatus de veterano, estado civil u
“otras características protegidas por la ley”.
Ejemplo 1
Un gerente, J. T. Barnes, contrata trabajadores masculinos para llenar puestos de oficina usualmente ocupados por mujeres. Esto es
un ejemplo de oportunidades iguales de empleo.
Ejemplo 2
El departamento de personal busca activamente a empleados entre
las minorías para colocarlos en todas las posiciones de la compañía,
en proporción al porcentaje que representan en el total de la fuerza
de trabajo. Esto es un ejemplo de oportunidades iguales de empleo.
Contraejemplo
El gerente de distrito contrata a más empleados administrativos mujeres para elevar el número de mujeres en la organización.
Este no es un ejemplo de oportunidades iguales de empleo, porque
mantiene a las mujeres en ciertos puestos y limita su oportunidad
de promoción.
91
¿Podrías identificar en el ejemplo los elementos del mapa de concepto?
Mapas de principio
Los bloques clave de un mapa de principio deben contener alguno de los siguientes
elementos:
•
•
•
•
•
Bloques clave para los
mapas de principio
Reglamento o parte de él
Políticas
Estándares
Normas
Referencias
Los bloques de apoyo pueden ser:
Bloques de apoyo para
los mapas de principio
• Casos en que se aplica
• Excepciones
Aquí se muestra un ejemplo de mapa de principio con su bloque clave que en
este caso es Política:
Ejemplo de mapa de
principio
Política sobre capacitación fuera de las horas de trabajo
Política
No pida o estimule a los empleados a que estudien materiales relacionados con el trabajo fuera de las horas regulares de trabajo.
Justificación
Las leyes federales exigen a las compañías que paguen a sus empleados por todo esfuerzo relacionado con el trabajo, que se haya
realizado fuera de las horas de trabajo.
Ejemplo:
Spencer Smith empezó a trabajar como operador de una terminal
cumplimiento en el departamento de contabilidad. Smith pasó todo el día estudiando el curso introductorio de capacitación pero al final del día
sólo llevaba la mitad. Quiso llevarse el manual a su casa para estudiarlo en la noche.
Su supervisor se mostró complacido con el interés de Smith, pero
fue muy enfático al precisar que la capacitación era parte de su trabajo y que debía realizarla durante las horas de trabajo.
Ejemplo:
violación
Chris Henderson fue promovido a instructor de programadores en el
departamento de procesamiento de datos. su supervisor le entregó
dos cursos sobre fortran y le sugirió que los estudiara durante el fin
de semana.
Esto es violación a la política establecida.
Mapas de hecho
92
mapas de hecho
En virtud de que los mapas de hecho simplemente presentan evidencias, sus bloques clave pueden ser:
•
•
•
•
•
mapas de hecho
Descripción
Antecedentes
Gráfico de la situación
Problema
Propuesta de solución
Algunos ejemplos de mapas de hecho son:
•
•
•
•
Tabla de la distribución normal
Especificaciones de materiales o equipos
Descripción de medidas
Simbología utilizada
ESTADÍSTICAS SOBRE ALCOHOLISMO EN MÉXICO
Ejemplo (fragmento)
Introducción
El alcoholismo es la enfermedad biopsicosocial por excelencia, participa en muchos de los hechos violentos que suceden dentro de la
familia, es causa primordial de desintegración de ésta y maltrato a la
mujer y a los niños. Los accidentes viales con frecuencia alarmantes
se originan por el abuso que se hace del alcohol, dentro del ámbito
laboral origina accidentes y es causa importante de pérdidas humanas y económicas que repercuten en el ingreso tanto general del
país como en el de la familia.
Estadísticas
Las estadísticas nos muestran que la cirrosis hepática es la sexta
causa de mortalidad general en la república, con una tasa de 23.7x
100 000 habitantes. Lo que repercute en el presupuesto de las instituciones, como lo que sucede en el Hospital General de México,
O.D. en donde es la primera causa de mortalidad en la población de
15 a 64 años.
Mapas de clasificación
En virtud de que los mapas de clasificación describen clases, categorías o límites
entre objetos o ideas, sus bloques clave pueden ser:
•
•
•
•
mapas de clasificación
Listas
Tablas de clasificación
Tablas de comparación y contraste (benchmark)
Árboles de clasificación
A continuación se explica y se ejemplifica cada uno de ellos.
1. Una lista de clasificación consta de:
Listas de clasificación
• Una oración o frase introductoria.
• Un conjunto de elementos agrupados de acuerdo con algún criterio.
Las listas pueden ordenarse por uno o más de los siguientes criterios:
•
•
•
•
•
•
•
•
•
93
Orden en las listas de
clasificación
Orden numérico
Orden alfabético
Orden cronológico
Orden jerárquico
De lo concreto a lo abstracto
De lo conocido a lo desconocido
De lo sencillo a lo complejo
De lo específico a lo general
De lo general a lo específico
Utiliza siempre el orden que sea más claro para el lector e indícalo al inicio de
la lista, siempre que sea pertinente. Por ejemplo:
El software se clasifica generalmente en los siguientes rubros:
•
•
•
•
•
Lenguajes de programación
Programas de aplicación
Sistemas operativos
Programas de aplicación
Sistemas operativos
Ejemplo de lista de
clasificación
Elementos de la tabla
de clasificación
2. Una tabla de clasificación consta de:
• Una oración o frase introductoria.
• Una tabla organizada bajo dos o más atributos de clasificación.
En este ejemplo los tipos de errores se clasifican de acuerdo con su fuente más
probable y su localización:
Tipo de error
de comparación y
contraste
Sistema
operativo:
Nombre mal escrito
Capturista
14 A
Sin nombre
Vendedor
14 A
Dirección incorrecta
El vendedor no verificó
15
No se encontró al
destinatario
El negocio se cambió
16
3. Una tabla de comparación y contraste (o tabla benchmark) es una tabla de
clasificación que señala con claridad semejanzas y diferencias.
94
Localización en la forma A
79XS (línea No.)
Fuente más probable
Tabla comparativa de sistemas operativos:
Windows
2000
Windows XP
Mac OS X
Mac OS
Fedora Core
(Linux)
SUSE Linux
Creador
Microsoft®
Microsoft®
Apple®
Apple®
Fedora project® SUSE®
Año de
primera
distribución
2001
2000
2001
1984
2003
1994
Aspectos generales
Versión
estable
SP2
SP4
10.3
(Panther)
9.2
4.0
10.0
Costo
$ 184 (hogar)
$ 279 (Pro)
?
$ 129 o
preinstalado
Gratuito hasta 7.5.5, 9.2
cuesta $ 20
para dueños
de Mac OS X
Gratuito
Gratuito
Licencia
No libre
No libre
No libre
parcialmente
software libre
No libre
Libre: GPL
Libre: GPL
Elementos del árbol
de clasificación
4. Un árbol de clasificación se compone de:
• Una o más frases introductorias.
• Un diagrama que muestra gráficamente la forma cómo se relacionan los
diversos elementos.
Por ejemplo:
Tipos Ada
Elementales
Puntero
Escalar
Compuestos
Array
Registro Protegido
Discreto
Enumeración
Con signo
Tarea
Real
Flotante
Entero
Sin signo
Fija
Decimal
Ordinario
95
¿De qué tema podrías hacer una tabla de comparación?
Reactivos de autoevaluación
Instrucciones: Escribe en la línea la letra correspondiente, F para falso y V para verdadero.
96
1. La mayoría de los trabajos escritos a través del mapeo de información requieren tanto de
un conocimiento teórico de los tipos de información como de una habilidad práctica
para esbozar los bloques clave.
_____
2. Los bloques clave son bloques de información que ayudan al escritor a entender
el contenido.
_____
3. Los bloques clave pueden auxiliarse de bloques de apoyo.
_____
4. Existen bloques clave específicos asociados a cada uno de los siete tipos de información.
_____
5. Una tabla de etapas es un mapa común para un mapa de procedimiento.
_____
6. Un diagrama de flujo es susceptible de emplearse en un mapa de proceso o en uno
de procedimiento.
_____
7. Un diagrama de ciclo es típico de los mapas de estructura. _____
8. Un mapa de principio podría ser la imagen de un auto y sus partes señaladas.
_____
9. Un ejemplo de mapa de hecho es un reglamento o parte de él.
_____
10. Los mapas de clasificación describen clases, categorías o límites entre objetos o ideas.
_____
Glosario
Benchmark: Conjunto de procedimientos que permiten evaluar el rendimiento
y funcionamiento de un sistema informático por comparación con otros
índices conocidos.
Árbol de clasificación: Un árbol de clasificación es una forma de representar el
conocimiento obtenido en el proceso de aprendizaje inductivo. Puede considerarse como la estructura resultante de la partición binaria recursiva del
espacio de representación a partir del conjunto de registros utilizados.
Fuentes de información
González, M. (2005). Documentación. México: UNID.
97
Panel de verificación
Instrucciones: Escribe en la línea la letra correspondiente, F para falso y V para verdadero.
98
1. La mayoría de los trabajos escritos a través del mapeo de información requieren tanto de
un conocimiento teórico de los tipos de información como de una habilidad práctica
para esbozar los bloques clave.
_____
V
2. Los bloques clave son bloques de información que ayudan al escritor a entender
el contenido.
_____
F
3. Los bloques clave pueden auxiliarse de bloques de apoyo.
_____
V
4. Existen bloques clave específicos asociados a cada uno de los siete tipos de información.
_____
V
5. Una tabla de etapas es un mapa común para un mapa de procedimiento.
_____
F
6. Un diagrama de flujo es susceptible de emplearse en un mapa de proceso o en uno
de procedimiento.
_____
V
7. Un diagrama de ciclo es típico de los mapas de estructura. _____
F
8. Un mapa de principio podría ser la imagen de un auto y sus partes señaladas.
_____
F
9. Un ejemplo de mapa de hecho es un reglamento o parte de él.
_____
F
10. Los mapas de clasificación describen clases, categorías o límites entre objetos o ideas.
_____
V

Presentación Tema y subtemas Objetivos específicos

Transcripción

Documentos relacionados

Mi tierra, Extremadura OBJETIVOS GENERALES DE

Camporredondo de Alba Al norte de Palencia,La roca es cuarcita y