Tipos de Documentos Técnicos

Nombre: Tipos de documentos
Contextualización
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.
Los documentospueden 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.

Documentación Técnica
2
Introducción al Tema
La estructura de un documento aunque sea muy breve, un documento técnico suele tener tres partes: • El preámbulo: es laparte 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.)
Existen documentos que carecen de alguno de estoselementos, pero en general es recomendable que aparezcan todos.

Documento técnico
Preámbulo
Referencias
Contenido
Portada Tabla de contenido Introducción
Descripción del entorno Desarrollo Conclusión
Apéndices Fuentes Índices
Documentación Técnica
3
Explicación
TIPOS DE DOCUMENTOS 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
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 paraactuar. • 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. • Comunicados: oficios, circulares, memorándums, correos electrónicos, etc. Un comunicado debe ser atractivo, debe contener toda lainformación relevante en una secuencia lógica. • 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.Documentación Técnica
4
• 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.
¿Cuál documento debe escribirse de forma imperativa?
Tipos de documentos por su estilo de presentaciónLos documentos técnicos pueden presentarse en tres estilos básicos: • Texto • Texto e ilustraciones • Ilustraciones
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 queharán más difícil la lectura del texto.
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...