ESTUDIO Y ELABORACIÓN DE DOCUMENTOS TÉCNICOS.pptx

Introducción y guía de elaboración de documentos técnicos para la industria basado en metodología de la investigación

1. ESTUDIO Y ELABORACIÓN DE DOCUMENTOS TÉCNICOS Docente: Ing. Juan José Domínguez Grajales

2. OBJETIVO El estudiante será capaz de comprender diversos documentos de la industria petrolera: leyes, decretos, manuales de operación y procedimientos, informes oficiales, entre otros. Será capaz de redactar correctamente un informe de observación de algunas de las materias de estudio con las que esté familiarizado.

3. Criterios de Evaluación Los estudiantes comprenden y emplean los conceptos de la industria petrolera, producen textos propios de su campo profesional, amplían su acervo documental cultura de utilidad e importancia para su formación como ingenieros químicos.

4. CONTENIDO TEMÁTICO 1.- Lexicología básica de la industria petrolera Conceptos fundamentales utilizados en informes oficiales Conceptos utilizados en manuales de operación y procedimientos Conceptos utilizados en bibliografía especializada (economía, física, química, etc.)

5. 2.- Lectura y comprensión de textos Objetivos e intencionalidad de textos públicos y privados Planteamiento y solución de problemas Análisis crítico de textos (ausencias, problemas no resueltos, afirmaciones no sustentadas, etc.)

6. 3.- Elaboración de registros e informes de trabajo Registros de observación: uso de texto e imágenes (videos, testimonios auditivos, etc.) Informes de trabajo: objetivos, procedimientos, resultados Elementos para una redacción profesional adecuada

7. ACTIVIDADES DE APRENDIZAJE INDEPENDIENTES Los estudiantes realizarán lecturas y búsquedas de información para corroborar y profundizar en los problemas tratados en clase. Podrán utilizar textos analizados en otras materias, desentrañar problemas de comprensión y plantear análisis y críticas en sus participaciones en el aula.

8. ACTIVIDAD NO.1 En su cuaderno escribir con sus propias palabras en 1 cuartilla que EXPECTATIVAS Y COMPROMISOS A ADQUIRIR DEL CURSO, ASÍ COMO DEBILIDADES Y FORTALEZAS ACÁDEMICAS, COMO VINCULA LOS TEMAS DE LA ASIGNATURA CON EL SECTOR PRODUCTIVO, ¿LE SERÁN DE UTILIDAD?; POR OTRO LADO ESCRIBA QUE ENTIENDE POR DOCUMENTO TÉCNICO, QUE ENTIENDE POR LECTURA Y REDACCIÓN, ORTOGRAFÍA.

9. INTRODUCCIÓN Cualquiera que se enfrente al problema de escribir un documento suele experimentar una serie de problemas en los siguientes ámbitos: 1 . Estructura del documento 2 . Guías sobre formato 3 . Contenidos 4 . Facilidad de lectura 5 . Edición y difusión electrónicas

10. Estructura del Documento Al escribir un documento técnico, intente mantener en su cabeza que la estructura tradicional debería incorporar las siguientes secciones: A . Introducción, conteniendo: a . el estado actual del arte, b . trabajos relacionados, c . explícita mención de los objetivos que se pretenden alcanzar, d . ventajas esperadas de su trabajo en relación a otros existentes, e . mencione explícitamente sus contribuciones f . describa explícitamente la estructura del documento al final de la introducción

11. B. Problemas, discutiendo: a . los problemas reales que espera resolver con su propuesta, b . referencias a artículos, libros u otros documentos con las mismas instancias de problema que está utilizando (o similares), c . explicación de las dificultades de los problemas elegidos y del interés que estos puedan tener, d . discusión sobre el estado del arte en la solución de dichos problemas (incluyendo parámetros usados en las referencias que se hagan), e . resumen formal/matemático no ambiguo describiendo los problemas.

12. C. Técnicas de Resolución, haciendo hincapié en: a . la novedad del método o solución propuesta, b . la explicación específica y no ambigua de dicho método (por ejemplo incluyendo pseudo -códigos con las variables y elementos usados), c . las características y requisitos más sobresalientes, de tipo matemático o formal, de las técnicas empleadas , d . los parámetros y decisiones más importantes que le han llevado a seleccionar dichos métodos o técnicas , e . cómo pretende resolver el problema usando dichos fantásticos mecanismos, f . los resultados esperados tras la resolución .

