Unidad I INTRODUCCIÓN

Transcripción

1 Unidad I INTRODUCCIÓN

2 Unidad I: Introducción Semana 1 A. PRESENTACIÓN Escribir es una actividad que suele ser cotidiana para muchas personas, desde redactar un correo electrónico, un recado, una guía, o hasta el realizar un manual de usuario o un reporte. La comunicación escrita es una actividad fundamental, para algunos especialmente en las laborales. En esta sesión se aborda qué es un documento técnico, cuáles son las características que distinguen a un documento de calidad para que cumpla su objetivo, además, se presentan las ventajas que tiene el uso de la metodología que se aborda en este curso. B. OBJETIVO ESPECÍFICO El alumno analizará 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. Licenciatura en Derecho 2

3 C. TEMA Y SUBTEMAS 1. INTRODUCCIÓN 1.1 Conceptualización de documentación técnica. 1.2 Características e importancia de la buena documentación técnica. 1.3 Tipos de documentos técnicos (texto, reporte, manual, instructivo, apuntes, guías, etc.). D. MAPA MENTAL: UNIDAD I Licenciatura en Derecho 3

4 E. CONTENIDO 1.1 Conceptualización de documentación técnica Un cuento es un documento técnico? 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 en forma escrita, ya sea impresa en los tradicionales libros y revistas o de manera electrónica. 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. Qué es un documento técnico? 1.2 Características e importancia de la buena documentación técnica Qué teoremas te parecen más relevantes? 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. 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 Un buen documento Licenciatura en Derecho 4

5 invitar a la lectura. Un buen documento es agradable al lector, aún 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. Para lograr un buen documento es indispensable seguir cinco teoremas. Teoremas de la escritura técnica Al escribir un documento se debe: 1. Identificar a los destinatarios y escribir de manera apropiada para ellos. 2. Escribir con claridad. 3. Escribir de manera concisa. 4. Captar la atención de los destinatarios. 5. Ayudar al lector. 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. Conflicto entre teoremas Así pues, para lograr la armonía entre todos los teoremas habrá que trabajar y dominar dos aspectos que pueden parecer contradictorios: Creatividad y Disciplina Licenciatura en Derecho 5

6 Esto requiere tanto de conocer los fundamentos teóricos y experimentales de la buena documentación técnica como: practicar, practicar y practicar. 1.3 Tipos de documentos técnicos (texto, reporte, manual, instructivo, apuntes, guías, etc.) Un oficio legal es un documento técnico? Existen gran variedad de documentos técnicos con los cuales seguramente estás familiarizado: 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. Licenciatura en Derecho 6

7 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, donde en principio se analice la propia pertinencia de elaborar el documento, además del cómo, cuándo y en qué programa realizarlo. Características de los documentos técnicos Importancia de la planeación en la documentación técnica De ahí que no cualquier documento, aún siendo un Manual, un reporte o apuntes, es un documento técnico eficiente si no cumple con los principios y reglas precisas que se desarrollan 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 Mapeo de información, que se abordará más adelante. Licenciatura en Derecho 7

8 F. CONCLUSIÓN Una vez que se ha identificado qué es un documento técnico, así como sus características e importancia para una comunicación eficiente, clara y útil, es preciso tener presente que existen diferentes tipos de documentos técnicos, cada uno de ellos persigue objetivos específicos y requiere de aspectos distintos para su elaboración. Es preciso seguir la guía de los conceptos iniciales de la documentación técnica, como son los del mapeo de información y los teoremas, así como su estilo, forma de presentación y de distribución. El primer paso para realizar un documento técnico es ubicar qué tipo de documento se pretende realizar, cuál será su estilo?, cómo se presentará y distribuirá?, enseguida podrán tomarse las decisiones para el mapeo de la información. Licenciatura en Derecho 8

9 G. LECTURAS COMPLEMENTARIAS Educar Chile (2013). Lenguaje: Texto Narrativo y Descriptivo. Consultado en diciembre de 2013 en ISEL (s/f) Tipos de texto, género y escrito. Consultado en diciembre de 2013 en H. GLOSARIO Término Significado Circulares Documentos que se envían a diferentes miembros de una organización con el fin de informar algún asunto en particular. Concisa Lenguaje o estilo donde se omiten detalles, rodeos o adornos, se aborda el objetivo de manera directa. Oficio Documento formal que se envía entre miembros de organizaciones, generalmente con el fin de informar o de solicitar algo. Sintaxis Disciplina que se deriva de la gramática estudia la organización y el orden de las palabras en la oración, así como la relación que se establece entre esas mismas palabras, y la posición que ocupan determinadas palabras especiales. Teorema Un teorema es una 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 en los teoremas o aclaradas de antemano. Licenciatura en Derecho 9

10 I. FUENTES DE INFORMACIÓN a) Bibliográficas González, M. (2005). Documentación Técnica. México: UNID. Licenciatura en Derecho 10