Para elaborar documentos técnicos deben seguirse ciertas reglas, las cuales están

Transcripción

1 Semana 2 Presentació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. Objetivos específicos 20 El alumno analizará y valorará las nociones básicas sobre la documentación técnica y los elementos necesarios en la elaboración de un buen documento para su aplicación en la vida profesional. Tema y subtemas I. I Introducción I.4 Tipos de documentos por su objetivo o función I.5 Tipos de documentos por su estilo de presentación I.6 Tipos de documentos por su forma de distribución I.7 Estructura del documento

2 Unida d I. Introducción Un documento puede clasificarse: Por su función Clasificación de los documentos técnicos Por su estilo de presentación Por su medio de distribución I.4 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: Documentos por su objetivo o función 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. 21 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. 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?

3 I.5 Tipos de documentos por su estilo de presentación 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. Características del documento de texto El documento de texto debe tener una estructura perfectamente bien definida y clara a simple vista para el lector. Por ejemplo: 22 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. Características del documento de texto e ilustraciones El uso de los gráficos o ilustraciones debe servir para facilitar la comprensión del contenido, en forma adicional al texto. Por ejemplo:

4 Unida d I. Introducción En los documentos de ilustraciones prácticamente toda la información se explica a través de éstas, con poco o ningún texto. Son útiles para ser comprendidos por niños, para textos de aprendizaje de idiomas o para facilitar la comprensión de personas que hablan distintas lenguas. Por ejemplo: Características del documento de ilustraciones 1.6 Tipos de documentos por su forma de distribución 23 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 por el medio 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. Características de los documentos impresos

5 Características de los documentos electrónicos Características de los documentos para presentaciones 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? I.7 Estructura del documento Partes del documento técnico Aun cuando 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. 24 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

6 Unida d I. Introducción 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. En ocasiones se confunde 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. Importancia de la portada Diferencias entre índice y tabla de contenido 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. 25

7 Reactivos de autoevaluación Instrucciones: Escribe en la línea la letra correspondiente, F para falso y V para verdadero Una de las formas en que los documentos pueden clasificarse es por su estilo de presentación. 2. En general, los documentos técnicos pueden clasificarse en 6 tipos: manuales, reportes, documentos impresos, presentaciones, ayudas en línea y documentos interactivos. 3. Un documento interactivo debe contener un gran número de elementos vistosos, de otra forma no cumplirá con su función. 4. Según su estilo de presentación, los documentos pueden ser ayudas en línea, documentos interactivos y con ilustraciones. 5. Según su estilo de presentación, hay documentos de texto o texto combinado con ilustraciones, pero no sólo de ilustraciones. 6. Según el medio de distribución, los documentos pueden ser: impresos, electrónicos o para presentación en pantalla. 7. Los documentos electrónicos se usan cada vez más. 8. Los documentos que se presentan a través de proyecciones solamente son válidos si se realizan con apoyo de un videoproyector. 9. Un documento técnico está formado por el preámbulo, el contenido y las referencias, a su vez cada parte cuenta con subsecciones. 10. No es necesario colocar una portada en un documento técnico breve. 11. El índice no es igual a la tabla de contenido.

8 Unida d I. Introducción Glosario Machote: Término que se da al formato de un documento que se emplea a modo de plantilla. Tipografía: Arte o técnica de seleccionar y manipular tipos de letra para reproducir la comunicación a través de la palabra impresa, con el fin de transmitir de forma hábil, elegante y eficaz las palabras. Índice analítico: Listado por conceptos, los más relevantes del texto en el que se indica los números de página en que cada uno se encuentra a lo largo de la obra. Índice de temas: Listado organizado según los temas generales abordados en la obra. Índice de autoridades: Listado de los autores consultados para realizar la obra. Fuentes de información González, M. (2005). Documentación. México: UNID. 27

9 Panel de verificación Instrucciones: Escribe en la línea la letra correspondiente, F para falso y V para verdadero Una de las formas en que los documentos pueden clasificarse es por su estilo de presentación. 2. En general, los documentos técnicos pueden clasificarse en 6 tipos: manuales, reportes, documentos impresos, presentaciones, ayudas en línea y documentos interactivos. 3. Un documento interactivo debe contener un gran número de elementos vistosos, de otra forma no cumplirá con su función. 4. Según su estilo de presentación, los documentos pueden ser ayudas en línea, documentos interactivos y con ilustraciones. 5. Según su estilo de presentación, hay documentos de texto o texto combinado con ilustraciones, pero no sólo de ilustraciones. 6. Según el medio de distribución, los documentos pueden ser: impresos, electrónicos o para presentación en pantalla. V F F F F V 7. Los documentos electrónicos se usan cada vez más. V 8. Los documentos que se presentan a través de proyecciones solamente son válidos si se realizan con apoyo de un videoproyector. 9. Un documento técnico está formado por el preámbulo, el contenido y las referencias, a su vez cada parte cuenta con subsecciones. F V 10. No es necesario colocar una portada en un documento técnico breve. F 11. El índice no es igual a la tabla de contenido. V