Documentacin Tcnica

Aplicada
UNIVERSIDAD INTERAMERICANA PARA EL DESARROLLO

Rector
Mtro. Carlos Gereca Lozano
Director General Acadmico
Lic. Jorge Enrique Jurez Barba
Director de Administracin y Finanzas
Mtro. Hctor Javier Salazar Domnguez
Director de Desarrollo
Ing. Roberto Lpez Zambada
Gerencia de Desarrollo Acadmico
Mtro. Alfonso Torres Maldonado
Coordinacin de Didctica y Diseo Curricular
Lic. Karina Valeria Muro Villafuerte
Gerencia del Centro de Tecnologa Educativa
Lic. Maritza Barrera Arriaga
Diseo Instruccional
Lic. Brbara Audrey Aguilar Ramrez
Lic. Tania Yvette Anguiano Moreno
Mtra. Vernica del Carmen Quijada Monroy
Diseo Grfico
Lic. Erika Pamela Santana Elizalde
Tecnologa
Lic. Rodrigo Damin Velzquez Tapia
Lic. Asael Virgilio Oropeza
Formacin
Lic. Tania Yvette Anguiano Moreno
Contenido
Dra. Mara del Carmen Gonzlez Videgaray. Primera edicin: 2006
Mtra. Vernica del Carmen Quijada Monroy. Segunda edicin actualizada: 2010

Universidad del Tercer Milenio, S.C.

Av. Gustavo Baz No. 2160-4
Col. Fraccionamiento Industrial La Loma. Tlalnepantla, Estado de Mxico, C.P. 54060
www.unid.edu.mx

Ninguna parte de esta publicacin, incluida la cubierta, puede ser reproducida total o parcialmente, sin la autorizacin escrita de los editores.

CONTENIDO
DOCUMENTACIN TCNICA APLICADA........................................................................................1
INTRODUCCIN...................................................................................................................................7
SESIN 1 CONCEPTOS BSICOS....................................................................................................9
LECCIN 1.1 INTRODUCCIN.........................................................................................................................9
LECCIN 1.2 QU ES LA DOCUMENTACIN TCNICA....................................................................................10
LECCIN 1.3 EL ESCRITOR TCNICO.............................................................................................................11
LECCIN 1.4 UN BUEN DOCUMENTO TCNICO.............................................................................................12
LECCIN 1.5 MAPEO DE INFORMACIN (MI)...............................................................................................14
LECCIN 1.6 VENTAJAS DEL MAPEO DE INFORMACIN...............................................................................15
SESIN 2 CLAVES PARA ESCRIBIR..............................................................................................17
LECCIN 2.1 INTRODUCCIN.......................................................................................................................17
LECCIN 2.2 PALABRAS: JERGA Y CONSISTENCIA........................................................................................18
LECCIN 2.3 PALABRAS: PERSONA GRAMATICAL........................................................................................20
LECCIN 2.4 PALABRAS: VERBOS................................................................................................................21
LECCIN 2.5 PALABRAS: ADJETIVOS Y ADVERBIOS.....................................................................................22
LECCIN 2.6 ORACIONES.............................................................................................................................23
LECCIN 2.7 ORACIONES: VOZ ACTIVA.......................................................................................................24
LECCIN 2.8 ORACIONES: LONGITUD..........................................................................................................26
LECCIN 2.9 CLASIFICACIN DE LOS DOCUMENTOS....................................................................................28
LECCIN 2.10 DOCUMENTOS SEGN SU FUNCIN.....................................................................................29
LECCIN 2.11 DOCUMENTOS SEGN SU ESTILO.........................................................................................30
LECCIN 2.12 DOCUMENTOS SEGN SU MEDIO DE DISTRIBUCIN.............................................................32
LECCIN 2.13 ESTRUCTURA DE UN DOCUMENTO TCNICO........................................................................34
SESIN 3 PLANEACIN Y PRINCIPIOS DEL MI.........................................................................35
LECCIN 3.1 INTRODUCCIN.......................................................................................................................35
LECCIN 3.2 PLANEACIN DE LOS DOCUMENTOS........................................................................................36
LECCIN 3.3 ANLISIS.................................................................................................................................38
LECCIN 3.4 DISEO...................................................................................................................................42
LECCIN 3.5 DESARROLLO..........................................................................................................................43
LECCIN 3.6 EVALUACIN..........................................................................................................................44
LECCIN 3.7 IMPLEMENTACIN...................................................................................................................45
LECCIN 3.8 PRINCIPIOS DEL MAPEO DE INFORMACIN..............................................................................46
LECCIN 3.9 EL PRINCIPIO DE FRAGMENTACIN..........................................................................................47
LECCIN 3.10 EL PRINCIPIO DE RELEVANCIA............................................................................................49
LECCIN 3.11 EL PRINCIPIO DE ETIQUETADO............................................................................................51
LECCIN 3.12 EL PRINCIPIO DE CONSISTENCIA..........................................................................................53
LECCIN 3.13 EL PRINCIPIO DE GRFICAS INTEGRADAS............................................................................54
LECCIN 3.14 EL PRINCIPIO DEL DETALLE ACCESIBLE..............................................................................56
LECCIN 3.15 EL PRINCIPIO DE JERARQUA DE FRAGMENTOS Y ETIQUETAS..............................................58
SESIN 4 NUEVAS UNIDADES DE INFORMACIN....................................................................61
LECCIN 4.1 INTRODUCCIN.......................................................................................................................61
LECCIN 4.2 VISIN GENERAL DE LAS NUEVAS UNIDADES..........................................................................62
LECCIN 4.3 EL BLOQUE DE INFORMACIN.................................................................................................64
LECCIN 4.4 EJEMPLOS DE BLOQUES DE INFORMACIN..............................................................................65
LECCIN 4.5 REGLAS PARA DESARROLLAR BLOQUES DE INFORMACIN......................................................67
LECCIN 4.6 MANEJO DEL TAMAO DEL BLOQUE........................................................................................69

