Obsah README se může lišit podle vědního oboru, typu dat nebo požadavků konkrétního repozitáře. Základní informace by ale měly uživateli umožnit porozumět datasetu bez nutnosti dohledávat další dokumentaci.
Mezi nejdůležitější patří:
- Základní informace o datasetu: název, autor nebo odpovědná osoba, kontaktní údaje, pracoviště a informace o sběru dat.
- Přehled souborů: názvy jednotlivých souborů, jejich stručný popis a případně datum vytvoření.
- Metodologie: jakým způsobem byla data získána a zpracována, včetně použitých nástrojů, softwaru nebo přístrojů.
- Popis dat: vysvětlení proměnných, zkratek, kódů, jednotek měření a způsobu označování chybějících hodnot.
- Podmínky přístupu a opětovného využití: licence nebo jiná pravidla určující, zda a jak lze data používat, upravovat a sdílet.
Užitečné je také uvést strukturu datasetu, historii jeho vzniku, datum poslední aktualizace README nebo verzi dat, ke které se dokument vztahuje.
Zvláštní pozornost si zaslouží informace o licenci a podmínkách opětovného využití. Uživatel by měl snadno zjistit, co s daty může dělat a zda se na jejich využití vztahují nějaká omezení.
V případě dat poskytovaných v rámci anonymního recenzního řízení je zároveň potřeba dbát na to, aby README neobsahoval údaje, které by mohly odhalit identitu autorů.
Praktická šablona
