34
Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos Desarrollo del documento

Embed Size (px)

Citation preview

Page 1: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

Desarrollo del documento

Page 2: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

2

¿Por qué se dice que debemos empezar un artículo por sus conclusiones?

  Porque las conclusiones es lo más importante de nuestro trabajo. Si tenemos conclusiones tenemos artículo; si no tenemos conclusiones, es mejor que no perdamos el tiempo en escribir nada y que no se lo hagamos perder a los referees y editores de las revistas ni a los posibles lectores.  

            Esto no significa que las conclusiones queden fijas y determinadas al principio y ya no se puedan modificar. Puede que tengamos que cambiar nuestras conclusiones a lo largo del proceso de refinado de nuestro artículo. Sin embargo, debemos empezar a escribir el artículo por esta sección y desarrollarlo hacia atrás para estar seguros de que seguimos una secuencia

lógica en la que cada sección es respaldada por la siguiente.  

Page 3: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

3

1. Introducción

La introducción debe responder a la pregunta de "porqué se ha hecho este trabajo".

Es pues la respuesta a una pregunta, la cual es a su vez como el nexo de unión que engarza la investigación con el cuerpo de doctrina existente.

Describe el interés que tiene en el contexto científico del momento, los trabajos previos que se han hecho sobre el tema y qué aspectos no dejan claros.

No debe ser muy extensa y puede beneficiarse de lo expuesto en la revisión más reciente sobre el tema.

Para no encontrarse al final del esfuerzo con la sorpresa de que la pregunta ya ha sido respondida por otro investigador más madrugador, es necesario (imperativo, por mucho que cueste), hacer una revisión bibliográfica previa.

– Presentar muy claramente la naturaleza y relevancia del problema investigado– Suministrar suficientes antecedentes para que el lector pueda comprender y

evaluar los resultados sin necesidad de consultar publicaciones anteriores– Despertar el interés del lector, destacando lo más interesantes

Page 4: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

4

Contenido:

Justificar las razones por las que se investiga Explicar método de investigación Limitaciones del trabajo realizado Revisión bibliográfica Principales resultados o conclusiones

Responder a las preguntas:¿Cuál es el problema?

¿Porqué se eligió? ¿Cuán importante es?¿Qué trabajos indican que el problema existe?

¿Qué método se usó para resolver el problema?¿Qué se encontró?

Page 5: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

5

Limitaciones:

Especificar qué partes del documento representan contribuciones propias y cuales corresponden a aportes de otros investigadores

La crítica de otros trabajos debe limitarse al aspecto científico o metodológico

Destacar las fuentes de error o posibles errores

Grado de validez de sus conclusiones (no ser muy optimista respecto a precisión del trabajo, universalidad de las conclusiones o aplicabilidad de los resultados)

Si por seguridad o propiedad industrial ha de limitarse la información proporcionada, deberán especificarse expresamente las causas.

Si hubo alguna comunicación anterior o la va a haber, debe mencionarse

Page 6: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

6

Introducción vs. Reseña

“Si en un artículo de investigación primaria se incluye una reseña crítica o histórica de los conocimientos existentes, esta debe limitarse estrictamente al tema tratado en el artículo”.

Las reseñas más generales deben publicarse, como tales, por separado”

UNESCO – PGI. Guía para la redacción de artículos científicos destinados a la publicaciones. 2ª ed. 1983

Page 7: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

7

Introducción vs. Conclusiones

Mencionar los principales resultados de la investigación. No se desarrollan pero si se exponen

En literatura científica es un error mantener al lector en suspenso (Robet A. Day)

Page 8: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

8

Es conveniente que el último párrafo de la Introducción se utilice para resumir el objetivo del estudio.

Objetivos

Describen las metas que se desea alcanzar con el mismo.

Deberían estar relacionados con las conclusiones y, por tanto, redactarse teniéndolas en cuenta.              Deben formularse de manera clara y precisa, sin pretender ir más allá de lo que realmente se haya hecho.

Conviene justificar brevemente la importancia o incidencia de cada objetivo en el trabajo que se elabora y en el marco conceptual de la disciplina en cuestión cuyo conocimiento intentamos incrementar con la investigación realizada.  

Page 9: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

9

2. Materiales y métodos

En esta sección se responde a la pregunta de "cómo se ha hecho el estudio".

