Documentacion tecnica

Tabla de contenido
1 Conceptos Básicos 22
1.1 Qué es la documentación técnica 22
Objetivo de la sesión 22
Qué es un documento técnico 22
1.2 El escritor técnico 23
El escritor técnico 23
1.3 Un buen documento técnico 24
Un buen documento 24
Teoremas de la escritura técnica 24
Corolarios 24
Un buen documento técnico (continua) 25
Conflicto entre teoremas 25
1.4Mapeo de Información 26
Mapeo de Información 26
1.5 Ventajas 27
Ventajas de hacer buenos documentos 27
Ventajas del Mapeo de Información 27
2 Claves para escribir 28
2.1 Palabras: Jerga y consistencia 28
Definición de Jerga 28
Reglas para elegir palabras 28
Consistencia 29
2.2 Palabras: Persona gramatical 29
Reglas para escribir documentos técnicos: 29
2.3 Palabras:Verbos 30
Tres aspectos al elegir verbos: 30
Verbos fuertes 30
Variedad en los verbos 30
Tiempo verbal 30
2.4 Palabras: Adjetivos y adverbios 31
Contraejemplos 31
2.5 Oraciones 32
Introducción 32
Reglas: 32
La oración 32
2.6 Oraciones: Voz activa 33
La voz activa 33
Regla 33
Oraciones: Voz activa (continua) 34
Excepciones 34
2.7 Oraciones: Longitud 35Justificación 35
2.8 Clasificación de los documentos 36
Un documento puede clasificarse: 36
2.9 Documentos según su función 37
Tipos de documentos 37
2.10 Documentos según su estilo 38
Tipos de documentos 38
Sólo texto 38
Texto e ilustraciones 38
Sólo ilustraciones 38
2.11 Documentos según su medio de distribución 39
Por el medio de distribución 39
Impresos 39
Electrónicos 39Proyecciones 39
2.12 Estructura de un documento técnico 40
Tipos de documentos 40
Esquema 41
Importante 41
3 Planeación y Principios del MI 42
3.1 Introducción 42
Objetivo 42
3.2 Planeación de los documentos 42
Importancia de la planeación 42
Planeación de documentos (continua) 43
Etapas de la planeación 43
3.3 Análisis 43
Descripción 43
Actividades 43
Análisis(continua) 44
Objetivos y necesidades 44
Objetivos frecuentes 44
Análisis (continua) 45
Perfil del lector 45
Análisis (continua) 46
Medio de distribución 46
3.4 Estrategia de documentación 46
Equipo de escritores 46
Productos 47
3.5 Diseño 48
Descripción 48
Actividades 48
Productos 48
3.6 Desarrollo 49
Descripción 49
Actividades 49
Productos 49
3.7Evaluación 50
Descripción 50
Actividades 50
Productos 50
3.8 Implementación 51
Descripción 51
Actividades 51
Productos 51
3.9 Principios del Mapeo de Información 52
Los siete principios 52
3.10 El principio de fragmentación 53
Principio 53
Qué es una unidad manejable 53
Implicación 53
Justificación 53
3.11 El principio de relevancia 54
Principio 54
Implicación 54Justificación 54
3.12 El principio de etiquetado 55
Principio 55
Justificación 55
3.13 El principio de consistencia 56
Principio 56
Justificación 56
Comentario 56
3.14 El principio de gráficas integradas 57
Principio 57
Justificación 57
Aplicación 57
3.15 El principio del detalle accesible 58
Principio 58
Justificación 58
3.16 El principio de jerarquía defragmentos y etiquetas 59
Principio 59
Justificación 59
4 Nuevas Unidades de Información 60
4.1 Introducción 60
4.2 Visión general de las nuevas unidades 60
Introducción 60
El párrafo resulta inadecuado 60
Bloques y Mapas 60
Visión general de las nuevas unidades (continua) 61
En esta Sesión 61
4.3 El bloque de información 62
Definición 62
Componentes 62
4.4 Reglas paradesarrollar bloques de información 63
Introducción 63
Reglas 63
Dónde poner la otra información 63
Reglas para desarrollar bloques de información (continua) 64
Las transiciones 64
4.5 Manejo del tamaño del bloque 65
Introducción 65
Variaciones de los bloques 65
Tres opciones 65
Manejo del tamaño del bloque (continua) 66
Reglas de formato 66
Manejo del tamaño del bloque...