La documentación de los datos se refiere al proceso de describir, estructurar y contextualizar los datos de investigación para que sean comprensibles, reutilizables y verificables por otros científicos.
Esto incluye metadatos, diccionarios de datos, procedimientos de recopilación y procesamiento, así como licencias de uso.
La documentación garantiza la transparencia, reproducibilidad y accesibilidad de los datos, facilitando su reutilización en futuras investigaciones y promoviendo la colaboración científica. Además, mejora la calidad de la investigación y maximiza el impacto del conocimiento generado.
Es conveniente recopilar la siguiente información:
Para garantizar que los datos pueden ser replicados de manera sencilla y rentable es imprescindible añadir un fichero readme.txt con la información necesaria para que los datos sean comprensibles y reutilizables: descripción, metodología, coberturas, derechos de uso, privacidad.
Es necesario crear un fichero readme.txt para cada conjunto de datos y depositarlo con el resto de ficheros.
Un archivo readme es un fichero que describe un conjunto de datos. Es el archivo mínimo para documentar un conjunto de datos. Normalmente tiene formato TXT.
Los archivos readme permiten la interpretación y utilización de los datos, y se deposita junto a los datos en un repositorio como e-cienciaDatos.
Es recomendable crearlo al comienzo del proyecto e ir actualizándolo.
Los archivos readme contienen información sobre:
El consorcio Madroño ofrece una plantilla en español e inglés.isciplina.
Un diccionario de datos es un documento que describe en detalle la estructura, características y uso de los datos dentro de un conjunto de datos. Sirve como una guía para las personas usuarias, desarrolladoras y administradoras de bases de datos, facilitando la comprensión y gestión de los datos.
Elementos clave de un diccionario de datos:
Ejemplos de diccionarios de datos:
Además de la documentación explicativa y contextual recogida en un fichero Readme txt, es necesario describir los datos para poder identificarlos y organizarlos. Esta descripción se hace a través de los metadatos, información estructurada que ayuda a entender los datos con detalle y facilita a otros investigadores encontrarlos, utilizarlos y citarlos correctamente. Se desarrollan durante todo el ciclo de vida de los datos.
Cada área de conocimiento tiene su estándar propio y sus herramientas. Un estándar de metadatos proporciona conjuntos de elementos de metadatos, que tienen un propósito específico. A cada elemento se le da un nombre y una definición, basados en reglas, sintaxis y un vocabulario controlado.