Unidad I

Introduccin

Do cumentacin tcnica

Esquema conceptual: Unidad I

Elaboracin de un buen documento tcnico
Teoremas
Conflicto entre teoremas

2. Caractersticas e
importancia de la
buena documentacin
tcnica

Definicin de documento
tcnico

1. Conceptualizacin de
documentacin tcnica

3. Tipos de documentos
tcnicos

Variedad
Caractersticas
Conclusin

UNIDAD I
Introduccin

12

7. Estructura del documento

4. Tipos de documentos
por su objetivo o funcin
Clasificacin de los
documentos tcnicos
Por su objetivo

Partes del documento tcnico

6. Tipos de documentos por su

forma de distribucin
Impresos
Electrnico
Proyectores

5. Tipos de documentos por su

estilo de presentacin
Texto
Texto e ilustraciones
Ilustraciones

Semana 1

Unida d I. Introduccin

Presentacin

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.

Objetivos especficos
El alumno analizar y valorar las nociones bsicas sobre la documentacin tcnica y los elementos necesarios en la elaboracin de un buen documento para su
aplicacin en la vida profesional.

Tema y subtemas
I.I Introduccin
I.1

Conceptualizacin de documentacin tcnica

Caractersticas e importancia de la buena

documentacin tcnica
I.3 Tipos de documentos tcnicos (texto,

reporte, manual, instructivo, apuntes, guas, etc.)
I.2

13

Do cumentacin tcnica

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 beneficiarnos con los descubrimientos y
avances es preservarlos de forma escrita, ya sea impresa en los tradicionales libros
y revistas o de manera electrnica.
Definicin de
documento tcnico

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 aquel documento que no es una obra literaria y que est relacionado con el mbito laboral, tecnolgico o cientfico.

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 definir la eficiencia que tenga al ser consultado por los
destinatarios. Estas reglas no se refieren solamente a aspectos estticos o de inspiracin del escritor, sino a reglas precisas y estrictas, que sin dejar a un lado un aspecto agradable a la vista o una organizacin y uso de recursos grficos, el material
logre su propsito primordial de presentar informacin concreta.

14

Elaboracin de un
buen documento tcnico

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:

Teoremas de la
escritura tcnica

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. Identificar a los destinatarios y escribir de manera apropiada para ellos.
2. Escribir con claridad.
3. Escribir de manera concisa.

Unida d I. Introduccin

4. Captar la atencin de los destinatarios.

5. Ayudar al lector a la fcil comprensin.
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.

Conflicto entre
teoremas de la
escritura tcnica

As pues, para lograr la armona entre todos los teoremas habr que dominar
dos aspectos que pueden parecer contradictorios:

Aspectos para lograr la

armona en la escritura

Creatividad
Disciplina
Esto requiere tanto de conocer los fundamentos tericos y experimentales de
la buena documentacin tcnica como de practicar, practicar y practicar.
Qu teoremas te parecen ms relevantes?

15

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
Oficios
Documentacin de software
Presentaciones por computadora
Circulares
Manuales de usuario
Manuales de organizacin
Pginas web
Apuntes
Libros de texto
Artculos cientficos
Guas
Reportes
Instructivos

Variedad de
documentos tcnicos

Do cumentacin tcnica

Un poema es un documento tcnico?

Caractersticas de los
documentos tcnicos

Los documentos tcnicos pueden dividirse segn su estilo, forma de presentacin y de distribucin, adems cuentan con una estructura en particular y cumplen una serie de principios, de tcnicas para mapear la informacin, para estructurar bloques de informacin, para etiquetarlos, para ilustrarlos y para utilizar
la tipografa, por supuesto, tambin deben seguir las reglas de escritura, como las
ortogrficas y el uso correcto de la sintaxis.

Importancia de la
planeacin en la
documentacin tcnica

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 programa realizarlo.
No cualquier documento, aun siendo un manual, un reporte o un apunte, es
un documento tcnico eficiente si no cumple con los principios y reglas precisas
que se desarrollarn a lo largo de este curso.

Conclusin

16

La documentacin tcnica no se basa en una escritura tradicional, sino en

forma de organizar y presentar la informacin segn resultados de pruebas experimentales, en cuanto a la comunicacin clara. De ah el uso del concepto Mapeo
de informacin, que se abordar ms adelante.

Unida d I. Introduccin

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 identificar el perfil

de los lectores.

_____
17

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.

_____

Do cumentacin tcnica

Glosario
Teorema: Afirmacin que puede ser demostrada verdadera dentro de un marco lgico, esta afirmacin 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 organizacin con el fin de informar algn asunto en particular.
Oficio: Documento formal que se enva entre miembros de organizaciones, generalmente con el fin de informar o de solicitar algo.
Sintaxis: Disciplina de la gramtica que estudia la organizacin y el orden de las palabras 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
18

Gonzlez, M. (2005). Documentacin. Mxico: UNID.

Unida d I. Introduccin

Panel de verificacin
Instrucciones: Escribe en la lnea la letra correspondiente, F para falso y V para verdadero.
1. Cualquier documento puede convertirse en un documento tcnico.

F
_____

2. Un buen documento tcnico es de fcil lectura.

V
_____

3. Uno de los teoremas de la escritura tcnica es emplear imgenes que

acompaen al texto.

F
_____

4. Los teoremas de la escritura tcnica no se contraponen en ningn momento

entre s.

F
_____

5. Un poema tambin es un documento tcnico.

F
_____

6. Un documento tcnico no tiene por qu ser agradable al lector.

F
_____

7. Para realizar un buen documento tcnico es preciso identificar el perfil

de los lectores.

V
_____
19

8. En un documento tcnico es preciso escribir de manera concisa y no abundar en

detalles que confundan al lector.

_____
V

9. Un elemento importante al elaborar un documento tcnico es la creatividad.

_____
V

10. No cualquier correo electrnico es un documento tcnico, para serlo debe cumplir
con ciertas caractersticas.

V
_____