Documentos de Académico
Documentos de Profesional
Documentos de Cultura
_____________________________________________________
Enrique Alba
Dpto. Lenguajes y CC.CC.
Univ. de Mlaga, ESPAA
Mayo 2002
1 Introduccin
En este trabajo presentamos algunos comentarios y consejos para estudiantes e
investigadores noveles con la intencin de ayudar en la elaboracin de documentos de
buena calidad, conteniendo informacin cientfica y orientados a lectores
especializados.
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. Guas sobre formato
3. Contenidos
4. Facilidad de lectura
5. Edicin y difusin electrnicas
Puesto que mi objetivo es dar una ayuda de la manera ms eficiente posible
(rpida e inmediatamente) presentar una especie de lista de actividades que deberan
tenerse en cuenta antes/durante/despus de haber terminado el documento tcnico. En
realidad, no es una nica lista, sino un conjunto de listas cuyo contenido dependen de
los principales problemas que se deben resolver segn el perfil del escritor y segn el
enfoque que quiere dar a su trabajo.
(Las
D. Experimentos, presentando:
a. cuales son los objetivos concretos que espera conseguir con los
experimentos,
b. qu parmetros, algoritmos e instancias de cada problema abordado
pretende considerar (si es posible use tablas resumen),
c. las medidas, anlisis estadstico y criterios que pretende utilizar para
juzgar los resultados (justifique dicha eleccin 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; aada grficos y tablas, y discuta cada
uno por separado,
b. grupos de resultados relacionados, usando como criterio bien el
problema para distintos mtodos de resolucin o bien la tcnica de
resolucin para varios problemas,
c. un resumen de los resultados, con informacin clara sobre
conclusiones y datos numricos/grficos/tabulados resumidos.
F. Conclusiones, incluyendo:
a. un resumen muy breve de lo que se ha dicho/hecho en el documento,
b. una explicacin simple o informal de los logros y afirmaciones,
c. aada algunas referencias (pocas) o conclusiones tcnicas si resulta
apropiado,
d. al final de esta seccin, aada algunos detalles sobre por dnde
pretende o es de inters continuar el trabajo en el futuro, atendiendo
al problema, las tcnicas u otra informacin (p. ej. software o
URLs).
G. Referencias, resaltando:
a. los conceptos ms importantes del trabajo,
b. referencias a trabajos similares,
c. referencias a las tcnicas bsicas usadas y/o resultados,
d. referencias al trabajo que est extendiendo (lnea de trabajo),
e. cuide de que todas las referencias del final del documento estn
usadas en el cuerpo del documento (hayan sido referenciadas),
f. las referencias no son bibliografas con informacin general relativa
al contenido, sino documentos concretos cuyo contenido se ha usado,
g. incluya preferentemente artculos de revista o libros, considere
despus los artculos en conferencias y, finalmente, intente evitar las
comunicaciones personales o informes tcnicos si es posible.
Adems, recuerde aadir un resumen al principio del documento, en donde
incluya los objetivos, el trabajo que se pretende describir y una explicacin abreviada de
las conclusiones a las que llegar en el documento. Adicionalmente, utilice un ttulo con
3
4 Contenidos
Intente adherirse a los siguientes consejos en relacin al contenido de su documento:
o No olvide referenciar explcitamente cada figura/tabla/ecuacin en el texto.
o Compruebe que su documento no repite con frecuencia una misma palabra. En
Informtica, esto suele ocurrir con sistema, estudio, programa,
problema, etc.
o Compruebe que est usando consistentemente (siempre igual) el uso del guin
- entre dos palabras, y tambin las may/min para los nombres propios.
o No utilice palabras sin contenido cientfico tales como bueno o malo.
o Ponga una referencia a cada trmino nuevo que aada el texto, y hgalo
nicamente la primera vez que se menciona. Cuide de referenciar el trabajo
original donde se propuso el trmino, no una referencia que tenga a mano y que
hable tambin de dicho tema.
o Defina siempre los acrnimos que necesite la primera vez que aparece la frase o
explicacin, ponga el acrnimo entre parntesis, y selo a partir de ese momento
siempre que sea posible.
o No hable de algo que antes no se ha explicado o referenciado en el documento.
o Analice las secciones para ver si es posible crear sub-secciones. No use una
exposicin continuada en la misma seccin si claramente son dos aspectos
diferenciables.
o Lea secuencialmente nicamente los nombres de las secciones, desde la
introduccin a las conclusiones, con la intencin de detectar problemas de
contenido o fluidez de lectura.
o Piense en la completitud del documento: hay algo de lo que se est hablando
que no est explicado o referenciado en el artculo?
o Piense en la correccin del contenido: hay algo incomprensible o incorrecto
que deba ser aclarado?
5 Facilidad de Lectura
D una pasada de lectura al documento para chequear los siguientes aspectos:
o Compruebe que las frases no sean ms largas de dos o tres lneas. Si existe este
tipo de frases es probable que pueda romperlas en otras ms pequeas y legibles.
o Compruebe que las figuras/tablas/ecuaciones estn situadas en los lugares
correctos del documento, tan cerca como sea posible del lugar donde se las
referencia y discute.
o Evite situar una figura/tabla/ecuacin de una seccin tras haberla cerrado para
empezar otra nueva.
o Compruebe que los grficos tienen tamaos legibles para el texto (ttulo, valores,
etiquetas de los ejes) y el grosor y tipo de las lneas. Nunca olvide incluir un
ttulo para un grfico, los valores de los ejes y una etiqueta explicativa para cada
eje. Asegrese que el ttulo es corto y significativo para el contenido (no utilice
frases para esto).
o Evite el uso de demasiadas lneas internas a las tablas que puedan dificultar su
lectura. Puede conseguirse el mismo efecto por la alineacin de filas o columnas.
o Siempre que sea posible, incluya grficos y dibujos que expliquen el contenido,
el sistema, algoritmos o solucin al problema. Esto ayuda mucho al lector.
o Intente alternar entre frases en activa y pasiva, y no abuse de ninguna de ellas.
7 Conclusiones
Esta nota corta pretende servir de documento base para guiar a estudiantes e
investigadores noveles en la escritura y transmisin de su trabajo a otras personas.
El documento es corto intencionadamente para que sea rpido de leer y anime a
ser utilizado. Esto necesariamente supone evitar explicaciones profusas de por qu se
hacen los consejos.
Las recomendaciones generales ms importantes son mantener la coherencia a lo
largo del documento (en contenido y forma), y siempre evaluar la completitud y
correccin de la informacin que se ha incluido al escribirlo.