partes de un cpu

Cómo Escribir un Documento Técnico

1 Introducción

En este trabajo presentamos algunos comentarios y consejos para estudiantes 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 deproblemas 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
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 eldocumento 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.

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 paradarle formato. La Sección 4 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 laSección 7.

2 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 aotros existentes,
e. mencione explícitamente sus contribuciones(“Las contribuciones de este trabajo son …”),
f. describa explícitamente la estructura del documento al final de la introducción

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.


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 otécnicas,
e. cómo pretende resolver el problema usando dichos fantásticos mecanismos,

f. los resultados esperados tras la resolución.

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. lasmedidas, 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).

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