Consideraciones a la hora de escribir un informe cientifico-técnico o memoria

A old magic manuscript glowing in the dark cartoon style scooby.doo

El medio es el mensaje
MARSHALL MCLUHAN

La redacción de un texto científico-técnico debe considerar reglas de estilo, muchas de las cuales son establecidas por el editor de la publicación. Aquí, ofrecemos algunos consejos adicionales que pueden complementar las directrices del editor. Aunque estas recomendaciones están enfocadas a publicaciones en español, algunas de ellas son extrapolables también al inglés. No pretenden ser, ni mucho menos una recopilación exhaustiva, por lo que se recomienda consultar fuentes de referencia como Fundéu (https://www.fundeu.es), RAE (https://www.rae.es/) o Wikilengua (https://www.wikilengua.org) en caso de duda o si se quiere ampliar. Además, cada organización o editorial puede tener sus propias recomendaciones1 a las que hay que amoldarse.

ESTRUCTURA DEL DOCUMENTO

Las partes en las que se divide el documento dependen de la extensión del mismo. Aquellas que son obligatorias independientemente del tipo de documento se señalan con un (*).

Carátula (Cover page). Es la cubierta dura que protege  Se incluye en documentos extensos como un libro, un trabajo fin de grado o máster, o una tesis. Tiene que incluir, al menos, el título, los autores y la fecha de publicación. Puede incluir algún tipo de diseño gráfico que resulte atractivo.

Portada (Title Page). Es la primera página del documento. Reproduce la información de la carátula sin incluir los elementos gráficos.

Título* (Title).El título tiene que resumir en una sola línea las ideas más importantes de la manera más directa y simple posible. Hay que tener en cuenta que va a ser la parte más vista del documento, y habitualmente la primera que se lea. A modo de recomendación el título no debería superar las 15 palabras. Tampoco tendría que ser excesivamente corto.

Afiliación* (Affiliation). El nombre de los autores junto con la organización a la que están adscritos. Es recomendable añadir las direcciones de correo electrónico, e indicar a cuál de los autores es el encargado de recibir las comunicaciones. El orden de los autores refleja la contribución al trabajo. 

Dedicatoria (Dedicación). Trabajos extensos pueden incluir una o más dedicatorias. Se incluyen en una página impar propia. generalmente se escriben en cursiva y se alinean con un sangrado en el margen derecho. En caso de que la dedicatoria sea extensa, se recomienda finalizarlas con un punto.

Agradecimientos (Acknowledgements). Pueden aparecer tanto al principio (antes del índice) como al final (antes de la bibliografía). Incluyen el reconocimiento del autor a las personas, organizaciones o instituciones que han contribuido significativamente al trabajo pero no se pueden considerar autores del mismo. Puede ser que lo hayan financiado, que hayan colaborado en la ejecución de los experimentos, que hayan revisado el documento o apoyado emocionalmente a los autores.

Índice (Contents or Table of contents). Es imprescindible en publicaciones extensas. Permite relacionar los capítulos y apartados de la memoria con el número de página donde empiezan. También pueden ser necesarios los índices de figuras y de tablas.

Resumen* (Abstract). El resumen es otra de las partes más importantes de un artículo ya que es la segunda parte que más se va a leer, y es decisoria para seguir leyendo el resto del documento. Habitualmente se organiza como un párrafo entre 300 y 500 palabras donde se describen los aspectos más destacados del documento. Si el trabajo es extenso puede llegar a ocupar una página entera.

Palabras clave (Keywords). Las palabras clave son términos o frases específicas que resumen la temática del documento.

Glosario de siglas, acrónimos, símbolos y abreviaturas (List of Acronyms, Symbols and Abbreviations). Recoge el desarrollo de siglas y acrónimos incluidas en el texto, así como los símbolos matemáticos con sus unidades de medida correspondientes. Se incluyen si el documento es extenso.

Introducción* (Introduction). La introducción debe llevar al lector desde una temática general al objeto particular del que trata el trabajo. Debe motivar su importancia resumiendo la comprensión que se tiene hasta el momento del problema que aborda, y donde se ubica el trabajo en este contexto. Hay que incluir los objetivos que se persiguen, y las preguntas de investigación si las hubiera. Es preciso resaltar los potenciales usos que se pueden derivar del trabajo. Dependiendo de la extensión del trabajo será un capítulo o una sección. En documentos extensos esta sección marca el comienzo del cuerpo del documento.

Estado de la cuestión* (State of the art o background). Habitualmente denominado incorrectamente estado del arte2 por su traducción directa de la expresión state-of-the-art. Consiste en una revisión crítica y sistemática del conocimiento existente y trabajos previos sobre un tema o problema en particular. Dependiendo de la extensión del trabajo será un capítulo o una sección.

Partes, capítulos, secciones y subsecciones (Parts, chapters, sections, subsections). Dependiendo de la extensión se podrá dividir en capítulos, o incluso puede tener más de una parte. Las secciones podrán ser parte de un capítulo, o tener entidad por sí misma.

  • Los títulos deben incluir una descripción concisa y clara del contenido. 
  • Deben numerarse. Las partes se numeran con numeración romana (Parte I, Parte II…), y el resto en arábica (1, 2, 3…). Las secciones y subsecciones que sean parte de un capítulo se numeran jerárquicamente incluyendo el número del capítulo, la sección y la subsección, p. ej. 3.2.1 ó 7.1.
  • La numeración de los títulos van seguidos por un punto tanto en el texto como en el índice, p. ej. 1. Introducción ó 3.4. Metodología.
  • Ningún título lleva punto y final.

Conclusión* y trabajo futuro (Conclusions y future work). Es una sección crucial donde se resumen las aportaciones clave del trabajo. Tiene que incluir una discusión sobre las implicaciones de los resultados presentados y cómo pueden aplicarse en la práctica. Es recomendable indicar aquellas posibles ampliaciones que se pueden acometer como continuación al trabajo realizado. Esto último puede constituir una sección por sí misma denominada trabajo futuro. Dependiendo de la extensión del trabajo serán un capítulo o una sección.

Notas (Notes). Esta sección incluye las notas divididas por capítulos  si es que no han sido añadidas al pie de página. Puede sustituir a la bibliografía en textos divulgativos.

Bibliografía* (Bibliography o References)Consiste en una lista detallada de las fuentes de información citadas en el  trabajo. Su propósito principal es proporcionar una referencia completa y precisa de las fuentes consultadas. Permite a los lectores interesados acceder a esas fuentes y profundizar en el tema. Es una parte esencial del trabajo ya que proporciona credibilidad y contribuye a dar el crédito adecuado a las obras de otros. El formato y estilo de la bibliografía dependen de las pautas de citación que se utilicen. No se deben incluir trabajos no citados en el texto (véase Referencias bibliográficas para sugerencias y recomendaciones de formato). Dependiendo de la extensión del trabajo será un capítulo o una sección.

Apéndices o Anexos (Appendix o Annex). Permiten incluir material adicional que completa el trabajo y no tiene cabida en el cuerpo del mismo. 

Glosario de términos (Glossary). Es recomendable en textos extensos como un libro, en especial, si tiene un carácter divulgativo. Consiste en una lista alfabética de términos acompañados de su definición que tiene como objetivo explicar palabras, frases o conceptos específicos utilizados en el documento. Es recomendable en textos extensos como un libro, en especial, si tiene un carácter divulgativo.

GUÍA DE ESTILO

Un documento científico-técnico debe reflejar el rigor y la seriedad con que se ha realizado el trabajo. Tiene que ser claro, preciso y conciso. Las siguientes recomendaciones incluyen una serie de consejos orientados a mejorar la calidad de la redacción y la comprensión de un texto. Primeramente, se listan recomendaciones centradas en la redacción, y a continuación, se incluyen en orden alfabético aspectos específicos que ayudan a dar un formato correcto al documento.

  • El texto debe estar libre de faltas de ortografía. Se recomienda emplear correctores ortográficos automáticos.
  • Redactar en estilo directo, evitando las construcciones pasivas. 
  • Emplear párrafos cortos que contengan una única idea. 
  • Las oraciones deben ser cortas e incluir sujeto, verbo y predicado. 
  • No abusar de perífrasis3 y expresiones redundantes. 
  • Evitar los circunloquios4 y pleonasmos5.
  • No incluir términos o expresiones repetidos.
  • No abusar de la preposición «de»: dando lugar a sintagmas nominales muy largos. Se pueden reducir empleando oraciones subordinadas.
  • No abusar de expresiones de duda o incertidumbre.
  • No abusar de adverbios terminados en -mente.
  • No abusar de las proposiciones subordinadas basadas en un gerundio.
  • Se recomienda apoyarse en ChatGPT (https://chat.openai.com/) si es preciso parafrasear algún párrafo para que quede más claro.

Abreviaturas6. Permiten acortar palabras mediante la omisión de una o más letras.

  • Se finalizan con un punto y van seguidas de espacio: p. ej. ó art.
  • Abreviaturas más frecuentes: p. ej., etc., et al., art., cap., fig., p. ó pág., pp. (página), ec., bibl. ó bibliogr.
  • Las palabras artículo, capítulo, figura, tabla, página, ecuación, bibliografía, etc. no se abrevian excepto cuando van entre paréntesis o cuando aparecen en notas o citas bibliográficas. 

Citas. Las citas textuales reproducen las mismas palabras que el autor original.

  • En español se emplean comillas latinas «cualquier pedagogía que proviniese de una fuente distinta nos privaría de la lección esencial, la de ver la vida y las cosas con ojos humanos». 
  • En inglés comillas dobles, “Imagination is more important than knowledge. For knowledge is limited, whereas imagination embraces the entire world, stimulating progress, giving birth to evolution.”

Coma.

  • La coma nunca debe separar el sujeto del predicado en una oración7.
  • Tampoco se coloca una coma entre el verbo y el complemento.
  • No se añade coma antes de una conjunción, al contrario del inglés, que sí que está admitido dependiendo del estilo8. P. ej., «el conjunto de entrenamiento, de desarrollo y de evaluación», frente a «train, devel, and test dataset».

Código fuente.

  • Indentación. 2, 4 ó 8 espacios. Siempre emplear espacios en lugar de tabulaciones. La mayoría de los editores se pueden configurar para incluir espacios cuando se pulsa la tecla de tabulación.
  • Tamaño líneas. 80 caracteres máximo por línea
  • El tipo de letra tiene que ser una fuente monoespaciada (courier o similar).
  • Incluir los números de línea, resaltado (a ser posible).

Ecuaciones.

  • Todas las ecuaciones deberán ir numeradas a su derecha. 
  • Las ecuaciones tienen que estar referenciadas en el texto. 
  • Todos los símbolos de las ecuaciones tienen que estar descritos indicando qué representan.
  • Si un símbolo se repite en siguientes ecuaciones ya no es necesario describirlo. 
  • En caso de utilizar muchas ecuaciones puede introducirse el glosario de símbolos para evitar describir todos los símbolos constantemente.

Encabezado. No es obligatorio. Se puede incluir el nombre del apartado correspondiente a la página, de manera que sea fácil situarse en el documento.

Epígrafes. Los epígrafes (o lemas) son citas que suelen aparecer al comienzo de un libro o de un capítulo. Se componen con una fuente ligeramente menor, alineados a la derecha, en redonda y sin comillas. El nombre del autor se escribe en versalitas9, y se acompaña de la obra donde aparece o la fecha. La procedencia de la cita no sé finaliza con punto.

Extranjerismos. Son palabras que se toman prestadas de otros idiomas.

  • Hay que intentar evitarlos. Consultar primero Fundéu por si hubiera un sustituto en español razonable, p. ej., «enlace» mejor que link, «inicio de sesión» mejor que login10
  • En caso de que no sea posible se escriben en cursiva: embedding, end-to-end.
  • Aquellos que se han incorporado al español como sustantivos comunes se escriben en redonda y minúscula: web, wifi, bot, hardware, software…
  • Los nombres comerciales se escriben sin cursiva respetando la grafía original.
    • arXiv, Python, GitHub

Fechas. En español, los meses y días del año se escriben en minúscula mientras que en inglés comienzan en mayúscula.

Figuras.  

  • Las figuras tienen que ser claras y correctamente escaladas.
  • Deben tener un pie de figura que conste de la referencia de la figura, el título terminado en punto, y la descripción. Esta descripción debe permitir entender la figura sin necesidad de recurrir al texto.
  • La resolución recomendada es 300 dpi (120 puntos por centímetro). En esta resolución 10 centímetros se corresponden con 1200 píxeles.

Horas. Se escriben con cifras, separadas por dos puntos y formato de 24 horas. P. ej. 5:34, 17:46 o 23:59.

Notas. Sirve para proporcionar información adicional, respaldar las afirmaciones del autor, aclarar conceptos y permitir a los lectores profundizar en el contenido si lo desean. Pueden colocarse al pie de página o en una sección específica al final del documento. Se deben numerar.

Numeración de las páginas. Las páginas previas al cuerpo deben usar una numeración romana en minúscula. La primera página del cuerpo será la página 1 en numeración arábiga (1, 2, 3…) y continuará hasta el final del documento. Las páginas totalmente en blanco forzadas por la estructura del documento, aunque cuentan para la numeración, no mostrarán la numeración en la página ni ningún otro elemento, apareciendo totalmente en blanco. Los capítulos siempre comienzan en una página con numeración impar.

Números11. 

  • Es preferible el empleo de cifras en vez de letras, aunque dependiendo del contexto puede haber excepciones:
    • cardinales para representar números hasta el diez: uno, dos, tres,… diez
    • números elevados: 200 millones
  • Con espacio pequeño para separar miles: 100 000 (excepto en los años: 2023).
  • Con punto para separar los decimales: 3.14
  • Billón en español es 1012 (un millón de millones) mientras que inglés billion es 109 (mil millones)
  • Es importante que las cantidades tengan un número de cifras significativas acorde con la significancia de estas y el posible error de la cantidad expresada.

Pie de páginas. Incluir, al menos, la numeración de las mismas.

Prefijos12. Los prefijos se escriben unidos a la palabra que acompañan (antivirus, supermodelo, anteayer, exmarido, vicepresidente, sobrealimentar, contraoferta, precandidato); por tanto, no son adecuadas las grafías en las que el prefijo aparece unido con un guión (vice-ministro, anti-mafia) o separado por un espacio en blanco (vice ministro, anti mafia).

Punto

  • No debe ir punto final detrás de los signos de admiración o exclamación que cierran.
  • Tampoco llevan punto final los títulos.
  • Las referencias bibliográficas y los pies de las figuras, tablas, cuadros, etc. llevan punto al final.
  • Se escriben fuera de los paréntesis, comillas, rayas…

Referencias bibliográficas.

  • Toda fuente que se haya consultado tiene que estar incluida en la bibliografía y referenciada en el texto.
  • Recomendaciones: formato ACM13 o IEEE14 para texto tecnológicos, formato APA15 para textos científicos, y UNE-ISO 69016 si no se tiene claro el formato.
  • Las referencias a páginas web se incluyen en la bibliografía excepto si se hace referencia al sitio web completo. En este caso se incluye en el propio texto entre paréntesis. Ej. «Se recomienda apoyarse en ChatGPT (https://chat.openai.com/)».

Referencias cruzadas.

  • Todas las figuras y tablas tienen que referenciarse en el texto mediante referencia numérica. Por ejemplo, «véase la Figura 2.1», «tal como muestra la Figura 4.2»… 
  • Evitar referencias del estilo: la siguiente figura, la figura más arriba, la figura que se muestra a continuación…
  • «Véase» mejor que «ver».

Siglas y acrónimos17.

  • Incluir la traducción si existe y es conocida, p. ej., PLN en vez de NLP. 
  • La primera vez que se emplee una sigla se recomienda acompañarla de su desarrollo: inteligencia artificial (IA) o procesamiento de lenguaje natural (PLN).
  • Siglas y acrónimos se escriben en mayúsculas, sin acentos y sin puntos abreviativos (PLN, en vez de P. L. N.). 
  • No se marcan el plural: «las URL que aparecen», en vez de «las URLs que aparecen».
  • El desarrollo de las siglas se escribe con mayúscula cuando corresponde a un nombre propio o expresión denominativa análoga («RAE» = «Real Academia Española»), pero no cuando corresponden a una expresión común («ONG» = «organización no gubernamental»)18.
  • Las siglas de los nombres formados por dos palabras en plural: se duplican las letras iniciales, se escriben en mayúscula y van seguidas por el punto abreviativo y un espacio tipográfico. P. ej. es correcto RR. HH. pero no  RRHH ó RR HH.
  • Las siglas en inglés se mantienen si no tienen una traducción usada en español: URL, IP. Se puede indicar el desarrollo en inglés «una URL (del inglés, Uniform Resource Locator)»
  • Extensiones de archivo y formatos: en mayúsculas y sin punto si se trata de la sigla del formato: «Te mando el PDF que me pediste». En minúscula y con punto si hace referencia a la extensión: «Mueve todos los archivos .doc a este directorio»19.
  • Hay que estar atentos a los acrónimos lexicalizados como pyme o pymes, que se escriben en minúscula.

Símbolos20. Son representación de un concepto científico o técnico, formado por letras o signos convencionales (ej. kg, cm, %…). 

  • Seguir el Sistema Internacional de Unidades (SI) publicado en BOE 2010-91721.
  • Se escriben sin punto final (a no ser que coincida con el final de la oración), no tiene plural, y se deja un espacio entre el número y el símbolo.
  • Magnitudes temporales: nanosegundo ns; microsegundo μs; milisegundo ms; segundos, s; minuto, min; hora, h; día, d.
  • Unidades de información: byte, B; megabyte, MB; gigabyte, GB.
  • Ejemplos,
    • 30 %
    • 200 kg

Tipo de letra. Tamaño 11 ó 12  con párrafos justificado.

TERMINOLOGÍA INGLÉS Y ESPAÑOL

accuracyexactitud
artificial intelligence (AI)inteligencia artificial (IA)
corpuscorpus
clustergrupo, segmento o clúster
clusteringsegmentación
databasebase de datos
data setconjunto de datos
deep learning (DL)aprendizaje profundo
extract-load-transform (ETL)extraer, cargar y transformar (ETL)
exploratory data analysis (EDA)análisis exploratorio de datos
fine-tuningajuste fino
foundational modelmodelo fundacional
large language model (LLM)modelo lingüístico de gran tamaño
machine learning (ML)aprendizaje automático (AA)
natural language processing (NLP)procesamiento de lenguaje natural (PLN)
neural networkred neuronal
precision

pretrained language model
precisión

modelo lingüístico preentrenado
recallcobertura
test (data) setconjunto de prueba
training (data) set conjunto de entrenamiento
validation (data) set, devel setconjunto de validación
Propuesta de traducción de términos técnicos del inglés al español

CRÉDITOS

Este documento tiene como punto de partida el Diccionario urgente de estilo científico del español de Juan Antonio Pérez Ortiz publicado en 1999. Toma de esta obra tanto la idea como varias de las entradas del mismo que han sido actualizadas y reescritas. Durante el texto se han incluido citas a las recomendaciones de la Fundéu y la RAE. También se ha consultado las guías de estilo de la Universidad Autónoma de Madrid y la de trabajos fin de grado de la Escuela Politécnica Superior de esta universidad elaborado por Eloy Anguiano, y la guía de Escritura Científico-Técnica en Laboratorios de electrónica, Versión 1.0, de Juan Manuel Montero Martínez. Han sido de gran valor las sugerencias y revisión al texto realizadas por Jordi Porta él cual es autor de alguna de las entradas del texto.

NOTAS

  1. Un ejemplo es la libro de estilo de la Universidad Autónoma de Madrid. https://www.uam.es/uam/gabinete-comunicacion/libro-estilo ↩︎
  2.  https://www.fundeu.es/recomendacion/estado-del-arte-calco-inapropiado-de-state-of-the-art-1202/ ↩︎
  3. La perífrasis es una construcción sintáctica que consiste en utilizar varias palabras o expresiones para describir una sola idea o concepto. Se emplea para darle variedad o riqueza al lenguaje. ↩︎
  4. El circunloquio es una figura retórica que se caracteriza por utilizar un rodeo o una descripción amplia y detallada para expresar algo que podría decirse de manera más directa y sencilla. ↩︎
  5. Un pleonasmo es una figura retórica y lingüística que consiste en la inclusión de palabras innecesarias o redundantes en una frase u oración, es decir, palabras que no aportan información adicional y que podrían ser omitidas sin cambiar el significado de la expresión. ↩︎
  6.  https://www.fundeu.es/recomendacion/seis-claves-para-usar-las-siglas-y-las-abreviaturas-1189/ ↩︎
  7.  https://www.fundeu.es/escribireninternet/la-coma-criminal/ ↩︎
  8. https://en.wikipedia.org/wiki/Serial_comma ↩︎
  9. Fuente de letra todo en mayúsculas ↩︎
  10.  https://www.fundeu.es/recomendacion/internet-terminos-relacionados-1315/ ↩︎
  11. https://www.wikilengua.org/index.php/N%C3%BAmero#Cifra_frente_a_letras ↩︎
  12.  https://www.fundeu.es/recomendacion/prefijos-claves-para-una-buena-redaccion-817/ ↩︎
  13. https://www.acm.org/publications/authors/reference-formatting ↩︎
  14. https://biblioguias.uam.es/citar/estilo_ieee ↩︎
  15. https://biblioguias.uam.es/citar/estilo_apa_7th_ed ↩︎
  16. https://biblioguias.uam.es/citar/estilo_une ↩︎
  17. https://www.fundeu.es/recomendacion/siglas-y-acronimos-claves-de-redaccion/ ↩︎
  18. https://x.com/RAEinforma/status/1372517856898904064?s=20 ↩︎
  19. https://x.com/RAEinforma/status/1019479579541626880?s=20 ↩︎
  20.  https://www.fundeu.es/recomendacion/seis-claves-para-usar-las-siglas-y-las-abreviaturas-1189/
    ↩︎
  21. https://www.boe.es/buscar/doc.php?id=BOE-A-2010-927 ↩︎