13. D. Experimentos, presentando: a . cuales son los objetivos concretos que espera conseguir con los experimentos, b . qué parámetros, algoritmos e instancias de cada problema abordado pretende considerar (si es posible use tablas resumen), c . las medidas, análisis estadístico y criterios que pretende utilizar para juzgar los resultados (justifique dicha elección frente a otras), d . los pasos que pretende dar para obtener los resultados (y justifique por qué dichos pasos y no otros).

14. E. Resultados, analizando: a . cada resultado por sí mismo; añada gráficos y tablas, y discuta cada uno por separado, b . grupos de resultados relacionados, usando como criterio bien el problema para distintos métodos de resolución o bien la técnica de resolución para varios problemas, c . U n resumen de los resultados, con información clara sobre conclusiones y datos numéricos/gráficos/tabulados resumidos.

15. F. Conclusiones, incluyendo: a . un resumen muy breve de lo que se ha dicho/hecho en el documento, b . una explicación simple o informal de los logros y afirmaciones, c . añada algunas referencias (pocas) o conclusiones técnicas si resulta apropiado, d. al final de esta sección, añada algunos detalles sobre por dónde pretende o es de interés continuar el trabajo en el futuro, atendiendo al problema, las técnicas u otra información (p. ej. software o URL’s ).

16. G. Referencias, resaltando : a. los conceptos más importantes del trabajo, b . referencias a trabajos similares, c . referencias a las técnicas básicas usadas y/o resultados, d . referencias al trabajo que está extendiendo (línea de trabajo), e . cuide de que todas las referencias del final del documento estén usadas en el cuerpo del documento (hayan sido referenciadas ), f. las referencias no son bibliografías con información general relativa al contenido, sino documentos concretos cuyo contenido se ha usado, g . Incluya preferentemente artículos de revista o libros, considere después los artículos en conferencias y, finalmente, intente evitar las comunicaciones personales o informes técnicos si es posible.

17. Además, recuerde añadir un resumen al principio del documento, en donde incluya los objetivos, el trabajo que se pretende describir y una explicación abreviada de las conclusiones a las que llegará en el documento . Adicionalmente, utilice un título con 4 significado para el documento y la afiliación completa de los autores (incluyendo dirección postal, email y URL si es posible). Añada también algunas palabras clave que permitan identificar el ámbito del documento (evitando palabras que no ayuden por sí mismas tales como “sistema”, “software”, “elemento”, “algoritmo”, etc.).

18. Puede que le interese considerar la inclusión de un índice al principio del documento si es largo; incluso, puede ser de interés añadir un índice de tablas o figuras para ayudar al lector. Además, puede que necesite utilizar uno o más apéndices con información de interés pero que no sea imprescindible para entender el documento (nomenclatura, manual de usuario, demostraciones teóricas, etc.).

19. Guías para el Formato Independientemente del editor o aspecto que pretenda dar a su documento intente ser consistente consigo mismo durante toda la escritura del documento. Esto es importante. Aquí se resumen algunos consejos: Si existe algún estilo ya definido para el tipo de documento que pretende elaborar o para la audiencia del documento, entonces ¡consiga dichas instrucciones de estilo y úselas!

20. Intente poner el nombre de las secciones al menos 4 puntos más grande que el texto normal. Para la jerarquía de sub-secciones, intente disminuir dicho tamaño de letra. No añada punto final (“.”) al final del nombre de una sección: no es una frase. Ponga en mayúsculas la inicial de cada palabra del título de la sección, excepto si la palabra es un artículo, preposición, o partícula de 4 letras o menos. Por ejemplo: “Resultados para el Problema de la Asignación”.

21. Utilice el mismo tamaño de punto y fuente para todas las secciones que residan al mismo nivel en la jerarquía de secciones del documento. Numeré todas las secciones, preferiblemente con números arábigos (1, 2, 3 ...). No deje en el texto líneas huérfanas (es decir, líneas solas aisladas), tanto al final como al principio de una página (o columna, si está usando doble columna). Haga un esfuerzo por no romper párrafos entre dos páginas sucesivas. Analice la página completa para descubrir los párrafos susceptibles de resumir: aquellos con una línea final de pocas palabras (dos o tres).

22. No añada tabuladores al primer párrafo de una sección. Asegúrese de añadir tabuladores a cualquier otro párrafo, incluyendo los párrafos que aparecen tras una ecuación, tabla o figura. Si está utilizando abreviaturas (“Fig.”, “ Ec .”, etc.) intente ser consistente y usarlos siempre, no sólo a veces.

