DOCUMENTACIÓN

TÉCNICA

Sesión 2: Tipos de documentos

Contextualización

Documentos técnicos

Para elaborar documentos técnicos deben

seguirse ciertas reglas, las cuales están

en función de las características y el tipo

de documento. Por lo tanto, es

indispensable identificar la categoría en la

que se escribirá el documento. Una vez

que se definen las opciones a utilizar,

puede avanzarse en la planeación del

documento.

Contextualización

Documentos técnicos

Los documentos pueden

identificarse según su objetivo o

función, su estilo de presentación o

su forma de distribución. Los

elementos del documento forman

la estructura, que organizada de tal

forma permite cumplir con su

propósito.

Introducción

¿Sabes cuál es la estructura de

un documento ?

La estructura de un documento aunque sea muy breve, un documento

técnico suele tener tres partes:

• El preámbulo: es la parte inicial

del texto con la cual

generalmente el lector se da una

primera idea del contenido. Está

conformado por elementos como:

portada, tabla de contenido e

introducción.

• El contenido: descripción del

entorno, desarrollo y conclusión.

• Las referencias: apéndices, fuentes

e índices (analítico, tablas, figuras,

autoridades, código, etc.)

Introducción

¿Sabes cuál es la estructura de

un documento ?

Existen documentos que carecen de alguno de estos elementos,

pero en general es recomendable que aparezcan todos.

Introducción

¿Sabes cuál es la estructura de

un documento ?

Introducción

¿Sabes cuál es la estructura de

un documento ?

Documento técnico

Preámbulo

Referencias

Contenido

Portada

Tabla de contenido

Introducción

Descripción del entorno

Desarrollo

Conclusión

Apéndices

Fuentes

Índices

Explicación

Clasificación de los documentos

Un documento puede clasificarse:

• Por su función

• Por su estilo de presentación

• Por su medio de distribución

Explicación

Tipos de documentos por su

objetivo o función

En general, los documentos técnicos se pueden clasificar en

seis tipos de acuerdo con su objetivo primordial:

• Manuales: de usuario, de referencia,

prontuarios, de procedimientos, de

organización, 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 fácil de llenar, debe

tener una estructura lógica y bien definida.

Los reportes deben brindar facilidad visual

para encontrar información importante.

relevante en una secuencia lógica.

Explicación

Tipos de documentos por su

objetivo o función

• Comunicados: oficios, circulares,

memorándums, correos electrónicos,

etc. Un comunicado debe ser atractivo,

debe contener toda la información

Explicación

Tipos de documentos por su

objetivo o función

• Presentaciones: material para cursos, apoyo

didáctico, exposiciones, ponencias, etc. Lo que se

presente en pantalla debe ser muy breve, conciso y

bien estructurado.

• Ayudas en línea: archivos con documentación

para uso de software, que pueden ser utilizados en

forma local o vía remota. Deben ser cortos,

fragmentados, con índice y glosario.

Explicación

Tipos de documentos por su

objetivo o función

• Documentos interactivos: sitios web, demostraciones, discos

compactos, formas electrónicas, 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.

Explicación

Tipos de documentos por su

objetivo o función

Explicación

Tipos de documentos por su estilo

de presentación

Los documentos técnicos pueden presentarse en tres estilos

básicos:

• Texto

• Texto e ilustraciones

• Ilustraciones

.

Explicación

Tipos de documentos por su estilo

de presentación

Los documentos técnicos pueden presentarse en tres estilos

básicos:

• Texto

• Texto e ilustraciones

• Ilustraciones

.

Explicación

Tipos de documentos por su estilo

de presentación

Aun cuando actualmente los programas

de cómputo, escáneres, cámaras

digitales y otros recursos hacen más

sencilla la inclusión de ilustraciones en

los documentos, éstas sólo deben

usarse para apoyar la comprensión del

contenido. De otro modo, no solamente

serán inútiles, sino que harán más difícil

la lectura del texto.

Explicación

Tipos de documentos por su estilo

de presentación

El documento de texto debe tener una estructura perfectamente bien definida y

clara a simple vista para el lector. Por ejemplo: Entorno y navegación

1. Cómo navegar en curso.

2. Cómo ver todas las actividades de un mismo tipo.

3. Cómo reconocer el tipo de actividad por su icono.

4. Cómo mostrar un sólo tema del curso.

5. Cómo mostrar todos los temas del curso.

6. Cómo ver las novedades.

7. Cómo ir a la sede oficial de Moodle.

Explicación

Tipos de documentos por su

forma de distribución

Es indispensable considerar la forma en

que el documento se hará llegar a los

lectores. No es lo mismo un documento

impreso que un documento electrónico.

Será distinto si se envía en original que si

se sacan fotocopias, si se presenta a

través de un proyector o se ve

directamente del monitor.

Explicación

Tipos de documentos por su

forma de distribución

Todo esto será fundamental para definir el

contenido, la tipografía y el diseño del

documento.

En general, se tienen tres grandes medios

de distribución:

• Documentos impresos

• Documentos electrónicos

• Documentos para presentación en pantalla

Explicación

Tipos de documentos por su

forma de distribución

Los documentos impresos se conservan

en algún tipo de papel. Entre ellos tenemos

hojas sueltas, cuadernos, engargolados,

libros, etc. Este tipo de documentos parece

tender a disminuir puesto que su elaboración

resulta más cara y laboriosa que los

documentos electrónicos.

Explicación

Tipos de documentos por su

forma de distribución

Los documentos electrónicos tienen

cada vez mayor auge, ya que se

distribuyen rápidamente y ahorran

papel. Entre ellos tenemos el correo

electrónico y archivos en formato word

o pdf, páginas web, entre otros.

Explicación

Tipos de documentos por su

forma de distribución

Los documentos para

presentaciones tienen el objetivo de

mostrar de manera simultánea a varias

personas cierta información. Estos

documentos se apoyan de proyector,

acetatos, diapositivas, etcétera.

Conclusión

Como pudimos aprender las partes de un documento técnico

sirven para poder estructurar y darle coherencia a un texto por

ejemplo: La portada es esencial y no debe descuidarse, ya que

genera la primera impresión del lector acerca del documento.

Puede depender de la portada si el documento se lee o no.

Conclusión

También tenemos que tener en cuenta y aprender para no

confundirnos con sus elementos por ejemplo: el Índice con la Tabla

de contenido. La enumeración de los temas (capítulos, secciones,

etc.) con sus respectivos números de página es la tabla de

contenido, que se coloca al inicio del documento para que el lector

pueda tener una idea rápida y general sobre lo que encontrará en

él.

Referencias

González, M. (2005). Documentación. México: UNID.

Josué Mejia (2013). La estructura del trabajo escrito documento obtenido

de http://www.slideshare.net/josuemejiarivera/la-estructura-del-trabajo-

escrito

Luis Fernando Nieto Ruiz (2012) normas ICONTEC para la presentación de

trabajos escritos Documento, obtenido de

http://www.slideshare.net/luferlu/trabajo-escrito-bajo-las-normas-icontec-

ltimo