LECCIN 4.7 EJEMPLOS DE CMO MANEJAR EL TAMAO DE BLOQUE..........................................................71

LECCIN 4.8 EL MAPA DE INFORMACIN.....................................................................................................74
LECCIN 4.9 EJEMPLO DE UN MAPA DE INFORMACIN.................................................................................75
LECCIN 4.10 REGLAS DE FORMATO.........................................................................................................76
LECCIN 4.11 RESULTADO: UNA ESTRUCTURA VISIBLE............................................................................78
SESIN 5 ETIQUETAS DE BLOQUES Y TIPOS DE INFORMACIN..........................................79
LECCIN 5.1 INTRODUCCIN.......................................................................................................................79
LECCIN 5.2 VISIN GENERAL DE LAS ETIQUETAS.......................................................................................80
LECCIN 5.3 REGLAS PARA ETIQUETAR BLOQUES.......................................................................................81
LECCIN 5.4 ETIQUETAS INDEPENDIENTES DEL TEMA.................................................................................83
LECCIN 5.5 ETIQUETAS ESPECFICAS DEL TEMA........................................................................................85
LECCIN 5.6 ETIQUETAS COMBINADAS.......................................................................................................86
LECCIN 5.7 VISIN GENERAL DE LOS TIPOS DE INFORMACIN...................................................................87
LECCIN 5.8 LOS SIETE TIPOS BSICOS DE INFORMACIN............................................................................88
LECCIN 5.9 EJEMPLOS DE CADA TIPO DE INFORMACIN............................................................................89
SESIN 6 TIPOS DE INFORMACIN Y BLOQUES CLAVE........................................................91
LECCIN 6.1 INTRODUCCIN.......................................................................................................................91
LECCIN 6.2 VISIN GENERAL.....................................................................................................................92
LECCIN 6.3 BLOQUES CLAVE.....................................................................................................................93
LECCIN 6.4 MAPAS DE PROCEDIMIENTO....................................................................................................94
LECCIN 6.5 MAPAS DE PROCESO..............................................................................................................101
LECCIN 6.6 MAPAS DE ESTRUCTURA.......................................................................................................105
LECCIN 6.7 MAPAS DE CONCEPTO...........................................................................................................106
LECCIN 6.8 MAPAS DE PRINCIPIO.............................................................................................................107
LECCIN 6.9 MAPAS DE HECHO.................................................................................................................108
LECCIN 6.10 MAPAS DE CLASIFICACIN................................................................................................109
SESIN 7 ILUSTRACIONES..........................................................................................................113
LECCIN 7.1 INTRODUCCIN.....................................................................................................................113
LECCIN 7.2 VISIN GENERAL...................................................................................................................114
LECCIN 7.3 CLASIFICACIN DE ILUSTRACIONES......................................................................................115
LECCIN 7.4 ILUSTRACIONES SEGN SU COLOCACIN...............................................................................116
LECCIN 7.5 ILUSTRACIONES SEGN SU PRESENTACIN............................................................................117
LECCIN 7.6 MANEJO DE ILUSTRACIONES.................................................................................................121
LECCIN 7.7 DIBUJOS DE LNEAS VS. FOTOGRAFAS..................................................................................124
LECCIN 7.8 DIBUJOS DE LNEAS...............................................................................................................125
LECCIN 7.9 FOTOGRAFAS.......................................................................................................................126
LECCIN 7.10 GUA PARA EL USO DE ELEMENTOS GRFICOS..................................................................127
LECCIN 7.11 EL PUNTO.........................................................................................................................128
LECCIN 7.12 LA LNEA..........................................................................................................................129
LECCIN 7.13 EL REA...........................................................................................................................131
SESIN 8 ELEMENTOS DE TIPOGRAFA..................................................................................133
LECCIN 8.1 INTRODUCCIN.....................................................................................................................133
LECCIN 8.2 VISIN GENERAL...................................................................................................................134
LECCIN 8.3 CLASIFICACIN DE LOS TIPOS...............................................................................................135
LECCIN 8.4 TIPOS SEGN SU POCA.........................................................................................................136
LECCIN 8.5 TIPOS SEGN SU FAMILIA......................................................................................................142
LECCIN 8.6 TIPOS SEGN SU ESPACIAMIENTO..........................................................................................145
LECCIN 8.7 MODIFICACIN DE LOS TIPOS................................................................................................146
LECCIN 8.8 TAMAO DE LA TIPOGRAFA.................................................................................................147

