Está en la página 1de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio

de casos prcticos

Redaccin de documentos cientficos Redaccin de documentos cientficos


Enrique Alba Enrique Alba eat@lcc.uma.es

eat@lcc.uma.es http://www.lcc.uma.es/~eat http://www.lcc.uma.es/~eat

Universidad de Mlaga Universidad de Mlaga

Enrique Alba

Redaccin de documentos cientficos

1 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

ndice

1 Introduccin 2 Metodologa de redaccin y tipos de documentos 3 Estructura, formato, contenido, legibilidad, idioma 4 Diseminacin, medios audiovisuales, otros 5 Estudio de casos prcticos

Enrique Alba

Redaccin de documentos cientficos

2 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Introduccin

Necesidad de redactar
La ciencia es un sistema para acumular conocimiento que se basa en gran medida en transferencia de ideas por escrito. Para transmitir ideas hay que cuidar tanto el fondo como la forma. La legibilidad de los manuscritos es tanto tipogrfica como lingstica. En general, hay que utilizar mecanismos que permitan un estilo llano (plain style), adecuado a la audiencia (cientfico vs. difusin) y donde las partes importantes estn visibles y se entiendan en la primera lectura. Problemas: sintaxis compleja y no compartir el contexto con el lector. Para escribir: buscar organizar redactar. Herramientas: conocimientos habilidades actitudes. Tipos de escritura: personal, funcional, creativa, expositiva, persuasiva.
Enrique Alba Redaccin de documentos cientficos 3 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Introduccin

Por dnde empiezo?


Es fundamental organizar, pensar y reunir material antes de comenzar. Modos de comenzar a escribir:
Ideogramas: dibujar conceptos, partes y sus relaciones en un papel. Tormenta de ideas: escribir sin atender al formato los contenidos e ideas. Aristteles: definir comparar causas efectos argumentar. Palabras clave: del documento que queremos crear y despus expandirlas. Lo Ms Importante Es (LMIE/WIRMI): qu evitar, qu incluir, qu conseguir Mapas conceptuales: entidades y relaciones. Tienen jerarqua y son visuales. Apoyo: Llevar encima una libreta pequea o un PDA/mvil y anotar las ideas.
relacinalo
co m p ra l

ESTRELLA:

quin cul qu cuntos cmo Enrique Alba dnde cundo por qu

CUBO:

al lc ap

analzalo

argumtalo

descrbelo Redaccin de documentos cientficos

4 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Introduccin

Hay muchos tipos de documentos


Carta Novela Instancia Genrico ::= cabecera, introduccin, cuerpo, conclusin. ::= planteamiento, nudo, desenlace. ::= identificacin, expongo, solicito. ::= introduccin, exposicin, comentarios, opinin.

Tipos de documento en ciencia y tcnica:


Libro: volumen escrito por pocos autores o editado (muchos autores). Tesis (doctoral o maestra): volumen extenso con conocimiento muy tcnico. Artculo de revista: longitud media, muy tcnico, de algo nivel y rigor. Artculo de congreso: documento corto, resultados iniciales, discusin abierta. Informe ejecutivo: una sola pgina con objetivos, medios, resultados, ID Resumen extendido: elementos principales escritos en una o dos pginas. Actas de un evento: volumen multi-autor con ponencias hechas en un evento. Informe tcnico: trabajo preliminar que est en marcha, longitud ad hoc.
Enrique Alba Redaccin de documentos cientficos 5 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Introduccin

Contenidos estndares en ciencia y tcnica


Ttulo: Corto, concreto, informativo, cuidado al cortarlo en dos lneas. Afiliacin: Nombre de los autores e instituciones (indexacin web!). Resumen: Planteamiento, contribuciones hechas, objetivo, pocos detalles. Introduccin: Tpicos, problema, aproximacin, contribuciones, estructura. Estado del arte: informativo, corto, procedente, cronologa, sugerente. Resultados: hiptesis, terminologa, parmetros, pruebas, conclusiones. Conclusiones y trabajo futuro: revisin de lo hecho y perspectivas. Agradecimientos: ayudantes, fondos recibidos, revisores, etc. Apndices: material demasiado abundante que es importante/interesante. Referencias: Material usado en la confeccin del trabajo ( bibliografa). Otros elementos: ndice inicial, listas de figuras o tablas, palabras clave, prlogo, dedicatoria, eplogo, ndice final de trminos o acrnimos
Enrique Alba Redaccin de documentos cientficos 6 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Introduccin

Es una pura cuestin de estilo


