20

Documentaci n tcni ca
S
e
m
a
n
a

2
Presentacin
P
ara elaborar documentos tcnicos deben seguirse ciertas reglas, las cuales es-
tn en funcin de las caractersticas y el tipo de documento. Por lo tanto, es
indispensable identifcar la categora en la que se escribir el documento. Una vez
que se defnen las opciones a utilizar, puede avanzarse en la planeacin del docu-
mento.
Los documentos pueden identifcarse segn su objetivo o funcin, su estilo
de presentacin o su forma de distribucin. Los elementos del documento forman
la estructura, que organizada de tal forma permite cumplir con su propsito.
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.4 Tipos de documentos por su objetivo o funcin
I.5 Tipos de documentos por su estilo de presentacin
I.6 Tipos de documentos por su forma de distribucin
I.7 Estructura del documento
21
Uni dad I . I ntroducci n
Un documento puede clasifcarse:
Por su funcin
Por su estilo de presentacin
Por su medio de distribucin
I.4 Tipos de documentos por su
objetivo o funcin
En general, los documentos tcnicos se pueden clasifcar en seis tipos de acuerdo
con su objetivo primordial:
Manuales: de usuario, de referencia, prontuarios, de procedimientos, de
organizacin, etc. Un manual se escribe en forma imperativa, es decir, da
indicaciones precisas para actuar.
Reportes: listados, formas, formatos, cuadros, machotes, etc. Cabe se-
alar que todo formato debe ser fcil de llenar, debe tener una estructura
lgica y bien defnida. Los reportes deben brindar facilidad visual para
encontrar informacin importante.
Comunicados: ofcios, circulares, memorndums, correos electrnicos,
etc. Un comunicado debe ser atractivo, debe contener toda la informa-
cin relevante en una secuencia lgica.
Presentaciones: material para cursos, apoyo didctico, exposiciones, po-
nencias, etc. Lo que se presente en pantalla debe ser muy breve, conciso y
bien estructurado.
Ayudas en lnea: archivos con documentacin para uso de sofware, que
pueden ser utilizados en forma local o va remota. Deben ser cortos, frag-
mentados, con ndice y glosario.
Documentos interactivos: sitios web, demostraciones, discos compac-
tos, formas electrnicas, etc. En estos documentos no debe abusarse de
los elementos visuales. Pueden contener animaciones, multimedia, entre
otros recursos, pero siempre de manera pertinente y cuidadosa.
Cul documento debe escribirse de forma imperativa?
Documentos por su
objetivo o funcin
Clasifcacin de los
documentos tcnicos
22
Documentaci n tcni ca
I.5 Tipos de documentos por su estilo
de presentacin
Los documentos tcnicos pueden presentarse en tres estilos bsicos:
Texto
Texto e ilustraciones
Ilustraciones
Aun cuando actualmente los programas de cmputo, escneres, cmaras di-
gitales y otros recursos hacen ms sencilla la inclusin de ilustraciones en los do-
cumentos, stas slo deben usarse para apoyar la comprensin del contenido. De
otro modo, no solamente sern intiles, sino que harn ms difcil la lectura del
texto.
El documento de texto debe tener una estructura perfectamente bien defnida
y clara a simple vista para el lector. Por ejemplo:
Entorno y navegacin
1. Cmo navegar en curso.
2. Cmo ver todas las actividades de un mismo tipo.
3. Cmo reconocer el tipo de actividad por su icono.
4. Cmo mostrar un slo tema del curso.
5. Cmo mostrar todos los temas del curso.
6. Cmo ver las novedades.
7. Cmo ir a la sede ocial de Moodle.
El uso de los grfcos o ilustraciones debe servir para facilitar la comprensin
del contenido, en forma adicional al texto. Por ejemplo:
Documentos por su
estilo de presentacin
Caractersticas del
documento de texto
Caractersticas del
documento de texto
e ilustraciones
23
Uni dad I . I ntroducci n
En los documentos de ilustraciones prcticamente toda la informacin se ex-
plica a travs de stas, con poco o ningn texto. Son tiles para ser comprendidos
por nios, para textos de aprendizaje de idiomas o para facilitar la comprensin de
personas que hablan distintas lenguas. Por ejemplo:
Caractersticas
del documento de
ilustraciones
1.6 Tipos de documentos por su
forma de distribucin
Es indispensable considerar la forma en que el documento se har llegar a los lec-
tores. No es lo mismo un documento impreso que un documento electrnico.
Ser distinto si se enva en original que si se sacan fotocopias, si se presenta a tra-
vs de un proyector o se ve directamente del monitor. Todo esto ser fundamental
para defnir el contenido, la tipografa y el diseo del documento. En general, se
tienen tres grandes medios de distribucin:
Documentos impresos
Documentos electrnicos
Documentos para presentacin en pantalla
Los documentos impresos se conservan en algn tipo de papel. Entre ellos
tenemos hojas sueltas, cuadernos, engargolados, libros, etc. Este tipo de docu-
mentos parece tender a disminuir puesto que su elaboracin resulta ms cara y
laboriosa que los documentos electrnicos. Sin embargo, cierta informacin re-
quiere estar impresa para ser fcil de manejar y/o confable. Por ejemplo: facturas,
libros, cartas, revistas, etctera.
Documentos por el
medio de distribucin
Caractersticas de los
documentos impresos
24
Documentaci n tcni ca
Los documentos electrnicos tienen cada vez mayor auge, ya que se distri-
buyen rpidamente y ahorran papel. Entre ellos tenemos el correo electrnico y
archivos en formato word o pdf, pginas web, entre otros.
Los documentos para presentaciones tienen el objetivo de mostrar de ma-
nera simultnea a varias personas cierta informacin. Estos documentos se apo-
yan de proyector, acetatos, diapositivas, etctera.
Caractersticas de
los documentos
electrnicos
Caractersticas de
los documentos para
presentaciones
Qu forma de distribucin preeres utilizar?
I.7 Estructura del documento
Aun cuando sea muy breve, un documento tcnico suele tener tres partes:
El prembulo: es la parte inicial del texto con la cual generalmente el lec-
tor se da una primera idea del contenido. Est conformado por elementos
como: portada, tabla de contenido e introduccin.
El contenido: descripcin del entorno, desarrollo y conclusin.
Las referencias: apndices, fuentes e ndices (analtico, tablas, fguras,
autoridades, cdigo, etc.)
Existen documentos que carecen de alguno de estos elementos, pero en gene-
ral es recomendable que aparezcan todos.
Partes del documento
tcnico
Portada
Tabla de contenido
Introduccin
Descripcin del entorno
Desarrollo
Conclusin
Apndices
Fuentes
ndices
Prembulo
Referencias
Contenido
Documento tcnico