23. Ponga en mayúsculas la primera letra de las palabras “Figura”, “Tabla”, “Ecuación” y “Sección”, excepto cuando estén en plural, en cuyo caso utilice minúsculas. Es decir, use mayúsculas si está refiriéndose a una en particular con su número asociado, tal como “Sección 3”. 5 Intente minimizar el uso de letras en negrita y subrayadas en el documento. Si quiere resaltar un texto intente usar letra itálica (o cursiva).

24. Ponga en tipo de letra courier el texto que directamente pueda encontrarse en el sistema software (si es el caso). Por ejemplo: nombres de ficheros, clases, métodos u objetos en un programa orientado a objetos, los presudo -códigos, etc. data.txt, Buffer.put (a), main.cpp, http://www.net, etc. Centre las figuras y las tablas en la página (cuando sea apropiado). Añada números de referencia para las ecuaciones.

25. CONTENIDO Intente adherirse a los siguientes consejos en relación al contenido de su documento: No olvide referenciar explícitamente cada figura/tabla/ecuación en el texto. Compruebe que su documento no repite con frecuencia una misma palabra. En Informática, esto suele ocurrir con “sistema”, “estudio”, “programa”, “problema”, etc.

26. Compruebe que está usando consistentemente (siempre igual) el uso del guión “-“ entre dos palabras, y también las may /min para los nombres propios. No utilice palabras sin contenido científico tales como “bueno” o “malo”. Ponga una referencia a cada término nuevo que añada el texto, y hágalo únicamente la primera vez que se menciona. Cuide de referenciar el trabajo original donde se propuso el término, no una referencia que tenga a mano y que hable también de dicho tema .

27. Defina siempre los acrónimos que necesite la primera vez que aparece la frase o explicación, ponga el acrónimo entre paréntesis, y úselo a partir de ese momento siempre que sea posible. No hable de algo que antes no se ha explicado o referenciado en el documento. Analice las secciones para ver si es posible crear sub-secciones. No use una exposición continuada en la misma sección si claramente son dos aspectos diferenciables .

28. Lea secuencialmente únicamente los nombres de las secciones, desde la introducción a las conclusiones, con la intención de detectar problemas de contenido o fluidez de lectura. Piense en la completitud del documento: ¿hay algo de lo que se está hablando que no está explicado o referenciado en el artículo? Piense en la corrección del contenido: ¿hay algo incomprensible o incorrecto que deba ser aclarado?

29. Facilidad de Lectura Dé una pasada de lectura al documento para chequear los siguientes aspectos: Compruebe que las frases no sean más largas de dos o tres líneas. Si existe este tipo de frases es probable que pueda romperlas en otras más pequeñas y legibles. Compruebe que las figuras/tablas/ecuaciones están situadas en los lugares correctos del documento, tan cerca como sea posible del lugar donde se las referencia y discute.

30. Evite situar una figura/tabla/ecuación de una sección tras haberla cerrado para empezar otra nueva. Compruebe que los gráficos tienen tamaños legibles para el texto (título, valores, etiquetas de los ejes) y el grosor y tipo de las líneas. Nunca olvide incluir un título para un gráfico, los valores de los ejes y una etiqueta explicativa para cada eje. Asegúrese que el título es corto y significativo para el contenido (no utilice frases para esto).

31. Evite el uso de demasiadas líneas internas a las tablas que puedan dificultar su lectura. Puede conseguirse el mismo efecto por la alineación de filas o columnas. Siempre que sea posible, incluya gráficos y dibujos que expliquen el contenido, el sistema, algoritmos o solución al problema. Esto ayuda mucho al lector. Intente alternar entre frases en activa y pasiva, y no abuse de ninguna de ellas.

32. Edición y Difusión Electrónicas Piénselo dos veces antes de utilizar un entorno de edición concreto para el documento. El documento podría ser reutilizado en el futuro (y seguro que lo será). Piense en las dificultades para reutilizar cada apartado según la herramienta de edición. Hoy en día, la mayoría de personas utilizan Microsoft Word o Latex . No pretendo comparar ambas, ya que es seguro que las dos tienen ventajas relativas y las dos tienen desventajas.

33. Si se utiliza Word es preferible definir estilos y usar plantillas para el documento, o de otra manera no será capaz de mantener el contenido y el formato en el futuro. Si se utiliza Latex intente no abusar de las etiquetas no estándares o de muchos paquetes, y tenga siempre a mano un buen editor gráfico para generar figuras eps de calidad. En cualquier caso, utilice formatos predefinidos, y evite características avanzadas que ligarían para siempre el documento al procesador o S.O. usado .

