Pliki README
Pliki README to prosty sposób na stworzenie dokumentacji zbioru danych:
- dzięki plikom README dane stają się zrozumiałe i użyteczne,
- zawierają informacje o kontekście danych, o tym, z którym projektem badawczym są powiązane, oraz o tym, jak należy je interpretować,
- pozwalają zrozumieć, w jaki sposób zbiór danych wiąże się z innymi zbiorami danych.
Plik README ma na celu umożliwienie prawidłowej interpretacji danych – zarówno przez twórcę/producenta danych (np. po paru latach od czasu zebrania danych), jak i przez inne osoby w przypadku udostępnienia danych. Do opisu danych preferowane są metadane oparte na międzynarodowych standardach, jednak nie zawsze te ustandaryzowane informacje są wystarczające, żeby zrozumieć dane, wtedy właściwym rozwiązaniem jest przygotowanie pliku README.
Pobierz szablon: Plik_readme_szablon i dostosuj go do swoich danych
Dobre praktyki
-
Liczba plików README
-
Tytułowanie plików README
-
Format zapisu plików README
-
Formatowanie tekstu w plikach README
-
Format daty i czasu używany w plikach README
-
Taksonomie i słowniki używane w plikach README
Zalecana zawartość plików README
-
Ogólne informacje
-
Informacje o plikach
-
Informacje dotyczące dostępu do danych
-
Informacje dotyczące metodologii badań
-
Informacje dotyczące danych