LECCIN 8.9 FORMATO DE LA TIPOGRAFA................................................................................................149

LECCIN 8.10 KERNING..........................................................................................................................151
LECCIN 8.11 ALINEACIN DEL TEXTO...................................................................................................152
LECCIN 8.12 INTERLINEADO DEL TEXTO...............................................................................................153
LECCIN 8.13 REGLAS TIPOGRFICAS.....................................................................................................154
SESIN 9 CONSIDERACIONES ADICIONALES.........................................................................157
LECCIN 9.1 INTRODUCCIN.....................................................................................................................157
LECCIN 9.2 VISIN GENERAL...................................................................................................................158
LECCIN 9.3 LISTAS..................................................................................................................................159
LECCIN 9.4 LISTAS CON VIETAS............................................................................................................160
LECCIN 9.5 LISTAS NUMERADAS.............................................................................................................162
LECCIN 9.6 ESQUEMAS NUMERADOS.......................................................................................................164
LECCIN 9.7 TABLAS.................................................................................................................................166
LECCIN 9.8 SISTEMAS DE NUMERACIN..................................................................................................168
LECCIN 9.9 RECOMENDACIONES PARA HACER PRESENTACIONES............................................................170
LECCIN 9.10 ORGANIZACIN DE LAS IDEAS..........................................................................................171
LECCIN 9.11 DISEO DE LAS DIAPOSITIVAS...........................................................................................172
LECCIN 9.12 TIEMPO Y PORTABILIDAD DE LA PRESENTACIN...............................................................175
LECCIN 9.13 SOFTWARE PARA DOCUMENTACIN TCNICA...................................................................176
REFERENCIAS..................................................................................................................................177

Introduccin
Propsito de
este texto
El objetivo de este texto es apoyar al curso de Documentacin Tcnica con la finalidad de que el participante aplique los principios del Mapeo de Informacin
para generar documentos de calidad en el mbito de las tecnologas de informacin.

A quin va
dirigido
A estudiantes de la Maestra en Tecnologas de Informacin del Sistema UNID e
interesados en la tecnologa informtica: directivos, maestros, desarrolladores,
programadores, que requieran escribir documentos tcnicos y que cuenten con
un conocimiento slido del tema sobre el que se escribe, as como con la capacidad de estructurar el contenido.

Justificacin
Los estudios cientficos han demostrado que el Mapeo de Informacin tiene ventajas:
Para los lectores:
Un 32% menos en el tiempo de lectura
Un 54% menos de malinterpretaciones
Un 70% menos en preguntas sobre el contenido del documento
Para los autores:
Los autores comienzan a escribir ms pronto
Un 57% menos en el nmero de palabras por documento
Un 83% menos en el tiempo para concluir el primer borrador
Un 75% menos de tiempo para revisar el documento
En los costos:
De 30 a 40% menos de tiempo para capacitar autores
Un 79% menos en costos de traduccin

DOCUMENTACIN TCNICA APLICADA

Sesin 1 Conceptos Bsicos

Leccin 1.1 Introduccin
Objetivo
Es muy probable que en tus actividades diarias sea necesario escribir. Ya sea que
te agrade escribir o no, desde un correo electrnico hasta un manual de usuario o
un reporte, la comunicacin escrita es fundamental en la mayor parte de los trabajos.
En esta sesin sabrs qu es un documento tcnico, qu caractersticas hacen que
un documento sea de calidad y cumpla su objetivo, y qu ventajas tiene el uso de
la metodologa que te ofrece este curso.