34. Los documentos en pdf son la vía que la gente suele preferir debido a su calidad, el pequeño tamaño de los ficheros y las capacidades de búsqueda de algunos motores de búsqueda modernos en este formato. Normalmente, los ficheros postscript son. Dedique un tiempo a comprobar cómo queda el documento si se exporta a formato html . Volcar el contenido en páginas web puede ser de utilidad.

35. Conclusiones Esta nota corta pretende servir de documento base para guiar a estudiantes en la escritura y transmisión de su trabajo a otras personas . El documento es corto intencionadamente para que sea rápido de leer y anime a ser utilizado. Esto necesariamente supone evitar explicaciones profusas de por qué se hacen los consejos . Las recomendaciones generales más importantes son mantener la coherencia a lo largo del documento (en contenido y forma), y siempre evaluar la completitud y corrección de la información que se ha incluido al escribirlo.

36. LEXICOLOGÍA BÁSICA EN LA INDUSTRIA DEL PETRÓLEO

37. EL LÍMITE ENTRE LO GENERAL Y LO ESPECIALIZADO En su acepción más común, la lengua es el instrumento de comunicación de una comunidad. Aunque no representa el único instrumento para la comunicación, sí el más importante y más característico:   La lengua (las lenguas naturales) [es] el medio universal de la comunicación, cuyos signos pueden representar todos los contenidos cognitivos conceptuales del hombre y que abarca con esto todos los campos necesarios de la comunicación humana. Jäger , 1975

38. La lengua consiste en la utilización que hace del lenguaje una comunidad determinada de hablantes, es decir, se trata de un sistema o conjunto de signos orales o escritos convencionales que sirven a una misma comunidad lingüística como medio de expresión y comunicación.

39. Como instrumento semiótico, el lenguaje no sólo se utiliza para comunicarnos en situaciones cotidianas, sino que también se emplea en contextos específicos, especiales o, dicho de otro modo, en contextos profesionales. Al primer tipo de manifestaciones, se le ha denominado lengua general o común (LG), mientras que cuando empleamos el término lengua y lenguaje de especialidad (LE) aludimos al sistema y al «lenguaje específico que utilizan algunos profesionales y especialistas para transmitir información y para negociar los términos, los conceptos y los conocimientos de una determinada área de conocimientos

40. De tal modo, el inglés de los negocios o el jurídico, por poner ejemplos claros de contextos específicos de la lengua, es el uso que se hace del inglés para exponer los conocimientos en materia de negocios o del derecho y, sus connotaciones, «las comparte el ciudadano medio, aunque los términos técnicos se le escapen en gran medida en tanto en lo que respecta a las nociones como a su expresión».

41. Por tanto, podemos afirmar que, mientras que el lenguaje general hace referencia al conjunto de recursos que emplea la mayoría de los hablantes de una lengua, la denominación lenguajes de especialidad o profesionales se reserva para denominar a los distintos subcódigos que los hablantes usan seleccionándolos a tenor de las necesidades expresivas y de las características particulares del contexto comunicativo en que se encuentran.

42. Si trasladamos esta diferenciación a una situación prototípica de discurso general y de discurso especializado, como puedan ser una conversación cotidiana y un interrogatorio procesal respectivamente, comprobamos que en cada una de estas situaciones comunicativas se seleccionan desde la terminología y el registro hasta la entonación o la gesticulación. Pese a la dificultad de establecer una tipificación clara y sistemática de las características de uno y otro lenguaje, lo cierto es que los interlocutores saben qué elementos deben usar y cuándo deben usarlos para que el proceso de comunicación tenga éxito

43. Establecer una distinción clara entre los diversos lenguajes no es tarea fácil. En algunos casos se presupone una distinción previa entre palabra y término, de la misma forma que a veces se parte de la dicotomía lengua general / lenguaje de especialidad para llegar a la diferenciación palabra y término respectivamente. Otras veces se considera el uso de la terminología como elemento diferenciador clave, tanto entre lenguajes de especialidad y lengua general como entre los diversos lenguajes de especialidad entre sí.

44. Aproximaciones en torno al término y al concepto de lenguajes de especialidad La diversificación de los lenguajes de especialidad guarda una estrecha relación con la división social del trabajo –utilizando las palabras del propio Marx– una división que aumenta de forma proporcional conforme aumentan los intereses de la sociedad y crecen sus necesidades. Esta división en tareas profesionales lleva implícita el desarrollo del conocimiento de cada uno de los ámbitos, así como de su vocabulario asociado, por lo que podríamos afirmar que existen tantas lenguas de especialidad como actividades humanas.

