Stáhli jste si výzkumná data z repozitáře, otevřeli soubory a zjistili, že vlastně nevíte, co obsahují a jak s nimi pracovat? Právě v takové situaci pomůže README. Jednoduchý textový soubor, který poskytuje základní informace o datasetu a usnadňuje jeho pochopení i opětovné využití. Česká komunita data stewardů nyní nabízí výzkumníkům praktickou šablonu, která jim s přípravou README pomůže.
README je jednoduchý soubor, který doprovází výzkumná data a poskytuje informace potřebné k jejich správnému pochopení a použití. Vysvětluje, co jednotlivé soubory obsahují, jak data vznikla, co znamenají používané proměnné nebo zkratky a za jakých podmínek lze data dále využívat.
Podobné informace mohou být součástí vědeckého článku nebo samostatné dokumentace. Tyto materiály ale nemusejí být uloženy společně s daty a časem mohou být obtížně dostupné. README proto představuje jednoduchý způsob, jak důležité informace uchovat přímo u datasetu.
Při ukládání dat do repozitáře se dnes přiložení README považuje za dobrou praxi. Pomáhá nejen dalším uživatelům, ale i samotným autorům, kteří se ke svým datům mohou vracet s větším časovým odstupem.
„V době, kdy vytváříme více dat, než jsme schopni zpracovat, můžeme my, výzkumníci a data stewardi, snadno ztratit přehled nejen o datových sadách ostatních, ale i o těch, které sami vytváříme. Soubory README existují již řadu let, dosud se však využívaly především v oblasti softwaru. Proto nám připadalo důležité nabídnout univerzální šablonu, která bude použitelná pro výzkumná data napříč různými vědními obory,“
vysvětluje Georgia Koutentaki
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ří:
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ů.
Aby výzkumníci nemuseli vytvářet README od začátku, připravil kolektiv data stewardů z české Data Steward Community univerzální šablonu README pro výzkumná data. Ta nabízí přehlednou strukturu a pomáhá uživatelům identifikovat informace, které by při dokumentaci datasetu neměly chybět.
Šablona je volně dostupná na GitHubu a lze ji přizpůsobit potřebám konkrétního výzkumu. K dispozici jsou varianty ve formátech TXT, Markdown a JSON. Projekt se dále zaměřuje na rozvoj oborově specifických šablon a podporu principů FAIR, které usnadňují vyhledávání, dostupnost, interoperabilitu a opětovné využívání výzkumných dat.
Šablona je k dispozici ve třech formátech – .txt, .md a .json –, aby vyhovovala všem potřebám a umožňovala návaznost na služby pro automatizované zpracování dat. Využití šablony se neomezuje pouze na české prostředí správy výzkumných dat.
V záznamu školení jsou k nalezení také odkazy na další užitečné zdroje věnované README, například projekt The Turing Way.
Zájemci, kteří by se chtěli zapojit do přípravy a rozvoje šablon, mohou kontaktovat Georgii Koutentaki na adrese georgia.koutentaki@cvut.cz.
„Šablona vznikala s ohledem na rozvoj české Národní datové infrastruktury (NDI) s cílem poskytnout jednotný způsob, jak popisovat data ukládaná do stávajících i nově vznikajících repozitářů. Využití šablony se však neomezuje pouze na české prostředí. Doufáme, že naše příklady vyplněných README souborů poslouží jako praktický průvodce všem, kteří potřebují s jejich tvorbou pomoci,“
doplňuje Georgia Koutentaki
Praktické příklady README souborů, další užitečné zdroje i informace o vzniku projektu představila Georgia Koutentaki během školení README (please) – introduction, které proběhlo v rámci Letní školy pro data stewardy 2026.
Pro přípravu vlastního README můžete rovnou využít:
Národní technická knihovna spouští Národní repozitář, který pomůže výzkumným organizacím i dalším institucím naplnit novou zákonnou povinnost otevřeného ukládání vědeckých publikací.
Nová služba Onedata má uživatelům e-INFRA CZ usnadnit práci s velkými objemy výzkumných dat. Data uložená na různých místech zpřístupní v jednom společném prostředí a zjednoduší jejich přesun k výpočetním kapacitám i další práci během výzkumného procesu.
