DOCUMENTACIÓN TÉCNICA

Transcripción

1 DOCUMENTACIÓN TÉCNICA

2 Documentación Técnica 1 Sesión No. 2 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 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.

3 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 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.) Existen documentos que carecen de alguno de estos elementos, pero en general es recomendable que aparezcan todos. Preámbulo Portada Tabla de contenido Introducción Documento técnico Contenido Descripción del entorno Desarrollo Conclusión Referencias Apéndices Fuentes Índices

4 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 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. Comunicados: oficios, circulares, memorándums, correos electrónicos, etc. Un comunicado debe ser atractivo, debe contener toda la informació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.

5 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ón Los 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 que hará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 del curso. 6. Cómo ver las novedades. 7. Cómo ir a la sede oficial de Moodle.

6 Documentación Técnica 5 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. 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 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. Sin embargo, cierta información requiere estar impresa para ser fácil de manejar y/o confiable. Por ejemplo: facturas, libros, cartas, revistas, etcétera. 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. 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. Qué forma de distribución prefieres utilizar?

7 Documentación Técnica 6 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. 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. Y un índice, en cambio, es una lista de autores, palabras o temas. También se conocen como índices analíticos, índices de temas o índices de autoridades.

8 Documentación Técnica 7 Para aprender más La estructura del trabajo escrito Mejía, J. (2013). La estructura del trabajo escrito. Documento obtenido de Normas ICONTEC para la presentación de trabajos escritos Nieto Ruiz, L. F. (2012) Normas ICONTEC para la presentación de trabajos escritos. Documento obtenido de

9 Documentación Técnica 8 Actividad de Aprendizaje Instrucciones: La actividad a realizar reforzará el tema de tipos de documentos técnicos, lo cual ayudará a analizar y valorar lo básico acerca de los documentos y los elementos necesarios en la elaboración de un buen documento para su aplicación en la vida profesional. La actividad trata de escoger 5 documentos e identificar qué tipo de documento es por ejemplo por su función, por su estilo de presentación o por su forma de distribución. Se realizará por computadora en formato PDF, lo cual se subirá a la plataforma para ser revisado. Esta actividad tiene un porcentaje del 5% de tu calificación y se tomará en cuenta lo siguiente: carátula introducción 5 documentos conclusión redacción

10 Documentación Técnica 9 Bibliografía González, M. (2005). Documentación. México: UNID. Mejía, J. (2013). La estructura del trabajo escrito. Documento obtenido de Nieto Ruiz, L. F. (2012) Normas ICONTEC para la presentación de trabajos escritos. Documento obtenido de