Contenido de la
sesin

Figura 1-1 Contenido de la sesin

MAESTRA EN TECNOLOGAS DE INFORMACIN - PGINA9

DOCUMENTACIN TCNICA APLICADA

Leccin 1.2 Qu es la documentacin tcnica

Qu es un
documento
tcnico
La comunicacin tcnica es uno de los pilares de nuestra civilizacin. La forma
en que la mayora de nosotros podemos beneficiarnos con los descubrimientos y
avances es preservarlos en forma escrita, ya sea impresa en los tradicionales libros y revistas o de manera electrnica.
Un documento tcnico es aquel escrito que contiene informacin acerca de un
rea de conocimiento, organizada de forma estructurada y presentada eficazmente a los lectores. De manera muy sencilla podemos definir un documento tcnico
como todo aquello que no es una obra literaria y que est relacionado con el
mbito laboral, tecnolgico o cientfico.

Ejemplos
Existen gran variedad de documentos tcnicos con los cuales seguramente ests
familiarizado:

Correo electrnico
Mensajes instantneos
Oficios
Documentacin de software
Interfaces
Presentaciones por computadora
Circulares
Manuales de usuario
Manuales de organizacin
Pginas web
Apuntes
Libros de texto
Artculos cientficos

MAESTRA EN TECNOLOGAS DE INFORMACIN - PGINA10

DOCUMENTACIN TCNICA APLICADA

Leccin 1.3 El escritor tcnico

El escritor
tcnico
El escritor tcnico es, por supuesto, la persona que escribe documentos tcnicos. Actualmente an no se identifica en nuestro entorno como una profesin
especfica, sin embargo, cada vez se reconoce ms la importancia de la comunicacin escrita y en muchos pases avanzados existe el puesto de escritor tcnico. As pues, muchos de nosotros debemos agregar a nuestras actividades laborales cotidianas las de la escritura tcnica.

Caractersticas
deseables
Generalmente identificamos como escritor tcnico entonces a una persona que
habitualmente elabora escritos en su mbito de trabajo y que demuestra las siguientes caractersticas:

Disfruta aprender de manera constante.

Tiene capacidad de anlisis, es decir, de descomponer algo en sus partes.
Tiene capacidad de sntesis, es decir, de estructurar un conjunto de elementos en un todo organizado.
Conoce la terminologa especializada propia de su disciplina.
Domina el tema sobre el cual escribe.
Demuestra un buen nivel de dominio del lenguaje en el que escribe, en este
caso espaol.
Tiene experiencia en el uso de procesadores de palabra (Word) y/o programas de edicin de documentos (LaTeX, FrameMaker, InDesign).
Maneja adecuadamente las ilustraciones.
Es creativo.

En otras
palabras
El escritor tcnico debe:

Saber elegir la palabra precisa para explicar cada idea, siempre ajustndose a
las definiciones establecidas.
Conocer y comprender bien el contenido, para poderlo explicar en forma escrita. Debe manejar su idioma y los trminos tcnicos.
Distinguir entre lo esttico y lo funcional en las ilustraciones.

MAESTRA EN TECNOLOGAS DE INFORMACIN - PGINA11

DOCUMENTACIN TCNICA APLICADA

Leccin 1.4 Un buen documento tcnico

Un buen
documento
Al hacer este tipo de documentos, el reto es lograr que los destinatarios realmente
los lean y asimilen su contenido. Un documento bien elaborado debe invitar a la
lectura. Un buen documento es agradable al lector, aun cuando ste probablemente no sepa exactamente por qu es agradable. Para lograr este objetivo el
documento debe:

Ser de fcil lectura.

Permitir al lector obtener el mayor provecho de su contenido.
Facilitar su actualizacin.
Proporcionar distintos niveles de detalle.

Teoremas de
la escritura
tcnica
Para lograr un buen documento es indispensable seguir cinco teoremas. Cuando escribas un documento:
1. Identifica a los destinatarios y escribe de manera apropiada para ellos.
2. Escribe con claridad.
3. Escribe de manera concisa.
4. Capta la atencin de los destinatarios.
5. Ayuda a tu lector.

Corolarios
De cada teorema se desprenden una serie de corolarios. Por ejemplo, los corolarios de Escribe de manera concisa son:
1. Escribe oraciones cortas y elimina todas las palabras innecesarias.
2. Escribe siempre en voz activa.
3. Elimina toda oracin irrelevante.
Veremos otros corolarios en las siguientes lecciones y detallaremos cada uno.