25
Uni dad I . I ntroducci n
Importancia de la
portada
Diferencias entre ndice
y tabla de contenido
La portada es esencial y no debe descuidarse, ya que genera la primera impre-
sin del lector acerca del documento. Puede depender de la portada si el docu-
mento se lee o no.
En ocasiones se confunde el ndice con la Tabla de contenido. La enumera-
cin de los temas (captulos, secciones, etc.) con sus respectivos nmeros de p-
gina es la tabla de contenido, que se coloca al inicio del documento para que el
lector pueda tener una idea rpida y general sobre lo que encontrar en l.
Un ndice, en cambio, es una lista de autores, palabras o temas. Tambin se
conocen como ndices analticos, ndices de temas o ndices de autoridades.
26
Documentaci n tcni ca
Reactivos de autoevaluacin
Instrucciones: Escribe en la lnea la letra correspondiente, F para falso y V para verdadero.
1. Una de las formas en que los documentos pueden clasifcarse es por su estilo de
presentacin. _____
2. En general, los documentos tcnicos pueden clasifcarse en 6 tipos: manuales,
reportes, documentos impresos, presentaciones, ayudas en lnea y documentos
interactivos. _____
3. Un documento interactivo debe contener un gran nmero de elementos vistosos,
de otra forma no cumplir con su funcin. _____
4. Segn su estilo de presentacin, los documentos pueden ser ayudas en lnea,
documentos interactivos y con ilustraciones. _____
5. Segn su estilo de presentacin, hay documentos de texto o texto combinado con
ilustraciones, pero no slo de ilustraciones. _____
6. Segn el medio de distribucin, los documentos pueden ser: impresos,
electrnicos o para presentacin en pantalla. _____
7. Los documentos electrnicos se usan cada vez ms. _____
8. Los documentos que se presentan a travs de proyecciones solamente son vlidos
si se realizan con apoyo de un videoproyector. _____
9. Un documento tcnico est formado por el prembulo, el contenido y las
referencias, a su vez cada parte cuenta con subsecciones. _____
10. No es necesario colocar una portada en un documento tcnico breve. _____
11. El ndice no es igual a la tabla de contenido. _____
27
Uni dad I . I ntroducci n
Machote: Trmino que se da al formato de un documento que se emplea a modo
de plantilla.
Tipografa: Arte o tcnica de seleccionar y manipular tipos de letra para reprodu-
cir la comunicacin a travs de la palabra impresa, con el fn de transmitir
de forma hbil, elegante y efcaz las palabras.
ndice analtico: Listado por conceptos, los ms relevantes del texto en el que se
indica los nmeros de pgina en que cada uno se encuentra a lo largo de la
obra.
ndice de temas: Listado organizado segn los temas generales abordados en la
obra.
ndice de autoridades: Listado de los autores consultados para realizar la obra.
Gonzlez, M. (2005). Documentacin. Mxico: UNID.
Fuentes de informacin
Glosario
28
Documentaci n tcni ca
V
F
F
F
F
V
V
F
V
F
V
Panel de verifcacin
Instrucciones: Escribe en la lnea la letra correspondiente, F para falso y V para verdadero.
1. Una de las formas en que los documentos pueden clasifcarse es por su estilo de
presentacin. _____
2. En general, los documentos tcnicos pueden clasifcarse en 6 tipos: manuales,
reportes, documentos impresos, presentaciones, ayudas en lnea y documentos
interactivos. _____
3. Un documento interactivo debe contener un gran nmero de elementos vistosos,
de otra forma no cumplir con su funcin. _____
4. Segn su estilo de presentacin, los documentos pueden ser ayudas en lnea,
documentos interactivos y con ilustraciones. _____
5. Segn su estilo de presentacin, hay documentos de texto o texto combinado con
ilustraciones, pero no slo de ilustraciones. _____
6. Segn el medio de distribucin, los documentos pueden ser: impresos,
electrnicos o para presentacin en pantalla. _____
7. Los documentos electrnicos se usan cada vez ms. _____
8. Los documentos que se presentan a travs de proyecciones solamente son vlidos
si se realizan con apoyo de un videoproyector. _____
9. Un documento tcnico est formado por el prembulo, el contenido y las
referencias, a su vez cada parte cuenta con subsecciones. _____
10. No es necesario colocar una portada en un documento tcnico breve. _____
11. El ndice no es igual a la tabla de contenido. _____