Dar todo tipo de detalles : suficientes para que otro investigador competente pueda comprobar, repetir y verificar

» Especificaciones técnicas» Cantidades y medidas exactas» Procedencia o método de preparación (cuando sea nuevo… o la

referencia a donde se describe)» Propiedades químicas y físicas» Ubicaciones» Procedimiento» Materiales empleados» Sujetos

“La piedra angular del método científico exige que los resultados obtenidos, para tener valor científico, puedan ser reproducidos” Robert A. Day

Page 10: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

10

    

Los procedimientos o métodos empleados están obviamente determinados por los objetivos del trabajo de investigación que abordamos.

En este apartado debemos incluir, por tanto:    

    a) Enfoques metodológicos seguidos.

    b)  Instrumentos utilizados.

    c)  Cuestionarios, entrevistas, etc.

    d)  Diseño experimental (incluyendo el número y descripción de los grupos de sujetos o de muestras, sus características, etc.).

    e)  Si se han utilizado sujetos experimentales, se describen sus características demográficas básicas (edad, género, capacidades, etc.)

    f)  Tratamientos realizados.

    g)  Sustancias o reactivos que se han utilizado y en qué secuencia.

    h)  Instrucciones que se dan a los sujetos (cuando los hay).

    i)   Técnicas empleadas para recoger y registrar los datos obtenidos (ordenador, papel, grabación, vídeo, etc.).

    j)  Criterios utilizados para decidir en caso de conflictos o problemas metodológicos.

    k)  Decisiones tomadas en situaciones imprevistas.

    l)  Variables que se van a utilizar para describir los datos (esto a veces se hace en la sección resultados).

    m)   Criterios de clasificación de los sujetos, las muestras, los especímenes, los reactivos, etc.

    n)  Problemas metodológicos a los que se debería prestar especial atención.

Page 11: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

11

Dado que muchos grupos de investigación trabajan siempre siguiendo las mismas o parecidas metodologías, no resulta raro que esta sección sea muy similar en todos los trabajos que publican dichos grupos.

Otras veces, la metodología se describe brevemente y se citan trabajos anteriores para que aquellos investigadores que quieran profundizar más puedan acudir a ellos.

Page 12: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

12

Estilo

Escribir en pasado Orden de presentación ordinario es el cronológico

Page 13: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

13

3. Resultados

Esta sección debiera ser la más simple de redactar. Incluye las tablas y figuras que, por sí solas, deben poder expresar claramente

los resultados del estudio. Hay editores de revistas importantes que afirman sin ambages que el

mejor texto para esta sección debiera ser simplemente: "los resultados del estudio se pueden ver en la Tabla 1".

Los resultados deben poder ser vistos y entendidos de forma rápida y

clara. Es por ello por lo que la construcción de esta sección debe comenzar por

la elaboración de las tablas y figuras, y sólo posteriormente redactar el texto pertinente en función de ellas.

Page 14: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

14

Dos partes:

Expresar los resultados

Volver a hacer una descripción –amplia- de los métodos (no detalles) y los resultados a los que dan lugar

Presentar las pruebas

Datos representativos (nunca los interminablemente repetitivos) que apoyan tales resultados, sea en forma de figuras, tablas o en el mismo texto

“La obsesión de incluirlo todo, sin olvidar nada, no prueba que se dispone de una información ilimitada, sino que se carece de capacidad de discriminación”

Aaranson, Citado por Ropber A. Day

Page 15: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

15

ESTILO

El primer párrafo de este texto debe ser utilizado para resumir en una frase concisa, clara y directa, el hallazgo principal del estudio.