Asumamos que cada persona tiene su estilo propio. El objetivo es mejorar el estilo propio y evitar errores, no copiar a otro. Cada frase debe ser necesaria. Pensemos en el objetivo de cada frase. El objetivo es informar: usemos un tono preciso, tcnico, no suprfluo. Es bueno incluir ejemplos (un slo concepto por ejemplo). Hay que motivar la existencia de cada seccin y del trabajo descrito. Evitemos trminos genricos (cierto nmero) y giros verbales complejos. Las analogas son buenas, pero pueden dar lugar a malentendidos. Es bueno citar trabajos previos y comparar con ellos (revistas y libros, preferiblemente). No es necesario citar contenidos triviales para el lector. Todo documento debe ser revisado por un porrector topogrfico!
Enrique Alba Redaccin de documentos cientficos 7 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Consejos generales Retrica Frases Prrafos Secciones

Consejos generales (I)


Revisar el ttulo y el resumen al terminar de escribir el documento. Los conceptos pueden introducirse juntos en una seccin o cuando hagan falta durante el documento, primero las ideas y luego los detalles. Leer solamente los epgrafes para ver si tienen sentido lgico. La longitud de las secciones/captulos debe estar acorde a su importancia. No debe quedar nada implcito: debe estar todo por escrito o citar a otros. Cuidado con presentar opiniones o tendencias como hechos probados. En los documentos con mltiples autores debe haber una poltica de firma. Una vez que se introduzca un acrnimo en el captulo debemos usarlo siempre en adelante, salvo razones justificadas (e.g., hacer hincapi). Naturalmente todo acrnimo debe explicarse la primera vez (y slo la primera) que aparece. ESCRIBIR ES REESCRIBIR.
Enrique Alba Redaccin de documentos cientficos 8 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Consejos generales Retrica Frases Prrafos Secciones

Consejos generales (II)


Primero hablamos de lo que se va a hablar, despus se habla y despus se habla de lo que se ha hablado. Usemos mrgenes generosos, rectos y simtricos si es posible (izda/dcha) Busquemos equilibrio entre el interlineado y el tamao de la letra (1-1,5 lneas y 10-12 puntos, respectivamente). Los prrafos deben tener algn tipo de sangrado: tabulador en la primera lnea, y/o espacio anterior mayor que el interlineado, sangra francesa Numerar (identificar) las pginas, quizs usando datos del captulo/tema Usar seales para el lector: decir qu tema viene a continuacin, cmo encaja lo actual en lo global, resumir al final de seccin, etc. Evitar el lenguaje sexista: el/la redactor/a, capacitados/mucha capacidad El proceso: PENSAR ESCRIBIR REPOSAR REVISAR No seamos dogmticos: estas reglas pueden cambiarse si es necesario.
Enrique Alba Redaccin de documentos cientficos 9 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Consejos generales Retrica Frases Prrafos Secciones

Retrica
Punto de vista: hay que pensar en el tipo de lector cuando se escribe. Concrecin: usar conceptos perceptibles (citas, organismos, etc.) Personalizacin: en texto tcnicos evitemos el yo y usemos nosotros; es preferible evitar en lo posible las frases pasivas. En espaol es mejor usar las impersonales a la pasiva, en todo caso ambas son necesarias en ciencia y tcnica. Prosa coloreada: no repetir palabras o estructuras, es mejor variar. Decir y mostrar: mejor mostrar en tono directo la informacin, comentada. Despieces: recursos visuales delimitadores (pseudocdigos, ejemplos). Para ello se recurre a cuadrados, sombras, tipos de letra especiales
Justificar cada conclusin Dar conclusiones explcitamente Dar el else de todo if (si no) Usar verbos frente a sustantivos
Enrique Alba Redaccin de documentos cientficos 10 de 47

Consejos Consejos

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Consejos generales Retrica Frases Prrafos Secciones

Frases (I)
Usemos frases cortas sin llegar a ser telegrficos (1-2 lneas de texto). Intentemos usar siempre un estilo tradicional: sujeto+verbo+complementos Atencin a las frases subordinadas, que tienden a crear, si no malentendidos, s una (a veces) innecesaria distraccin, quizs aparentemente importante pero mejorable dividindolas en frases ms cortas separadas por punto o, mejor an, punto y coma. No usar la voz pasiva en lo posible. Atencin a que los verbos de un prrafo o seccin estn en tiempos verbales coherentes entre s, no unos en pasado y otros en presente. Cuidado con el uso incorrecto de tiempos verbales: Ayer ha habido un El uso del plural mayesttico (nosotros/we) es aconsejable. Puede reservarse la primera persona (yo/I) para expresar opiniones.
Enrique Alba Redaccin de documentos cientficos 11 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Consejos generales Retrica Frases Prrafos Secciones

