Unidad I. Introducción

Transcripción

1 Unidad I Introducción

2 Do cumentación técnica Esquema conceptual: Unidad I Elaboración de un buen documento técnico Teoremas Conflicto entre teoremas Definición de documento técnico 2. Características e importancia de la buena documentación técnica 1. Conceptualización de documentación técnica 3. Tipos de documentos técnicos 12 UNIDAD I Introducción Variedad Características Conclusión 7. Estructura del documento 4. Tipos de documentos por su objetivo o función Partes del documento técnico Clasificación de los documentos técnicos Por su objetivo 6. Tipos de documentos por su forma de distribución 5. Tipos de documentos por su estilo de presentación Impresos Electrónico Proyectores Texto Texto e ilustraciones Ilustraciones

3 Unida d I. Introducción Semana 1 Presentación Probablemente debas escribir en tus actividades cotidianas, ya sea al redactar un correo electrónico, un recado, una guía o hasta un manual de usuario o un reporte. La comunicación escrita es fundamental en gran parte de las actividades de la gente, especialmente en las laborales. En esta sesión sabrás qué es un documento técnico, qué características debe tener un documento de calidad para que cumpla con su objetivo y qué ventajas tiene el uso de la metodología que ofrece este curso. Objetivos específicos 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. 13 Tema y subtemas I. I Introducción I.1 Conceptualización de documentación técnica I.2 Características e importancia de la buena documentación técnica I.3 Tipos de documentos técnicos (texto, reporte, manual, instructivo, apuntes, guías, etc.)

4 I.1 Conceptualización de documentación técnica Do cumentación técnica La documentación técnica es uno de los pilares de nuestra civilización. La forma en que la mayoría 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 electrónica. Definición de documento técnico Un documento técnico es aquel escrito que contiene información acerca de un área de conocimiento, organizada de forma estructurada y presentada eficazmente a los lectores. De manera muy sencilla podemos definir un documento técnico como todo aquel documento que no es una obra literaria y que está relacionado con el ámbito laboral, tecnológico o científico. I.2 Características e importancia de la buena documentación técnica 14 Para escribir un buen documento técnico es preciso seguir una serie de reglas, cuya correcta aplicación definirá la eficiencia que tenga al ser consultado por los destinatarios. Estas reglas no se refieren solamente a aspectos estéticos o de inspiración del escritor, sino a reglas precisas y estrictas, que sin dejar a un lado un aspecto agradable a la vista o una organización y uso de recursos gráficos, el material logre su propósito primordial de presentar información concreta. Elaboración de un buen documento técnico 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: Ser de fácil lectura. Permitir al lector obtener el mayor provecho de su contenido. Facilitar su actualización. Proporcionar distintos niveles de detalle. Teoremas de la escritura técnica 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.

5 Unida d I. Introducción 4. Captar la atención de los destinatarios. 5. Ayudar al lector a la fácil comprensión. 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 más extenso, con lo cual entrarían en conflicto los teoremas 2 y 3. Para ayudar al lector puede resultar conveniente agregar una explicación, un glosario o una ayuda en línea, con lo cual también habría un conflicto entre los teoremas 2 y 5. Sin embargo, un buen escrito deberá lograr un equilibrio armónico entre todos los teoremas. Así pues, para lograr la armonía entre todos los teoremas habrá que dominar dos aspectos que pueden parecer contradictorios: Conflicto entre teoremas de la escritura técnica Aspectos para lograr la armonía en la escritura Creatividad Disciplina Esto requiere tanto de conocer los fundamentos teóricos y experimentales de la buena documentación técnica como de practicar, practicar y practicar. Qué teoremas te parecen más relevantes? I.3 Tipos de documentos técnicos (texto, reporte, manual, instructivo, apuntes, guías, etc.). 15 Existe gran variedad de documentos técnicos, con los cuales seguramente estás familiarizado: Variedad de documentos técnicos Correo electrónico Mensajes instantáneos Oficios Documentación de software Presentaciones por computadora Circulares Manuales de usuario Manuales de organización Páginas web Apuntes Libros de texto Artículos científicos Guías Reportes Instructivos

