U

n
i
d
a
d

I
Introduccin
Introduccin
12
Documentaci n tcni ca
Esquema conceptual: Unidad I
Variedad
Caractersticas
Conclusin
Texto
Texto e ilustraciones
Ilustraciones
UNIDAD I
Introduccin
Defnicin de documento
tcnico
Clasifcacin de los
documentos tcnicos
Por su objetivo
1. Conceptualizacin de
documentacin tcnica
Elaboracin de un buen documento tcnico
Teoremas
Conficto entre teoremas
2. Caractersticas e
importancia de la
buena documentacin
tcnica
4. Tipos de documentos
por su objetivo o funcin
Partes del documento tcnico
3. Tipos de documentos
tcnicos
Impresos
Electrnico
Proyectores
7. Estructura del documento
6. Tipos de documentos por su
forma de distribucin
5. Tipos de documentos por su
estilo de presentacin
13
Uni dad I . I ntroducci n
S
e
m
a
n
a

1
Presentacin
P
robablemente debas escribir en tus actividades cotidianas, ya sea al redactar
un correo electrnico, un recado, una gua o hasta un manual de usuario o un
reporte. La comunicacin escrita es fundamental en gran parte de las actividades
de la gente, especialmente en las laborales.
En esta sesin sabrs qu es un documento tcnico, qu caractersticas debe
tener un documento de calidad para que cumpla con su objetivo y qu ventajas
tiene el uso de la metodologa que ofrece este curso.
I.1 Conceptualizacin de documentacin tcnica
I. Introduccin
Tema y subtemas
I
Objetivos especfcos
El alumno analizar y valorar las nociones bsicas sobre la documentacin tc-
nica y los elementos necesarios en la elaboracin de un buen documento para su
aplicacin en la vida profesional.
I.2 Caractersticas e importancia de la buena
documentacin tcnica
I.3 Tipos de documentos tcnicos (texto,
reporte, manual, instructivo, apuntes, guas, etc.)
14
Documentaci n tcni ca
Defnicin de
documento tcnico
I.1 Conceptualizacin de
documentacin tcnica
La documentacin tcnica es uno de los pilares de nuestra civilizacin. La forma
en que la mayora de nosotros podemos benefciarnos con los descubrimientos y
avances es preservarlos de 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 efcaz-
mente a los lectores. De manera muy sencilla podemos defnir un documento tc-
nico como todo aquel documento que no es una obra literaria y que est relacio-
nado con el mbito laboral, tecnolgico o cientfco.
I.2 Caractersticas e importancia de la
buena documentacin tcnica
Para escribir un buen documento tcnico es preciso seguir una serie de reglas,
cuya correcta aplicacin defnir la efciencia que tenga al ser consultado por los
destinatarios. Estas reglas no se referen solamente a aspectos estticos o de inspi-
racin del escritor, sino a reglas precisas y estrictas, que sin dejar a un lado un as-
pecto agradable a la vista o una organizacin y uso de recursos grfcos, el material
logre su propsito primordial de presentar informacin concreta.
Al hacer este tipo de documentos, el reto es lograr que los destinatarios real-
mente los lean y asimilen su contenido. Un documento bien elaborado debe invi-
tar a la lectura. Un buen documento es agradable al lector, aun cuando ste proba-
blemente 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.
Al escribir un documento se deben seguir los siguientes teoremas:
1. Identifcar a los destinatarios y escribir de manera apropiada para ellos.
2. Escribir con claridad.
3. Escribir de manera concisa.
Elaboracin de un
buen documento tcnico
Teoremas de la
escritura tcnica
15
Uni dad I . I ntroducci n
Aspectos para lograr la
armona en la escritura
4. Captar la atencin de los destinatarios.
5. Ayudar al lector a la fcil comprensin.
Suele ocurrir que los teoremas entren en conficto uno con otro. Por ejemplo,
para escribir un concepto con sufciente claridad puede requerirse de un texto
ms extenso, con lo cual entraran en conficto 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 conficto 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 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 de practicar, practicar y practicar.
Variedad de
documentos tcnicos
Conficto entre
teoremas de la
escritura tcnica
Qu teoremas te parecen ms relevantes?
I.3 Tipos de documentos tcnicos
(texto, reporte, manual,
instructivo, apuntes, guas, etc.).
Existe gran variedad de documentos tcnicos, con los cuales seguramente ests
familiarizado:
Correo electrnico
Mensajes instantneos
Ofcios
Documentacin de sofware
Presentaciones por computadora
Circulares
Manuales de usuario
Manuales de organizacin
Pginas web
Apuntes
Libros de texto
Artculos cientfcos
Guas
Reportes
Instructivos
16
Documentaci n tcni ca
Los documentos tcnicos pueden dividirse segn su estilo, forma de presen-
tacin y de distribucin, adems cuentan con una estructura en particular y cum-
plen una serie de principios, de tcnicas para mapear la informacin, para es-
tructurar bloques de informacin, para etiquetarlos, para ilustrarlos y para utilizar
la tipografa, por supuesto, tambin deben seguir las reglas de escritura, como las
ortogrfcas y el uso correcto de la sintaxis.
Para realizar un documento tcnico de calidad, adems de tomar en cuenta
sus fundamentos, se requiere de una planeacin cuidadosa, en la que se analice la
pertinencia de elaborar el documento, adems de cmo, cundo y en qu progra-
ma realizarlo.
No cualquier documento, aun siendo un manual, un reporte o un apunte, es
un documento tcnico efciente si no cumple con los principios y reglas precisas
que se desarrollarn a lo largo de este curso.
La documentacin tcnica no se basa en una escritura tradicional, sino en
forma de organizar y presentar la informacin segn resultados de pruebas expe-
rimentales, en cuanto a la comunicacin clara. De ah el uso del concepto Mapeo
de informacin, que se abordar ms adelante.
Caractersticas de los
documentos tcnicos
Conclusin
Importancia de la
planeacin en la
documentacin tcnica
Un poema es un documento tcnico?
17
Uni dad I . I ntroducci n
Reactivos de autoevaluacin
Instrucciones: Escribe en la lnea la letra correspondiente, F para falso y V para verdadero.
1. Cualquier documento puede convertirse en un documento tcnico. _____
2. Un buen documento tcnico es de fcil lectura. _____
3. Uno de los teoremas de la escritura tcnica es emplear imgenes que
acompaen al texto. _____
4. Los teoremas de la escritura tcnica no se contraponen en ningn momento
entre s. _____
5. Un poema tambin es un documento tcnico. _____
6. Un documento tcnico no tiene por qu ser agradable al lector. _____
7. Para realizar un buen documento tcnico es preciso identifcar el perfl
de los lectores. _____
8. En un documento tcnico es preciso escribir de manera concisa y no abundar en
detalles que confundan al lector. _____
9. Un elemento importante al elaborar un documento tcnico es la creatividad. _____
10. No cualquier correo electrnico es un documento tcnico, para serlo debe cumplir
con ciertas caractersticas. _____
18
Documentaci n tcni ca
Glosario
Teorema: Afrmacin que puede ser demostrada verdadera dentro de un mar-
co lgico, esta afrmacin es verdadera bajo las condiciones en las que se
trabaja. Un teorema generalmente posee un nmero de condiciones que
pueden ser enumeradas o aclaradas de antemano.
Circulares: Documentos que se envan a diferentes miembros de una organiza-
cin con el fn de informar algn asunto en particular.
Ofcio: Documento formal que se enva entre miembros de organizaciones, gene-
ralmente con el fn de informar o de solicitar algo.
Sintaxis: Disciplina de la gramtica que estudia la organizacin y el orden de las pa-
labras en una oracin, as como la relacin que se establece entre esas mismas
palabras y la posicin que ocupan determinadas palabras especiales.
Fuentes de informacin
Gonzlez, M. (2005). Documentacin. Mxico: UNID.
19
Uni dad I . I ntroducci n
Panel de verifcacin
F
V
F
F
F
F
V
V
V
V
Instrucciones: Escribe en la lnea la letra correspondiente, F para falso y V para verdadero.
1. Cualquier documento puede convertirse en un documento tcnico. _____
2. Un buen documento tcnico es de fcil lectura. _____
3. Uno de los teoremas de la escritura tcnica es emplear imgenes que
acompaen al texto. _____
4. Los teoremas de la escritura tcnica no se contraponen en ningn momento
entre s. _____
5. Un poema tambin es un documento tcnico. _____
6. Un documento tcnico no tiene por qu ser agradable al lector. _____
7. Para realizar un buen documento tcnico es preciso identifcar el perfl
de los lectores. _____
8. En un documento tcnico es preciso escribir de manera concisa y no abundar en
detalles que confundan al lector. _____
9. Un elemento importante al elaborar un documento tcnico es la creatividad. _____
10. No cualquier correo electrnico es un documento tcnico, para serlo debe cumplir
con ciertas caractersticas. _____