un archivo readme proporciona información sobre un archivo de datos y está destinado a ayudar a garantizar que los datos puedan interpretarse correctamente, por usted mismo en una fecha posterior o por otros al compartir o publicar datos. Los metadatos basados en estándares son generalmente preferibles, pero donde no existe un estándar apropiado, para uso interno, escribir metadatos de estilo «readme» es una estrategia apropiada.

¿Quieres una plantilla?, ¡Descarga uno y adáptalo a tus propios datos!

  • Best practices
  • Recommended content
    • General information
    • Data and file overview
    • Sharing and access information
    • Methodological information
    • Data-specific information
  • Related information

Best practices

Create readme files for logical «clusters» of data. En muchos casos, será apropiado crear un documento para un conjunto de datos que tenga varios archivos relacionados con un formato similar o archivos que se agrupen lógicamente para su uso (p. ej., una colección de scripts de Matlab). A veces puede tener sentido crear un readme para un solo archivo de datos.

nombre el Léame para que se asocie fácilmente con los archivos de datos que describe.

escriba su Documento readme como un archivo de texto sin formato, evitando formatos propietarios como MS Word siempre que sea posible. Formatee el documento readme para que sea fácil de entender (por ejemplo, separe partes importantes de información con líneas en blanco, en lugar de tener toda la información en un párrafo largo).

formatee varios archivos readme de forma idéntica., Presentar la información en el mismo orden, utilizando la misma terminología.

utilice formatos de fecha estandarizados. Formato sugerido: estándar de fecha W3C / ISO 8601, que especifica la notación estándar internacional de AAAA-MM-DD o AAAA-MM-DDThh:mm:ss.

siga las convenciones científicas para su disciplina de nombres y palabras clave taxonómicos, geoespaciales y geológicos. Siempre que sea posible, use Términos de taxonomías y vocabularios estandarizados, algunos de los cuales se enumeran a continuación.

contenido recomendado

El contenido mínimo recomendado para la reutilización de datos está en negrita.,

  • personas involucradas en la recolección, procesamiento, análisis y/o presentación de muestras

    • información específica de los datos

    *repita esta sección según sea necesario para cada conjunto de datos (o archivo, según corresponda)*

    1. recuento del número de variables y número de casos o filas
    2. lista de variables, incluidos los nombres completos y las definiciones (deletrear palabras abreviadas) de los encabezados de columna para datos tabulares
    3. unidades de medida

      4. li>

    4. definiciones de códigos o símbolos utilizados para registrar datos faltantes
    5. formatos especializados u otras abreviaturas utilizadas

    , ¡Descarga uno y adáptalo a tus propios datos!

    las directrices anteriores se han adaptado de varias fuentes, entre ellas:

    mejores prácticas para crear publicaciones de datos reutilizables. Dryad. 2019. https://datadryad.org/stash/best_practices

    formatos de Archivo. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/file-formats

    Introducción a los derechos de Propiedad Intelectual en la gestión de datos. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/intellectual-property

    metadatos y datos descriptivos. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/writing-metadata