6 Do cumentación técnica Un poema es un documento técnico? Características de los documentos técnicos Importancia de la planeación en la documentación técnica Los documentos técnicos pueden dividirse según su estilo, forma de presentación y de distribución, además cuentan con una estructura en particular y cumplen una serie de principios, de técnicas para mapear la información, para estructurar bloques de información, para etiquetarlos, para ilustrarlos y para utilizar la tipografía, por supuesto, también deben seguir las reglas de escritura, como las ortográficas y el uso correcto de la sintaxis. Para realizar un documento técnico de calidad, además de tomar en cuenta sus fundamentos, se requiere de una planeación cuidadosa, en la que se analice la pertinencia de elaborar el documento, además de cómo, cuándo y en qué programa realizarlo. 16 Conclusión No cualquier documento, aun siendo un manual, un reporte o un apunte, es un documento técnico eficiente si no cumple con los principios y reglas precisas que se desarrollarán a lo largo de este curso. La documentación técnica no se basa en una escritura tradicional, sino en forma de organizar y presentar la información según resultados de pruebas experimentales, en cuanto a la comunicación clara. De ahí el uso del concepto Mapeo de información, que se abordará más adelante.

7 Unida d I. Introducción Reactivos de autoevaluación Instrucciones: Escribe en la línea la letra correspondiente, F para falso y V para verdadero. 1. Cualquier documento puede convertirse en un documento técnico. 2. Un buen documento técnico es de fácil lectura. 3. Uno de los teoremas de la escritura técnica es emplear imágenes que acompañen al texto. 4. Los teoremas de la escritura técnica no se contraponen en ningún momento entre sí. 5. Un poema también es un documento técnico. 6. Un documento técnico no tiene por qué ser agradable al lector. 7. Para realizar un buen documento técnico es preciso identificar el perfil de los lectores. 8. En un documento técnico es preciso escribir de manera concisa y no abundar en detalles que confundan al lector Un elemento importante al elaborar un documento técnico es la creatividad. 10. No cualquier correo electrónico es un documento técnico, para serlo debe cumplir con ciertas características.

8 Do cumentación técnica Glosario Teorema: Afirmación que puede ser demostrada verdadera dentro de un marco lógico, esta afirmación es verdadera bajo las condiciones en las que se trabaja. Un teorema generalmente posee un número de condiciones que pueden ser enumeradas o aclaradas de antemano. Circulares: Documentos que se envían a diferentes miembros de una organización con el fin de informar algún asunto en particular. Oficio: Documento formal que se envía entre miembros de organizaciones, generalmente con el fin de informar o de solicitar algo. Sintaxis: Disciplina de la gramática que estudia la organización y el orden de las palabras en una oración, así como la relación que se establece entre esas mismas palabras y la posición que ocupan determinadas palabras especiales. Fuentes de información 18 González, M. (2005). Documentación. México: UNID.

9 Unida d I. Introducción Panel de verificación Instrucciones: Escribe en la línea la letra correspondiente, F para falso y V para verdadero Cualquier documento puede convertirse en un documento técnico. Un buen documento técnico es de fácil lectura. F V 3. Uno de los teoremas de la escritura técnica es emplear imágenes que acompañen al texto. 4. Los teoremas de la escritura técnica no se contraponen en ningún momento entre sí. F F 5. Un poema también es un documento técnico. F 6. Un documento técnico no tiene por qué ser agradable al lector. F 7. Para realizar un buen documento técnico es preciso identificar el perfil de los lectores. 8. En un documento técnico es preciso escribir de manera concisa y no abundar en detalles que confundan al lector. V V Un elemento importante al elaborar un documento técnico es la creatividad. V 10. No cualquier correo electrónico es un documento técnico, para serlo debe cumplir con ciertas características. V