Frases (II)
Mejor no usar dobles negaciones: We do not want to avoid the use of No abusemos de por tanto, asimismo, adems (hence, thus, however) Atencin al uso de pronombres: We have and algorithm implemented in Java, that is very useful for the community. (quin: el algoritmo o Java?) Evitemos ambigedades: alta frecuencia (o sea, bajo perodo). Las palabras cortas son preferibles a las largas: begin/initiate, first/firstly, part/component, use/utilize Qu sera del documento sin el uso de estructuras paralelas aclarativas? Imaginemos la lista de palabras anterior conteniendo utilize/use (al revs). Evitemos superlativos en las frases: ideal, startling, outstanding Cuidado con sonar pedante: Por supuesto es conocido que
Enrique Alba Redaccin de documentos cientficos 12 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Consejos generales Retrica Frases Prrafos Secciones

Frases (III): debemos evitar solecismos


Solecismos: expresiones que contravienen las reglas gramaticales Silepsis: ausencia de concordancia
La asociacin de informticos espaoles consideran apropiado [error comn] El 25% de las jvenes adolescentes qued embarazado La mitad de los procesos termin/terminaron a tiempo [exceso en la aplicacin de la norma] [matices distintos] [ambas aceptables] Los investigadores dicen, en investigacin dicen, los investigadores decimos

Anacoluto: dos frases que no se acompaan entre s.


La televisin aparte de distraernos, su funcin tendra que ser tambin educativa La televisin, aparte de distraernos, tendra que educarnos [incorrecta] [correcta]

Anantpodon: simetra rota entre dos frases.


El multiprocesador tendra que disminuir, por una parte el tiempo y la carga de la red [incorrecta]

Zeugma: omisin de un concepto.


Oracle se establece en el parque tecnolgico y Nokia, sin visos de mejora en el exterior Intel compr ProcSA y AMD el consorcio KissTech Enrique Alba Redaccin de documentos cientficos [incorrecto] [correcto] 13 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Consejos generales Retrica Frases Prrafos Secciones

Frases (IV): ms solecismos


Pleonasmo: redundancia (sper-abundancia) en los contenidos.
Volver a reincidir, reiniciar de nuevo, aproximadamente unas 10 veces ms potente Verlo por s mismo, al fin y a la postre, sea como sea, hoy en da, diga lo que diga [incorrecto] [correcto]

Anfibologa: ambigedad en la frase.


El programa recuerda el error por borrar el disco repetidamente [incorrecto]

Cacofona: repeticin de palabras o estructuras.


Hay muchas cacofonas corrientes que son evidentes para un lector avezado [incorrecto]

Tics personales: abuso de las comas, palabras repetidas


Aparentemente, el resultado est fielmente expresado en un excelentemente escrito ingls [incorrecto] El uso de clases en Java permite extender subclases a otras superclases ms genricas [incorrecto]

Barbarismos: palabras y expresiones extranjeras (ingls, francs)


resultados a discutir, balance entre fuerzas, el poder de la tcnica, durante largo tiempo comando, indentar, salvar, embebido, trazar, facilidad, someter, librera Enrique Alba Redaccin de documentos cientficos [incorrecto] [incorrecto] 14 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Consejos generales Retrica Frases Prrafos Secciones

Frases (V): atencin a las palabras


Debemos evitar el uso de trminos no cientficos como good (frente a evil?) y como better (quizs lower cost?). En lo posible, es mejor evitar tambin hipernimos como system, element y similares. Es decir, en lugar de usar prenda usemos calcetn. Debemos ser concretos; evitemos information y digamos a qu informacin nos referimos; idem con data: podemos usar el nombre del dato. Seamos cientficos, y no digamos El resultado sera ste, Hemos probado a ver qu pasa, No lo incluimos por falta de tiempo, No mejoramos pero muchas veces somos comparables, Hemos demostrado que puede aplicarse esta tcnica
Enrique Alba Redaccin de documentos cientficos 15 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Consejos generales Retrica Frases Prrafos Secciones

Prrafos
Usemos frases cortas sin llegar a ser telegrficos. Prrafos de entre 10-20 lneas (100 palabras), entre tres y ocho por pgina. Estudiar la pgina como una imagen: nmero de prrafos entre 5 y 10, de longitudes lo ms homogneas posible. Releer cada prrafo para ver si contiene primero una idea clara inicial que despus se connota en las restantes lneas. Debe evitarse repetir varias veces la misma palabra en un mismo prrafo, as el prrafo quedar mejor y no tendremos un prrafo con cacofonas que arruinen las ideas de dicho prrafo. Este prrafo es un desastre! Los prrafos de apertura deben ser positivos. Atencin: no se deben redactar como si la lectura fluyese tras el epgrafe! Es bueno a veces listar como items varias alternativas o ideas relacionadas, en lugar de redactarlas como un prrafo sin estructura.
Enrique Alba Redaccin de documentos cientficos 16 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Consejos generales Retrica Frases Prrafos Secciones