Esta sección debe ser escrita utilizando los verbos en pasado. Aunque se utiliza mucho la voz pasiva o el impersonal ("se ha encontrado que...") como prefieren algunos editores, cada vez se tiende más a utilizar la voz activa en primera persona del plural ("hemos visto que... “).

Page 16: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

16

4. Discusión

Esta sección es el corazón del manuscrito, donde la mayoría de los lectores irán después de leer el resumen

Mostrar las relaciones existentes entre los hechos observados, señalando la significación de los resultados

Que la reacción del lector no sea nunca “Bueno… ¿y qué?” Robert A. Day

Es una de las partes más difíciles de la redacción

Page 17: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

17

Contenido

Comience la Discusión con la respuesta a la pregunta de la Introducción, seguida inmediatamente con las pruebas expuestas en los resultados que la corroboran.

Saque a la luz y comente claramente, en lugar de ocultarlos, los resultados anómalos, dándoles una explicación lo más coherente posible o simplemente diciendo que esto es lo que ha encontrado, aunque por el momento no se vea explicación.

Especule y teorice con imaginación y lógica. Esto puede avivar el interés de los lectores.

Incluya las recomendaciones que crea oportunas, si es apropiado. Y, por encima de todo, evite sacar más conclusiones de las que sus resultados

permitan, por mucho que esas conclusiones sean menos espectaculares que las esperadas o deseadas.

Page 18: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

18

Componentes (R.A.Day)

Presentar los principios, relaciones y generalizaciones que los resultados indican Señalar las excepciones, faltas de correlación y aspectos no resueltos (nunca tratar

de ocultar lo que no encaje) Mostrar las concordancias de los resultados con trabajos anteriores Exponer las consecuencias del trabajo y las posibles aplicaciones prácticas Formular conclusiones de forma clara Resumir las pruebas que respaldan cada conclusión (no dar nada por sentado)

Page 19: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

19

ESTILO

Escriba esta sección en presente ("estos datos indican que"), porque los hallazgos del trabajo se consideran ya evidencia científica.

Page 20: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

20

4b. Conclusiones

Los defectos más comunes en los apartados de conclusiones son:

a) Muchas veces, las conclusiones no se derivan de los resultados ni de la discusión realizada en los apartados anteriores (no son auténticas conclusiones).

b) Otras veces las conclusiones se redactan para salir del paso, como un mero trámite más, sin prestarles la debida atención.

c) Peor aún, este importante apartado puede desperdiciarse y convertirse simplemente en una repetición del resumen que encabeza todo artículo científico.  

Además de las propias conclusiones relativas al trabajo realizado, es posible incluir en esta sección algunas de las informaciones siguientes:        

a)      Posibles interpretaciones alternativas de los resultados que se descarten por cualquier razón.

      b)      Posibles líneas adicionales de investigación a la vista de los resultados obtenidos.

      c)      Análisis de las aportaciones relevantes de nuestro trabajo frente a otras anteriores y/o similares.

 

Page 21: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

21

Numeración de las divisiones y subdivisiones (ISO 2145)

Aplicable a todo tipo de documentos (incluido artículos) Fines:

– Aclarar la sucesión e importancia de las distintas subdivisiones, así como sus relaciones

– Simplificar la búsqueda y recuperación de determinadas partes del texto

– Facilitar la cita de las diferentes partes y las referencias dentro del texto

Page 22: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

22

Ejemplo

0. Introducción1. Morfología1.1 Citología1.1.1 Forma y tamaño de la célula1.1.2 Contenido viviente de las células1.1.2.1 Componentes de la célula1.1.2.2 Propiedad físicas de la célula1.1.2.3 Inclusiones inertes de los protoplasmas1.2 Histología2 Fisiologia….

Page 23: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

23

Cifras arábigas Cada división y subdivisión puede subdividirse hasta cualquier nivel por un número

cualquiera de subdivisiones numeradas correlativamente a partir del 1 (no obstante, recomienda moderación)

– Una subdivisión 1 implica necesariamente la existencia al menos de una subdivisión 2 (por lógica, la norma no dice nada)

– El nº 0 se reserva para introducciones y no se contempla su subdivisión

Cada subdivisión se separa por un punto (que nunca se indica al mencionarlo). Nunca hay punto al final.

Page 24: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

24

“Figuras” o representaciones gráficas

ISO 5966 (informes científicos) considera dentro de este concepto a las ilustraciones, gráficos, láminas y mapas

Juegan un papel significativo en la expresión de ideas científicas y técnicas

Page 25: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

25

Reglas comunes

Presencia inmediata cuando se cite en el texto por primera vez Leyenda explicativa (epígrafe) que sea suficiente, sin necesidad de recurrir al texto

(no simple título, ni sólo referencia al texto) Indicar en el texto la presencia de tablas o gráficos cuando se refiera a ellas Si no están referenciadas expresamente en el texto deben pasar a un apéndice

Page 26: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

26