45. El desarrollo espectacular de la ciencia y de la tecnología, la mundialización o globalización de la economía y el carácter plurilingüe de la comunicación en la sociedad actual, han dado lugar a múltiples y muy diversos campos del saber con sus respectivos lenguajes profesionales, lo que ha favorecido el aumento de estudios lingüísticos teóricos y aplicados en torno a los lenguajes de especialidad. Sin embargo, no todos los lingüistas aceptan el uso de la palabra «lenguaje» para referirse a los recursos de la comunicación especializada, y ni tan siquiera comparten una misma postura respecto al concepto de «lenguaje especializado».

46. Recomendaciones para la revisión de tu documentación técnica INTRODUCCIÓN 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. Además, acompaña a todo proyecto como parte fundamental del mismo.

47. Existen distintos tipos de documentación técnica asociada a cada etapa del proyecto: informes, plano, manuales, listas de recambios, etc . La documentación técnica consiste en toda la información que explica cómo funciona, cómo se instala, cómo se atiende una instalación, un equipo, un sistema . Los documentos técnicos deben cumplir con una serie de principios y 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.

48. Para realizar un documento técnico de calidad, además de tener 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 . 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 las reglas precisas.

49. CARACTERÍSTICAS E IMPORTANCIA 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 para que, sin dejar a un lado un aspecto agradable a la vista o una organización y un uso de recursos gráficos, el material logre su propósito primordial de presentar información concreta.

50. 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 .

51. Al escribir un documento se deben seguir los siguientes teoremas : Identificar a los destinatarios y escribir de manera apropiada para ellos. Escribir con claridad. Escribir de manera concisa. Captar la atención de los destinatarios. Ayudar al lector a la fácil comprensión.

52. Para lograr la armonía entre todos los teoremas habrá que dominar dos aspectos que pueden parecer contradictorios : 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.  

53. TIPOS DE DOCUMENTACIÓN TÉCNICA Existe gran  variedad de documentos técnicos , con los cuales seguramente estás familiarizado : Correo electrónico Mensajes instantáneos Planos Oficios Documentación de software Presentaciones

54. Circulares Manuales de usuario Manuales de organización Páginas web Apuntes Libros de texto Artículos científicos Guías Reportes Instructivos

55. GESTIÓN DOCUMENTAL EN UNA INDUSTRIA La cantidad de documentos que se generan en una empresa pasados unos meses resulta abrumadora. Por ello es necesario poseer una estrategia de gestión documental de la empresa. Procedimientos de trabajo, manuales internos, manuales de equipos y de instalaciones, cualificaciones, validaciones, permisos, planos y un largo etc. son generados constantemente e incorporados a la base de datos . Una adecuada gestión de toda la información y documentación que la empresa posee permitirá ser más eficiente y optimizar el trabajo.

56. El tener toda la  documentación debidamente organizada  y aplicando un buen método de revisión técnica, agiliza sobremanera la búsqueda en un futuro de cualquier archivo . Está claro que, por un lado, destacamos la eficiencia y la rapidez a la hora de almacenar y localizar documentos. Sin embargo, otro elemento importante es el ahorro en recursos.

57. Hay que tener presente que la gestión documental puede hacerse tanto en papel como de manera automática en un sistema informático. Sin embargo, ya es habitual ver que la mayoría de empresas se organizan a través del empleo de potentes sistemas de planificación de recursos empresariales (ERP, por sus siglas en inglés,  enterprise resource planning ) donde almacenan, unifican y gestionan de manera eficaz todos los datos y documentos de su empresa.

58. Ventajas de la gestión documental Una buena gestión documental en la empresa, tiene toda una serie de ventajas : Almacenamiento lógico y organizado  de la documentación de cada uno de los departamentos de la empresa . Informatización  de toda la información . Ahorro en recursos : material, espacio y tiempo.

59. Incrementar la seguridad  de los archivos, estando éstos bajo seguras claves a las cuales tienen acceso unos pocos . Almacenamiento en la nube , lo cual evita pérdidas de los archivos y deterioro de la documentación . Compartir la información  con las personas que lo necesiten es más fácil que nunca . Rápida localización de documentos , tengan la antigüedad que tengan. Al disponer de un sistema de ordenación y organización lógico, encontraremos muy rápido aquello que vayamos buscando . Facilitar la actualización  de la documentación.