Secciones
Evitemos incluir secciones vacas en nuestro documento: Section 4. Algorithm Section 4.1. Explanation of the Algorithm El nombre de la seccin debe ser corto e informativo. Los epgrafes NO son frases (e.g., no terminan en punto). Deben ser cortos, y es mejor no repetir palabras en las subsecciones de una misma seccin dada. Dos niveles de numeracin (como mucho) en las secciones es una buena prctica. Intentemos que no queden ms de tres inicios de seccin por pgina. En ingls se debe usar mayscula para cada palabra (excepto para partculas o palabras de menos de cuatro letras). En espaol slo la inicial va en mayscula en un epgrafe de seccin o captulo. Cada inicio de seccin debe explicar por qu existe esta seccin en el documento que estamos escribiendo y por qu est tras la seccin anterior. Avisemos explcitamente cuando cambiemos de tema de discusin.
Enrique Alba Redaccin de documentos cientficos 17 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

El formato global (I)


Seamos consistentes en el formato y nomenclatura con nosotros mismos. Hay que citar todos los objetos no textuales en el cuerpo del manuscrito. Por objeto no textual me refiero a figuras, tablas, ecuaciones y algoritmos. Debemos intentar que la cita est cerca del objeto, sobre todo que est en la misma pgina que la figura, tabla, pseudocdigo... Los objetos deben numerarse: Figure 8.3, tabla 10, ecuacin 3, Section 5. Como norma, es mejor que los objetos no textuales estn centrados horizontalmente en la pgina (figuras, tablas, etc.). Debemos comprobar que no queden lneas viudas/hurfanas al principio o final de cada pgina. Podemos usar las itlicas para palabras extranjeras o para la primera vez que se introduce un trmino en el documento. Podemos usar las negritas para marcar contenidos importantes. Evitemos otros efectos en lo posible.
Enrique Alba Redaccin de documentos cientficos 18 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

El formato global (II)


Las figuras deben llevar un pie explicativo (debajo de la figura), mientras que las tablas deben llevar una cabecera (encima de la tabla). Pueden (o no) terminar en punto y estar justificados a derecha e izquierda. En caso de que sea una sola lnea de texto, sta quedar visualmente justificada slo a la izquierda. En todo caso hay que ser consistente. Los pseudocdigos tienen cabecera, no pie: Algorithm 9.3 Extended SA Cuando en el texto nos refiramos a una funcin de un pseudocdigo que tengamos, o a instrucciones de programacin/ficheros, etc. debemos utilizar letra textual: aspecto de courier, Quicksort(a,b,c). Los smbolos matemticos, todos en itlica (x, ). Para vectores es r preferible usar negritas (x) frente a barra o flecha horizontales (x ). No anidar sub/sper-ndices ms de dos niveles: 23
n