Numerar secuencialmente (para localización y para citas)– Y crear un índice que permita su recuperación– Si va por capítulos, se indica nº de capítulo y nº de orden

Page 27: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

27

Ilustraciones

Figura, imagen o cualquier otra representación gráfica, compañada de un texto, incluida en la paginación del documento

Concepto de “ilustrar” Sentido explicativo, no decorativo. Sólo se “ilustra” cuando supone un beneficio para el lector y no se puede expresar de otra manera.

Page 28: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

28

Datos numéricos Gráficas / Tablas

Presentación de datos de forma organizada

Si sólo hay que presentar una o varias mediciones es preferible hacerlo descriptivamente en el texto. Sólo justifican la existencia de cuadro o tablas

– muestras representativas

– datos que indiquen cambios importantes

– necesidades de expresión gráfica ilustrativa

Cuadro/Tabla para transmitir valores numéricos exactos, Gráfica para transmitir una idea de tendencia

Guidelines for Giving a Truly Terrible Talk publicado en la revista EOS, de la American Geophysical Union, Vol. 67, No.44, Noviembre 4, 1986

Page 29: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

29

Estilo de las tablas

Se organizan de forma que sus elementos se lean de arriba abajo, nunca transversalmente. Utilizar sistemas de medición internacionales (SI / ISO 31 ó UNE 5002) para magnitudes físicas, unidades y

símbolos En su caso, eliminar toda ambigüedad en las convenciones establecidas por símbolos Escribir sobre la fotografía o gráfico lo que se quiera destacar No usar más de tres o cuatro columnas verticales y seis a ocho filas horizontales. Más información no será

legible. No utilizar líneas o segmentos dibujados tanto horizontal como verticalmente. Las mismas distraen la

concentración visual y saturan la tabla. Siempre que sea posible, presentar la información en una representación por barras o gráficos en lugar de

tablas. Las gráficas coloreadas son muy efectivas.

Page 30: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

30

Estilo de las gráficas

Generalmente, usar no más de una o dos curvas por diagrama, tres o cuatro como máximo siempre que estén separadas.

Rotular cada curva, no usar símbolos ni leyendas. No mostrar datos puntuales solamente, a menos que la finalidad

sea de mostrar la dispersión de la información.

Page 31: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

31

Cuadros de reproducción fotográfica (imágenes): ahorran costes y errores de composición. Cuidado con las reducciones a las que puede ser sometido (tamaño de letra que sea legible)

Page 32: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

32

ANEXOS

En los anexos debemos incluir todo aquello que nos permita el editor de la revista y que sea relevante para entender y reproducir el trabajo que se presenta en el artículo. Entre las informaciones y contenidos propios de los anexos cabe citar los siguientes:

 

a)     Cuestionarios utilizados, por ejemplo, en una encuesta.

b)     Datos demográficos de los sujetos utilizados.

c)      Demostraciones y deducciones laboriosas o complicadas.

d)     Datos adicionales.

e)     Materiales utilizados (por ejemplo, textos utilizados en investigaciones psicológicas).

f)        Reproducción de documentos originales (ej: cartas y fotografías).

g)     Algoritmos y programas informáticos breves.

h)      Especificaciones técnicas.

Page 33: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

33

Índice (analítico)

Lista detallada de todas las materias, nombres personales, geográficos, de acontecimientos y otros asuntos (citas, títulos de obras, personajes, textos legales, etc.) tratados en la publicación –desarrollados o en abreviatura- con indicación de la localización de los mismos dentro del texto (volumen, páginas).

– Más propio de monografías que de artículos : es imprescindible en obras de contenido complejo (tratados, manuales, etc.)

– Puede ser total o parcialmente: alfabético, sistemático, cronológico, numérico, etc. según necesidades

– Recomendación de un solo índice: pero diferenciar tipográficamente los distintos tipos de entradas

– Selección y forma de las entradas: similar a la ISO 5963

Page 34: Directrices para la redacción de documentos científicos Desarrollo del documento

Directrices para la redacción de documentos científicos

34

Tablas de abreviaturas y símbolos

Procurar dar todos los datos que contribuyan a la comprensión del artículo (explicar símbolos y abreviaturas)

Abreviaturas poco corrientes dificultan la lectura (especialmente cuando no es la lengua materna del lector)