Sobre la Escritura de Trabajos Técnicos
Dar una mirada a "Writing
Technical Articles"
Todo trabajo debe incluir
- Información General: Está compuesta por el
título, el autor, fecha, afiliación. El título es
fundamental, debe ser tal que atraiga al lector a leer el resumen.
- Resumen: Típicamente de no más de 300 palabras.
Resume todo el trabajo. Una primera frase normalmente resume la
introducción, las siguientes frases ubican el punto
específico que justifica el trabajo y explican el camino tomado
para resolverlo. Finalmente la última frase resume los
resultados. En la introducción hay que "vender" la propuesta que
se presenta, debe ser tal que atraiga al lector a la
introducción.
- Desarrollo: El nombre para estas secciones no es "DESARROLLO"
sino lo que corresponda según el tema. El número de
secciones y sus nombres depende del tema a tratar.
El desarrollo tiene varias secciones.
- La primera normalmente es la introducción. La
introducción debe describir el marco general del problema, el
área en que se encuentra inserto el tema a presentar, cuales son
otros problemas relacionados o vecinos al que se trata, y qué
publicaciones los abordan. Debe indicarse
los problemas en general y cuál de ellos será abordado en
el trabajo (objetivos del artículo). Se acostumbra a terminar
con un párrafo explicando las secciones que incluye el
artículo.
- La segunda o la última sección es "Trabajos
Relacionados". Esta sección presenta otros trabajos que abordan
el problema y hace una discusión crítica de sus
resultados. Cuando va al final generalmente se compara la
solución de otras propuestas con la del artículo. En
ocasiones no existe esta sección pero generalmente hay
algún párrafo de comparación con otras soluciones.
- Las siguientes secciones dependen del tema y
metodología usados en el trabajo.
- Una de las últimas secciones debe ser la que muestra
los resultados obtenidos en la propuesta.
- Conclusiones
y (trabajo futuro): Es como un resumen del
desarrollo seguido opcionalmente de una discusión sobre el
trabajo en progreso o futuro a desarrollar por el grupo. Una buen
conclusión destaca los aspectos nuevos que no habían sido observados en
la introducción (que muestra el estado del arte) y al mismo tiempo
muestra qué nuevas posibilidades se crean con el aporte del trabajo
presentado.
- "Conclusions should
synthesize the results of your paper and separate what is significant
from what is not. Ideally, they should add new information and
observations that put your results in perspective. Here's a
simple test: if somebody reads your conclusions before reading the rest
of your paper, will they fully understand them? If the answer is
``yes,'' there's probably something wrong. A good conclusion says
things that become significant after the paper has been read. A good
conclusion gives perspective to sights that haven't yet been seen at
the introduction. A conclusion is about the implications of what the
reader has learned. Of course, a conclusion is also an excellent place
for conjectures, wish lists, and open problems." Tomado de Three Sins of Authors
in Computer Science and Math
- A lot of people have picked
up the misconception that they should conclude their paper with a
summary. The dictum is, ``Tell
them what you're going to tell them, then tell them, then tell them what you told them.''
Well, yes, yes, and no.
- Referencias: Las referencias deben seguir el formato
estándar de revistas. Cada referencia debe aparecer nombrada en
el trabajo. Si no es nombrada, no debe ser listada.
- Anexos: Información de detalle prescindible en una lectura
del trabajo.
- Formato: seguir formato
IEEE. Puede usar las plantillas
sugeridas allí.
- Comentarios Generales:
Sobre secciones
- Un trabajo se compone de resumen (o abstract en inglés),
lista de secciones,
referencias, y opcionalmente anexos. Una sección se compone de
uno o más párrafos y subsecciones. Se inician con un
nombre de la sección (subtítulo). Los párrafos se
separan por puntos aparte.
- Si la sección se subdivide en varias sub-secciones, se
debe
poner un primer párrafo antes de iniciar la primera
sub-sección. Éste puede verse como la intro de la
sección.
- Cada párrafo desarrolla una idea o presenta las ideas que
luego son desarrolladas en párrafos individuales.
- Cada párrafo parte con una frase que entrega la idea
principal del párrafo. Luego vienen las ideas de soporte que
apoyan y/o ejemplifican las ideas plateadas. La última frase del
párrafo puede ser una que replantee la idea principal o bien
que sea el eslabón con el siguiente párrafo. Cuando
tenemos varios párrafos en una sección, el primero
debería ser como un resumen o introducción para los otros.
- No se debe escribir párrafos de una sola frase; es decir,
sin separar con punto seguido las ideas de soporte, argumentos,
detalles, o ejemplos. Si vemos que hay una sola frase, es mejor anexar
esa idea a otro párrafo.
- Procurar dar una coherencia a la secuencia de ideas hilvanando
explícitamente una sección con otra cuando la
relación sea no "obvia".
Sobre la figuras o tablas
- Se ponen en el texto lo más cercano posible a su
referencia.
- Todas las figuras o tablas deben llevar leyenda. Las tablas la
llevan antes (típicamente) y las figuras después.
- No omitir referencias. Si la figura o tabla no es referenciada
habría que sacarla.
- Reemplazar "como se muestra a continuación" por "como se
muestra en Figura xx".
- Es esencial que toda figura o tabla sea legible incluso
después de fotocopiar el documento. Luego no usar fonts mucho
menores que el del texto.
- Evitar el uso de colores. Al imprimir se producen confusiones.
Las publicaciones científicas aún son en blanco y negro.
Seguramente su tesis será en blanco y negro.
- No usar figuras de otras partes. Aún así, para este
ramo usted podrá hacerlo poniendo la referencia y eventualmente
rehaciendo la figura para lograr uniformidad total con el resto del
artículo.
Sobre la redacción
Procurar poner los adjetivos
después que el sustantivo (regla del español). "en casos
de alta congestión" ==> "en casos de congestión alta"
. "Como es el caso de los grandes paquetes" => "como es el caso de
los paquetes grandes" (Rigurosamente no deberíamos hablar de
"alta tensión" sino de "tensión alta")
Sobre acentos y ortografía (Aquí las noramas de la RAE, versión local)
- Pasar el trabajo por un corrector ortográfico.
- El siguiente material fue tomado de "Aprenda a Redactar
correctamente":
- Puntuación
