Consejos para elaborar documentos científicos de calidad

Basta con que sigas una serie de normas generales en su redacción. La mayoría de ellas no suponen un gran esfuerzo si son aplicadas desde el comienzo de la redacción del documento y algunas de ellas sólo tendrán sentido en determinados escritos. Estos consejos nacen de la experiencia de los miembros de Alqua en la elaboración de documentos científicos de más de 100 páginas con multitud de fórmulas y diagramas.

• Utiliza la herramienta adecuada. Un programa capaz de edición estructurada, como LaTeX (LyX), TeXmacs, o un formato como DocBook te ayudará a cumplir todos los requisitos de estructuración. La estructuración permite manipular un documento de una manera muy flexible, y presentarlo de diversos modos. Intenta evitar a toda costa el formateo visual: deja la preocupación por cómo quedará para el final.

• Se metódico: al crear figuras, tablas, etc. describe en el pie la información que contiene y etiquétalas para poder referirte a ellas por un número desde el texto.

• Se metódico(2): no olvides registrar la evolución de tu documento, los lectores deben saber qué pueden encontrar en la nueva versión.

• Procura utilizar la notación más común en el campo de tu documento. Pero, a la vez, no dudes en utilizar toda la potencia de tu programa para conseguir una notación realmente limpia, homogénea y bonita. Y finalmente, no olvides explicar la notación a tus lectores y por qué es la mejor.

• No tengas miedo de introducir más material del habitual: siempre se puede aprovechar para construir un documento separado, de introducción a la materia o de conceptos preparatorios.

• Es mejor una figura digitalizada a partir de un dibujo que la ausencia de una figura.

• No olvides incluir toda la información necesaria en los gráficos, en particular indicar las magnitudes que se representan en los ejes.

• Documenta tus afirmaciones, las indicaciones bibliográficas son utilísimas para los que estudian tu documento. Tu opinión sobre la pertinencia de unas u otras referencias es bienvenida.

• Cita buenos documentos libres. Necesitamos toda publicidad que podamos conseguir.

• Consigue que alguien de tu entorno de una segunda lectura a lo que escribes; es una forma muy buena de encontrar pequeños fallos y de saber qué puntos producen mayor dificultad.

Herramientas recomendadas para elaborar documentos libres

Los miembros de alqua recomendamos efusivamente el uso de procesadores de texto o herramientas que generen contenido fuertemente estructurado. Por ejemplo: TeX, LaTeX, LyX y TeXmacs.

En el terreno de las figuras, la decisión puede ser una cuestión de gustos pero son recomendables aquellos paquetes de software que generen datos vectoriales como Sketch, Xfig, Sodipodi, Inkscape o Dia.