Documento tecnico

Solo disponible en BuenasTareas
  • Páginas : 10 (2408 palabras )
  • Descarga(s) : 0
  • Publicado : 17 de noviembre de 2010
Leer documento completo
Vista previa del texto
Cómo Escribir un Documento Técnico
_____________________________________________________ Enrique Alba
Dpto. Lenguajes y CC.CC. Univ. de Málaga, ESPAÑA Mayo 2002

Resumen. La escritura de un documento técnico es un problema importante para la mayoría de investigadores, especialmente al principio de su carrera profesional. En esta nota breve quiero ofrecer algunos de los comentarios y consejosque usualmente doy a mis estudiantes acerca de cómo escribir un documento de aceptable claridad y estructura. El contenido del presente trabajo pondrá de manifiesto los típicos problemas sobre cómo estructurar la información, cómo presentar los objetivos o resultados, y algunas guías para seleccionar las palabras adecuadas, gráficos y mecanismos diversos para la transmisión de la información hastasus lectores.

1 Introducción
En este trabajo presentamos algunos comentarios y consejos para estudiantes e investigadores noveles con la intención de ayudar en la elaboración de documentos de buena calidad, conteniendo información científica y orientados a lectores especializados. Cualquiera que se enfrente al problema de escribir un documento suele experimentar una serie de problemas en lossiguientes ámbitos: 1. Estructura del documento 2. Guías sobre formato 3. Contenidos 4. Facilidad de lectura 5. Edición y difusión electrónicas Puesto que mi objetivo es dar una ayuda de la manera más eficiente posible (rápida e inmediatamente) presentaré una especie de “lista de actividades” que deberían tenerse en cuenta antes/durante/después de haber terminado el documento técnico. En realidad,no es una única lista, sino un conjunto de listas cuyo contenido dependen de los principales problemas que se deben resolver según el perfil del escritor y según el enfoque que quiere dar a su trabajo.

1

Este documento se organiza como sigue. La próxima sección discutirá cómo elaborar la estructura de un documento científico. La Sección 3 discutirá las guías para darle formato. La Sección4 profundiza en el tipo de contenidos imprescindibles que no deben olvidarse en la redacción final, mientras que la Sección 5 contiene consejos para mejorar la legibilidad del documento. Finalmente, la Sección 6 ofrecerá una discusión sobre formatos electrónicos (someramente). Terminaremos con algunas conclusiones que ayuden a resumir los contenidos del presente trabajo en la Sección 7.

2Estructura 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. mencioneexplícitamente sus contribuciones contribuciones de este trabajo son …”), (“Las

f. describa explícitamente la estructura del documento al final de la introducción (“Este trabajo se estructura en 6 secciones. La Sección 1 …”). 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 problemaque 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. C. Técnicas de Resolución, haciendo hincapié en: a. lanovedad 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...
tracking img