un fișier readme oferă informații despre un fișier de date și este destinat să vă asigure că datele pot fi interpretate corect, de către dvs. la o dată ulterioară sau de Metadatele bazate pe standarde sunt, în general, preferabile, dar acolo unde nu există un standard adecvat, pentru uz intern, scrierea metadatelor în stil „readme” este o strategie adecvată.

vrei un șablon?, Descărcați unul și adaptați-l pentru propriile date!

  • cele mai Bune practici
  • conținut Recomandat
    • informații Generale
    • Date și fișierul imagine de ansamblu
    • Partajare și acces la informații
    • Metodologice de informații
    • Date-informații specifice
  • informații Legate

Cele mai bune practici

Creați fișiere readme pentru logică „clustere” de date. În multe cazuri, va fi necesar să se creeze un singur document pentru un set de date care are mai multe fișiere similare, formatate în mod similar, sau fișiere care sunt grupate logic împreună pentru utilizare (de ex., o colecție de scripturi Matlab). Uneori poate avea sens să creați un readme pentru un singur fișier de date.

denumiți readme-ul astfel încât să fie ușor asociat cu fișierele de date pe care le descrie.

scrieți documentul readme ca fișier text simplu, evitând formatele proprietare, cum ar fi MS Word, ori de câte ori este posibil. Formatați documentul readme astfel încât să fie ușor de înțeles (de exemplu, separați bucăți importante de informații cu linii goale, în loc să aveți toate informațiile într-un singur paragraf lung).

formatați mai multe fișiere readme identic., Prezentați informațiile în aceeași ordine, folosind aceeași terminologie.

utilizați formate de date standardizate. Format sugerat: W3C / ISO 8601 data standard, care specifică notația standard internațional de AAAA-LL-ZZ sau AAAA-LL-Zzthh: mm: ss.urmați convențiile științifice pentru disciplina dvs. pentru nume și cuvinte cheie taxonomice, geospațiale și geologice. Ori de câte ori este posibil, utilizați termeni din taxonomii și vocabulare standardizate, dintre care câteva sunt enumerate mai jos.conținutul minim recomandat pentru reutilizarea datelor este scris cu caractere aldine.,de

  • Persoanele implicate cu proba de colectare, prelucrare, analiză și/sau depunerea

    • Date-informații specifice

    *Repetați această secțiune după cum este necesar pentru fiecare set de date (sau fișier, după caz)*

    1. numărul de variabile și numărul de cazuri sau rânduri
    2. listă de Variabile, inclusiv numele complet și definiții (scrie abreviat cuvinte) din titlurile de coloană pentru date tabelare
    3. Unități de măsură
    4. Definiții pentru coduri sau simboluri folosite pentru a înregistra datele care lipsesc
    5. Specializate formate sau alte abrevieri utilizate

    Vrei un șablon?, Descărcați unul și adaptați-l pentru propriile date!liniile directoare precedente au fost adaptate din mai multe surse, inclusiv:

    cele mai bune practici pentru crearea de publicații de date reutilizabile. Driadă. 2019. https://datadryad.org/stash/best_practices

    formate de fișiere. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/file-formats

    introducere în drepturile de proprietate intelectuală în gestionarea datelor. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/intellectual-property

    metadate și descrierea datelor. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/writing-metadata