Documentación Técnica
Sesión 1 Conceptos Básicos
Lección 1.1 Qué es la documentación técnica
Objetivo de la sesión Es muy probable que en tus actividades diarias sea necesario escribir. Ya sea que te agrade es-
cribir o no, desde un correo electrónico hasta un manual de usuario o un reporte, la comuni-
cación escrita es fundamental en la mayor parte de los trabajos.
En esta sesión sabrás qué es un documento técnico, qué características hacen que un docu-
mento sea de calidad y cumpla su objetivo, y qué ventajas tiene el uso de la metodología que
te ofrece este curso.
Qué es un documento La comunicación técnica es uno de los pilares de nuestra civilización. La forma en que la ma-
técnico yoría 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 electrónica.
Un documento técnico es aquel escrito que contiene información acerca de un área de cono-
cimiento, organizada de forma estructurada y presentada eficazmente a los lectores. De mane-
ra muy sencilla podemos definir un documento técnico como todo aquello que no es una obra
literaria y que está relacionado con el ámbito laboral, tecnológico o científico.
Ejemplos Existen gran variedad de documentos técnicos con los cuales seguramente estás familiarizado:
Correo electrónico
Mensajes instantáneos
Oficios
Documentación de software
Interfaces
Presentaciones por computadora
Circulares
Manuales de usuario
Manuales de organización
Páginas web
Apuntes
Libros de texto
Artículos científicos
M a e s t r í a e n T e c n o l o g í a s d e I n f o r m a c i ó n - Página 1 de 96
Documentación Técnica
Lección 1.2 El escritor técnico
El escritor técnico El escritor técnico es, por supuesto, la persona que escribe documentos técnicos. Actualmente
aún no se identifica en nuestro entorno como una profesión específica, sin embargo, cada vez
se reconoce más la importancia de la comunicación escrita y en muchos países avanzados exis-
te el puesto de “escritor técnico”. Así pues, muchos de nosotros debemos agregar a nuestras
actividades laborales cotidianas las de la escritura técnica.
Características Generalmente identificamos como escritor técnico entonces a una persona que habitualmente
deseables elabora escritos en su ámbito de trabajo y que demuestra las siguientes características:
Disfruta aprender de manera constante
Tiene capacidad de análisis, es decir, de descomponer algo en sus partes
Tiene capacidad de síntesis, es decir, de estructurar un conjunto de elementos en un
todo organizado
Conoce la terminología especializada o “jerga” 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 es-
pañol
Tiene experiencia en el uso de procesadores de palabra (Word) y/o programas de edi-
ción de documentos (LaTeX, FrameMaker, PageMaker)
Maneja adecuadamente las ilustraciones
Es creativo
En otras palabras El escritor técnico debe:
Saber elegir la palabra precisa para explicar cada idea, siempre ajustándose a las defi-
niciones establecidas.
Conocer y comprender bien el contenido, para poderlo explicar en forma escrita.
Debe manejar su idioma y los términos técnicos.
Distinguir entre lo estético y lo funcional en las ilustraciones.
M a e s t r í a e n T e c n o l o g í a s d e I n f o r m a c i ó n - Página 2 de 96
Documentación Técnica
Lección 1.3 Un buen documento técnico
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 do-
cumento es agradable al lector, aún cuando éste probablemente no sepa exactamente por qué
es agradable.
Para lograr este objetivo el documento debe:
Ser de fácil lectura
Permitir al lector obtener el mayor provecho de su contenido
Facilitar su actualización
Proporcionar distintos niveles de detalle
Teoremas de la Para lograr un buen documento es indispensable seguir cinco “teoremas”. Cuando escribas un
escritura técnica 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 atención de los destinatarios.
5. Ayuda a tu lector.
Corolarios De cada teorema se desprenden una serie de “corolarios”. Por ejemplo, los corolarios de Escri-
be de manera concisa son:
1. Escribe oraciones cortas y elimina todas las palabras innecesarias.
2. Escribe siempre en voz activa.
3. Elimina toda oración irrelevante.
Veremos otros corolarios en las siguientes lecciones y detallaremos cada uno.
Conflicto entre Suele ocurrir que los teoremas entren en conflicto uno con otro. Por ejemplo, para escribir un
teoremas concepto con suficiente claridad puede requerirse de un texto más extenso, con lo cual entra-
rían en conflicto los teoremas 2 y 3. Para ayudar al lector puede resultar conveniente agregar
una explicación, un glosario o una ayuda en línea, con lo cual también habría un conflicto en-
tre los teoremas 2 y 5. Sin embargo, un buen escrito deberá lograr un equilibrio armónico en-
tre todos los teoremas.
Así pues, para lograr la armonía entre todos los teoremas habrá que trabajar y dominar dos
aspectos que pueden parecer contradictorios:
Creatividad y
Disciplina
Esto requiere tanto de conocer los fundamentos teóricos y experimentales de la buena docu-
mentación técnica como: practicar, practicar y practicar.
M a e s t r í a e n T e c n o l o g í a s d e I n f o r m a c i ó n - Página 3 de 96
Documentación Técnica
Lección 1.4 Mapeo de Información
Qué es Ya que la escritura tradicional no satisface las necesidades de la revolución de información que
tiene lugar en este momento, se ha desarrollado una nueva manera de organizar y presentar
la información, basada en principios experimentales de la comunicación clara.
El Mapeo de Información significa convertir el documento en un verdadero mapa, con frag-
mentos claros y señalamientos 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 Información.
Sus bases La metodología del Mapeo de Información está basada en más de veinte años de investigación
sobre la forma en que la gente lee y entiende la información.
El Mapeo de Información parte de determinar a quién va dirigido el documento y qué se desea
lograr con él. Usa una terminología clara y sin ambigüedades. Va directamente al punto, es
conciso. Cada fragmento de información muestra una sola idea, es decir, forma un “bocado”
de información (information chunk). La notación 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
más pequeñas y detalladas. Esta estructura es inmediatamente visible por el arreglo del texto y
el uso de la tipografía.
Al mapear información se construyen mapas con diferente nivel de detalle, de tal modo que
pueden hacerse acercamientos según las necesidades del lector. Es decir, permite una lectura
ejecutiva u operativa, por la forma en que está presentado.
M a e s t r í a e n T e c n o l o g í a s d e I n f o r m a c i ó n - Página 4 de 96
Documentación Técnica
Lección 1.5 Ventajas
Introducción Hacer buenos documento técnicos y usar los principios del Mapeo de Información tiene ven-
tajas importantes. En las siguientes secciones se enlistan estas ventajas.
Ventajas de hacer ¿Qué ventajas tiene para ti desarrollar la capacidad de elaborar documentos técnicos de alta
buenos documentos calidad, con gran rapidez y que logren su objetivo? Independientemente de las ventajas eviden-
tes 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 sólo brillante sino exi-
toso.
Esto es, la capacidad de elaborar documentos técnicos de alta calidad puede motivar:
Una promoción en el puesto de trabajo (o la obtención del puesto)
El reconocimiento de tus aportaciones
La aceptación de tus propuestas
Un aumento de sueldo
Que tus ideas se conviertan en realidad
Ventajas del Mapeo de Los estudios científicos han demostrado que el Mapeo de Información tiene ventajas:
Información 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 más pronto
Un 57% menos en el número 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 traducción
M a e s t r í a e n T e c n o l o g í a s d e I n f o r m a c i ó n - Página 5 de 96