No comenzar una lnea con smbolos matemticos ni nmeros en cifra. Dejar espacios en las medidas (11 Kb) y usar guiones (The 3-Kb input)
Enrique Alba Redaccin de documentos cientficos 19 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Puntuacin (I)
Debe usarse maysculas siempre en: Epgrafes: Inicial de la primera palabra. En ingls, en toda palabra, a menos que sea partcula o tenga slo 3 letras (for, the, a, with). En ingls, para referirnos en singular a Figure, Section, Table, Equation o Algorithm; en plural podemos usar minsculas: figures 1-2 Al inicio de una frase o tras un punto. Esto parece trivial pero no lo es si la frase que tenemos empieza por un acrnimo que tiene minscula (pGA por ejemplo) o por un nmero en cifra (35). Las maysculas deben tener acento ortogrfico (cuando corresponda). En ingls, nunca deben usarse contracciones (dont, cant, theyre, etc.). En ingls, en una secuencia de elementos, antes del and final se debe aadir una coma: sugar, spice, and all things nice. En espaol NO (y). Los nmeros del cero al veinte deberan ir en letra, no en cifra, en el cuerpo del documento (sobre todo al principio de una frase).
Enrique Alba Redaccin de documentos cientficos 20 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Puntuacin (II)
En ingls: 100,000.00 En espaol: 100.000,00 Los tiempos, con dos puntos (1:30 h) y no con un punto (1.30 h). Usemos simbologa matemtica frente a programacin: wi y no w(i). Usen comas, como en este ejemplo, para separar los incisos de una frase, pero nunca debe usarse una coma entre el sujeto y el verbo! Usemos punto y coma para evitar punto y seguido; esto es una buena idea, siempre que las frases separadas por punto y coma tengan relacin directa. En otro caso, como aqu, se puede usar el punto y seguido. El uso de los dos puntos antes de enumerar una lista o describir una conclusin dentro de una frase mejora el estilo: es ms directo. Cuando usemos e.g. o i.e. recordemos aadir una coma detrs. La abreviatura de etctera siempre termina en punto (etc.) y los puntos suspensivos siempre son tres, ni ms ni menos. Ambos son excluyentes.
Enrique Alba Redaccin de documentos cientficos 21 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Puntuacin (III)
Si una frase termina en interrogacin (?), admiracin (!), etc. o puntos suspensivos () no debemos aadir un punto final adicional a dicha frase. En las frases interrogativas o admirativas nunca debemos olvidar el smbolo de apertura en espaol: y (Buenos das!, Cmo?). Las comas dobles enmarcan texto literal, y las simples remarcan algo. Cuidado con el uso de los guiones: al menos debemos ser coherentes con nosotros mismos. Si un trmino est aceptado en la comunidad es mejor no usar guiones (multiobjective o metaheuristic, por ejemplo). En algunas construcciones inglesas siempre se usa el guin, como en well-known. Hay varios tipos de guiones: el de sustraccin (-), el de separacin largo como se ve y el que une palabras (longitud intermedia). No anidemos los parntesis: La solucin (al problema (TSP)) consiste Las citas, parntesis, figuras y tablas no forman parte del discurso escrito y, por tanto, debe ser posible leer todo el texto omitindolas.
Enrique Alba Redaccin de documentos cientficos 22 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Puntuacin (IV)
En la exposicin usando items se pueden seguir dos estilos distintos. En el primero, si la lectura es conjunta, empecemos por minscula, separemos por coma y aadamos punto final: item primero, aqu va el segundo y el tercero termina la lista. Si son items conceptualmente distintos, usemos el punto y aparte: Item independiente primero. Esto va aparte. Esta es la tercera opcin. Como se ve arriba, la lista de items se explica en el prrafo anterior que terminar en dos puntos.
Enrique Alba Redaccin de documentos cientficos 23 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Figuras/Grficas (I)
Muestran relaciones y tendencias entre varias alternativas estudiadas. El tamao de letra de los elementos de la figura debe ser similar para permitir su cambio de tamao proporcional en el futuro si es necesario. Si comparamos A y B entonces ambos deben incluirse en la misma grfica. Si los datos son muy dispares en magnitud usemos escala logartmica. Los ejes deben estar etiquetados, las lneas o barras deben tener una leyenda y los ejes deben tener todos su unidad explcitamente escrita. Los diagramas son figuras explicativas para discutir la estructura de un sistema o describir los pasos de un trabajo o partes de una obra. Los diagramas deben ser de alto nivel, con pocos detalles. Una lnea slida/discontinua debe tener siempre el mismo significado en todo el documento y adems este significado debe estar explicado.
Enrique Alba Redaccin de documentos cientficos 24 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Figuras/Grficas (II)
Color en las figuras: es aconsejable pero mejor colores lejanos (e.g., amarillo y azul). Siempre que sea posible es mejor que las figuras tengan sombras, mejor poco oscuras (5-50% de gris), y que los bordes de los rectngulos sean redondeados y no con picos. Comprobad que todas las figuras se ven bien en escala de gris e impresas en un papel. Cuidado con el uso de colores para distinguir lneas en una grfica, es preferible el uso de grosores netamente distintos o varios tipos de lneas o smbolos. Cuidemos que la leyenda sea grande y est en una esquina libre de la grfica. Los smbolos en dicha leyenda deben coincidir con los del texto (e.g., evitad grid GA en el texto y gGA en la leyenda). Las grficas, mejor sin fondo: ejes y lneas sobre un campo transparente. Todas las grficas deben tener una etiqueta en cada eje indicando la mtrica o valor que se incluye en el eje (s, t, gen, hits, %, etc.) Todas las grficas sobre el mismo asunto deben tener la misma escala numrica. El formato es importante (EPS en Latex, TIFF/PNG en Word, )
Enrique Alba Redaccin de documentos cientficos 25 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Figuras/Grficas (III)

Figura explicando una estructura de datos Figuras explicando una arquitectura

Figura explicando un proceso


Enrique Alba Redaccin de documentos cientficos 26 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Figuras/Grficas (IV)
LOG

Grficas de barras (mejorables?)