MAESTRA EN TECNOLOGAS DE INFORMACIN - PGINA12

DOCUMENTACIN TCNICA APLICADA

Conflicto entre
teoremas
Suele ocurrir que los teoremas entren en conflicto uno con otro. Por ejemplo, para escribir un concepto con suficiente claridad puede requerirse de un texto ms
extenso, con lo cual entraran en conflicto los teoremas 2 y 3. Para ayudar al lector puede resultar conveniente agregar una explicacin, un glosario o una ayuda
en lnea, con lo cual tambin habra un conflicto entre los teoremas 2 y 5. Sin
embargo, un buen escrito deber lograr un equilibrio armnico entre todos los
teoremas. As pues, para lograr la armona entre todos los teoremas habr que
trabajar y dominar dos aspectos que pueden parecer contradictorios:

Creatividad
Disciplina

Esto requiere tanto de conocer los fundamentos tericos y experimentales de la

buena documentacin tcnica como: practicar, practicar y practicar.

MAESTRA EN TECNOLOGAS DE INFORMACIN - PGINA13

DOCUMENTACIN TCNICA APLICADA

Leccin 1.5

Mapeo de Informacin (MI)

Qu es
Ya que la escritura tradicional no satisface las necesidades de la revolucin de
informacin que tiene lugar en este momento, se ha desarrollado una nueva manera de organizar y presentar la informacin, basada en principios experimentales de la comunicacin clara. El Mapeo de Informacin (MI) significa convertir el documento en un verdadero mapa, con fragmentos claros y sealamientos
adecuados, de tal modo que el lector obtenga con facilidad el beneficio de su
contenido. Este curso estar dedicado, en gran parte, al estudio del Mapeo de Informacin.

Sus bases
La metodologa del Mapeo de Informacin est basada en ms de veinte aos de
investigacin sobre la forma en que la gente lee y entiende la informacin. El
Mapeo de Informacin parte de determinar a quin va dirigido el documento y
qu se desea lograr con l. Usa una terminologa clara y sin ambigedades. Va
directamente al punto, es conciso. Cada fragmento de informacin muestra una
sola idea, es decir, forma un bocado de informacin (information chunk). La
notacin que se usa est documentada y explicada al inicio del texto. El documento tiene la estructura de un rbol que se divide en ramas cada vez ms pequeas y detalladas. Esta estructura es inmediatamente visible por el arreglo del
texto y el uso de la tipografa. Al mapear informacin se construyen mapas con
diferente nivel de detalle, de tal modo que pueden hacerse acercamientos segn
las necesidades del lector. Es decir, permite una lectura ejecutiva u operativa,
por la forma en que est presentado.

MAESTRA EN TECNOLOGAS DE INFORMACIN - PGINA14

DOCUMENTACIN TCNICA APLICADA

Leccin 1.6 Ventajas del Mapeo de Informacin

Introduccin
Hacer buenos documento tcnicos y usar los principios del Mapeo de Informacin tiene ventajas importantes. En las siguientes secciones se enlistan estas ventajas.

Ventajas de
hacer buenos
documentos
Qu ventajas tiene para ti desarrollar la capacidad de elaborar documentos
tcnicos de alta calidad, con gran rapidez y que logren su objetivo? Independientemente de las ventajas evidentes en cuanto al ahorro de tiempo en tu trabajo,
debes saber que esta capacidad puede hacer la diferencia entre ser un profesionista brillante y ser un profesionista no slo brillante sino exitoso. Esto es, la
capacidad de elaborar documentos tcnicos de alta calidad puede motivar:

Una promocin en el puesto de trabajo (o la obtencin del puesto)

El reconocimiento de tus aportaciones
La aceptacin de tus propuestas
Un aumento de sueldo
Que tus ideas se conviertan en realidad

Ventajas del
Mapeo de
Informacin
Los estudios cientficos han demostrado que el Mapeo de Informacin tiene
ventajas:
Para los lectores:

Un 32% menos en el tiempo de lectura

Un 54% menos de malinterpretaciones
Un 70% menos en preguntas sobre el contenido del documento
Contina en la siguiente pgina

MAESTRA EN TECNOLOGAS DE INFORMACIN - PGINA15

DOCUMENTACIN TCNICA APLICADA

Para los autores:

Los autores comienzan a escribir ms pronto

Un 57% menos en el nmero de palabras por documento
Un 83% menos en el tiempo para concluir el primer borrador
Un 75% menos de tiempo para revisar el documento En los costos:
De 30 a 40% menos de tiempo para capacitar autores
Un 79% menos en costos de traduccin

MAESTRA EN TECNOLOGAS DE INFORMACIN - PGINA16