Grfica de lneas
Enrique Alba

Grfica 3D

Hbrido=Grfica+Figura
27 de 47

Redaccin de documentos cientficos

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Tablas (I)
Muestran regularidades y valores concretos numricos. Todas las columnas/filas deben tener una etiqueta explicativa. Los valores en una columna deben tener todos la misma unidad. Todas las tablas deben tener un encabezamiento explicativo (corto). Las tablas deben evitar usar lneas verticales a menos que separen dos partes importantes, en cuyo caso es mejor usar dos lneas verticales juntas (no una ms gruesa). Evitemos el uso de lneas verticales en los dos extremos (derecha e izquierda) de la tabla. Evitemos tambin lneas horizontales, ya que los valores en las celdas delinean visualmente dichas lneas; evidentemente s debemos usar lneas horizontales arriba y abajo del todo de la tabla, y tambin debajo del nombre de la columna (en total 3 lneas horizontales en un caso estndar de tabla). Una lnea horizontal tambin podra separar dos conjuntos de datos.
Enrique Alba Redaccin de documentos cientficos 28 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Tablas (II)
Todos los valores numricos de la misma columna deberan tener el mismo nmero de decimales. La justificacin a la izquierda de las columnas es aconsejable, pero se deja a eleccin por si fuese necesario centrarlas para que la tabla quede visualmente ms clara. En una tabla, todas las celdas deben tener algn valor. Si lo desconocemos incluyamos un guin largo; si no procede incluir en esa celda un valor (e.g., comparar estadsticamente un algoritmo consigo mismo) usemos un punto negro grande centrado; si no disponemos del valor podemos incluir N/A (not available).

Enrique Alba

Redaccin de documentos cientficos

29 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Tablas (III)

Enrique Alba

Redaccin de documentos cientficos

30 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Referencias y citas
Debemos evitar citar informes tcnicos en lo posible. Idem para sitios web, excepto que sean imprescindibles. Citemos preferentemente revistas. Atencin a las referencias finales de cada captulo en un volumen, sobre todo para que no falte ningn dato (ao, nmero de revista, pginas, ) y tambin para que las maysculas estn bien (CPU, UMA, RAM, etc.). Es mejor evitar las abreviaturas: J. Comp. (?). Evitad las largas listas de citas (cuatro o ms referencias juntas) seguidas una tras otra sin explicacin: [2, 9,15] son intiles (dad sus diferencias). Cuando hay varias referencias, cuidad que aparezcan en orden creciente: No [4, 2, 9, 1] sino [1, 2, 4, 9]. Citar con las iniciales de los autores y el ao es una opcin [ANT02], que adems permite cambiar las referencias libremente. En caso de usar MS Word es mejor esto; en caso de Latex podemos elegir lo que convenga. Citemos el trabajo original, no trabajos posteriores marginales.
Enrique Alba Redaccin de documentos cientficos 31 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Ejemplos de referencias
En orden: libro, revista, conferencia, informe tcnico y sitio web.

Enrique Alba

Redaccin de documentos cientficos

32 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Ejemplos de citas
Ejemplo donde la cita est integrada y es parte del texto (se lee):

Ejemplo de cita neutra (no se lee) y de cita integrada (se lee):

Enrique Alba

Redaccin de documentos cientficos

33 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Agradecimientos
Se da las gracias a personas o instituciones que han ayudado. Se reconoce financiacin de algn organismo (beca, proyecto). Normalmente se sitan inmediatamente antes de las referencias, pero a veces pueden ir a pie de pgina en la portada del trabajo. Es mejor usar frmulas directas, tales como I am grateful to I thank y evitar rodeos innecesarios como I would like to thank I wish to thank
Enrique Alba Redaccin de documentos cientficos 34 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Ejemplos de otros elementos

Enrique Alba

Redaccin de documentos cientficos

35 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Lengua espaola
Seamos correctos y defensores de nuestra lengua. Evitemos traducciones fonticas del ingls: lincar, machear, someter Evitemos barbarismos: factor a tener en cuenta, Qu t quieres? Los nombres propios no se traducen: Henri Enrique, Gnter Podemos usar trminos no aceptados si los escribimos en cursiva. Los acrnimos en plural se hacen repitiendo letra: EE.UU. (no EUs). Participios analgicos (imprimido) vs. latinos (impreso). Atencin a los adjetivos: oficial/oficioso, aviar/aviaria Atencin a la pronunciacin: CD/DVD (espaol) versus OK (ingls). Para cualquier duda consultemos a la RAE (es posible enviarles correos).
Enrique Alba Redaccin de documentos cientficos 36 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Lengua inglesa
Van en mayscula los meses (January), das de la semana (Friday), idiomas (Spanish), elementos no textuales (Table) Usemos siempre el sistema mtrico internacional (Km frente a yardas). Evitemos trasladar al ingls estructuras del espaol. Por ejemplo:
I speak very well English Is very difficult The microprocessors are hard The solution is one linear graph In this section is described Word is compared with Latex You have two options: A or B The results arent interesting [incorrecto: modo entre el verbo y el complem. directo] [incorrecto: sujeto omitido] [incorrecto: los sustantivos genricos van sin artculo] [incorrecto: un aqu es genrico, no contable, ser a] [incorrecto: estructura mal y sin sujeto] [incorrecto: against s da la idea de contraposicin] [atencin: en ingls se trata de un O exclusivo] [incorrecto: no usemos contracciones verbales nunca]

El ingls estadounidense y el britnico tienen diferencias: behaviour/behavior, optimise/optimize, controlling/controling, centre/center Para cualquier duda consultemos el diccionario Webster (por ejemplo).
Enrique Alba Redaccin de documentos cientficos 37 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Herramientas informticas (I)


Microsoft Word: Ventajas: WYSIWYG, intuitivo, muy fcil dar formato, simple de aprender, herramientas para hacer grficas, ecuaciones e insertar imgenes. Puede definir estilos nuevos, se puede manejar toda la pgina y sus contenidos directamente. Desventajas: difcil manejar ndices, contadores (para figuras, tablas), difcil gestin de citas y referencias, dependiente de la impresora (formato cambiante). Latex: (MiKTeX + WinEdt) Ventajas: Calidad cientfica, formatos disponibles para tipos de documentos en ciencia, manejo de referencias como bases de datos, escritura colaborativa fcil, numeracin interna, ndices automticos. Desventajas: compilaciones constantes, se trabaja sobre el cdigo del documento y no sobre el documento mismo, lento en obtener resultados deseados y tendente a errores, etiquetas de bajo nivel.
Enrique Alba Redaccin de documentos cientficos 38 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Herramientas informticas: Latex (I)


% Ejemplo de documento en Latex \documentclass[10pt,a4paper,twoside]{article} \usepackage[dvips]{graphicx} \usepackage{fancyhdr} \setlength{\textwidth}{14.4cm} \setlength{\textheight}{19.3cm} \def\organizador{Programa Nacional de Tecnolog{\'\i}as Informticas} \begin{document} \title{\textbf{OPLINK: Net Centric Optimization}} \author{Enrique Alba \thanks{Email: \href{mailto:eat@lcc.uma.es}{\texttt{eat@lcc.uma.es}}} \\ Universidad de Mlaga} \maketitle \begin{abstract} This project aims .\end{abstract} \begin{center} \end{center} \large{\textbf{ \begin{texttt} http://oplink.lcc.uma.es \end{texttt} }}

\section{Project Definition and Goals} .


Enrique Alba Redaccin de documentos cientficos 39 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Herramientas informticas: Latex (II)


\begin{table}[!h] \centering %\scriptsize \begin{tabular}{|l|l|} \hline OPLINK TEAM & OPLINK LOGO \\ %EJEMPLO DE TABLA Y FIGURA

\begin{minipage}[b][3cm][t]{9cm} \begin{enumerate} \setlength\itemsep{0.2cm} \item \textbf{OPLINK::UMA}: University of M\'alaga \item \textbf{OPLINK::UC3M}: University Carlos III of Madrid \item \textbf{OPLINK::UEX}: University of Extremadura \item \textbf{OPLINK::ULL}: University of La Laguna \end{enumerate} \end{minipage} & \includegraphics[width=4cm,height=3.2cm]{images/oplink-logo2.eps}\\ \hline \end{tabular} \end{table}
Enrique Alba Redaccin de documentos cientficos 40 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Herramientas informticas: Latex (III)


@Article{Alba:Troya99, %%%incluido en un fichero .bib author = {E. Alba and J.M. Troya}, title = "A Survey of Parallel Distributed Genetic Algorithms", journal = "Complexity", year = "1999", volume = "4", number = "4", month = "", pages = "31-52", }

\begin{thebibliography}

%%%referencia en el documento mismo

\bibitem{LEE83} Lee, D.T., \textit{``Visibility of a Simple Polygon''}, Computer Vision, Graphics and Image Processing, 22, pp. 207-221, (1983). \bibitem{Alba03} \end{thebibliography}
Enrique Alba Redaccin de documentos cientficos 41 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Consejos
Usar PDF Usar PDF
Es mejor que PS ficheros ms pequeos visualmente ms atractivo muchas utilidades No depende del medio impresora ordenador sistema operativo No puede modificarse derecho de autor contenidos fiables Incrustar siempre las fuentes (!)

Presentacin oral Presentacin oral


Siempre ensayar antes Recordar frases clave (repetir) Mirar al pblico o tribunal No moverse mucho o tapar proy. Vocalizar muy bien Usar fuentes grandes y colores Una transparencia por minuto Numerar las pginas (X de Y)

Piedras angulares Piedras angulares


CORRECIN COMPLETITUD SER COHERENTE ADHERIRSE A LAS REGLAS VARIAR TRABAJAR EN ETAPAS
Redaccin de documentos cientficos 42 de 47

Estudiar Estudiar
Analizar cmo lo hacen otros Tener curiosidad con lo escrito Ser crtico con lo que se hace
Enrique Alba

RECURSOS

Recursos en Internet (I)


Conocimientos bsicos: Manual web (muy bueno): http://caribjsci.org/epub1/temario.htm Brevsimo y general: http://www.crowl.org/lawrence/writing/GopenSwan90.html Conceptos generales: http://www.writing.eng.vt.edu/ Enlaces: http://www.unet.edu.ve/~frey/varios/decinv/investigacion/bibliografia.html Sugerencias muy breves: http://www.arrakis.es/~serprof/redac.html Ayuda en lnea muy breve: http://www.ieanet.com/profesional/escribir.htm#6 Reflexiones sobre el mundo de la escritura: http://www2.uah.es/jmc/ Manual de estilo del CICESE: http://www.cicese.mx/manual/index.htm Concrete tips: http://www.cs.purdue.edu/homes/dec/essay.dissertation.html Dudas al escribir en espaol: Diccionario panhispnico de dudas: http://buscon.rae.es/dpdI/ Dudas sobre uso del espaol: http://www.elcastellano.org/gramatic.html La lengua espaola: http://www.dat.etsit.upm.es/~mmonjas/espannol.html
Enrique Alba Redaccin de documentos cientficos 43 de 47

RECURSOS

Recursos en Internet (II)


Tipos de documento: Proyecto FdC: http://personales.upv.es/~JPGARCIA/ProyectosFindeCarrera.html Artculos cientficos (breve): http://www.arrakis.es/~cule/art.htm Artculos cientficos (breve): http://www.monografias.com/trabajos16/articulo-cientifico/articulo-cientifico.shtml Tesis: http://www-derecho.unex.es/biblioteca/elaborartesis.htm Tesis (extenso): http://www.phys.unsw.edu.au/~jw/Como.html Tesis (organizacin): http://www.sce.carleton.ca/faculty/chinneck/thesis/LASpanish.html Tesis (enlaces de inters): http://jungla.dit.upm.es/~pepe/tesis.html Presentaciones orales en pblico: Speakers guide: http://www.eng.unt.edu/ian/guides/speaker.html
Enrique Alba Redaccin de documentos cientficos 44 de 47

RECURSOS

Recursos en Internet (III)


Software: Analizador morfolgico: http://clic.fil.ub.es/demo_sintactico/anali.php?Aid=2_2_0&Aidioma=1 Lista de varios analizadores: http://nlp.uned.es/~anselmo/catalogo_rile.html Style writer software: http://www.stylewriter-usa.com/productinfo.html Corrector de estilo (STILUS): http://stilus.daedalus.es/herramientas.php?texto=el+ni%F1o+corre+por+el +prado&op=pos Herramientas variadas: http://www.fisterra.com/recursos_web/mbe/escritu_cientifica.asp Plain English writer (comercial): http://www.editorsoftware.com/writing-software/index.html

Enrique Alba

Redaccin de documentos cientficos

45 de 47

BIBLIOGRAFA

Bibliografa
Technical Communication, M. Markel Bedford/St. Martin 2003 La Cocina de la Escritura, D. Cassany, Anagrama 2002 A Guide to Presenting Technical Information, C. Matthews, Professional Engineering Publishing Ltd. 2000 Writing for Computer Science, J. Zobel, Springer 1997 Technical Report Writing, IEE, IEE Professional Brief on, Tech. Rep., revised January 1993 How to Write Right, G. M. Blair, Engineering Management Journal, pp. 11115, June 1992 Jos Martnez de Sousa, cualquier ao y cualquier volumen
Enrique Alba Redaccin de documentos cientficos 46 de 47

Introduccin Metodologa de redaccin y tipos de documentos Estructura, formato, contenido, legibilidad, idioma Diseminacin, medios audiovisuales, otros Estudio de casos prcticos

Fin?

Enrique Alba Redaccin de documentos cientficos 47 de 47