Wytyczne dla deponujących

Wytyczne przedstawione na tej stronie mają na celu ujednolicenie zasad deponowania danych w repozytorium oraz usprawnienie całego procesu. Ich stosowanie ułatwi przygotowanie i przekazywanie danych, a także przyspieszy ich weryfikację przez administratorów. 

Wprowadzone standardy pozwalają na zachowanie spójności gromadzonych zasobów oraz przyspieszają procedurę ich sprawdzania i publikacji. Mając jednak na uwadze specyfikę oraz dużą różnorodność danych, w przypadkach, w których zapisy niniejszych wytycznych nie dają się zastosować do konkretnego zbioru lub budzą wątpliwości, prosimy o bezpośredni kontakt z weryfikującymi w celu indywidualnego wypracowania odpowiedniego rozwiązania.


Dane badawcze to różnego rodzaju materiały potrzebne do uzyskania wyników badań naukowych i ich oceny, na przykład:

  • wyniki pomiarów
  • notatki z obserwacji, wyniki kwerend
  • komentarze do analizowanych tekstów, streszczenia, wypisy
  • bazy motywów literackich, wykresy, mapy, analizy cyfrowe
  • kwestionariusze, wyniki ankiet
  • nagrania audio i wideo, grafiki
  • modele matematyczne
  • oprogramowanie
  • opisy metodologiczne…

Publikacje, np. artykuły naukowe, powinny trafiać do repozytorium publikacji, na przykład serwisu OPEN.

Dane badawcze są udostępniane w repozytorium wraz z metadanymi. Oba te elementy stanowią główne i podstawowe składowe zbioru danych badawczych.

Metadane to ustrukturyzowane informacje o zbiorze danych. Umożliwiają odnalezienie danych i ułatwiają ich ponowne wykorzystanie. 

Tytuł zbioru danych

  • Tytuł powinien w skrótowy i jasny sposób identyfikować zawartość zbioru, wskazywać wprost na treść deponowanych danych, nie zawierać informacji nadmiarowych, np. imion i nazwisk autorów czy źródła finansowania.
  • Nie jest rekomendowane stosowanie frazy research data for… czy zbiór danych  dotyczących… w tytule zbioru danych. 
  • Tytuł opublikowanego artykułu naukowego nie jest najlepszym tytułem dla zbioru danych – dane mogą bowiem posłużyć do przygotowania kolejnych publikacji. 
  • Wielką literą powinno być zapisane tylko pierwsze słowo tytułu (oraz ewentualne nazwy własne). Dotyczy to również tytułów w języku angielskim. 
  • Język tytułu powinien być zgodny z językiem pozostałych metadanych. Jeżeli metadane tworzone są w więcej niż jednym języku, powinno się to odbywać konsekwentnie. 

Autor

  • Grupa pól metadanych dotyczących autora jest uzupełniana automatycznie informacjami podanymi w profilu zalogowanego użytkownika. 
  • Jeżeli autorem jest osoba, to format informacji w polu nazwisko i imię autora powinien być następujący: nazwisko [przecinek] imię. 
  • Najczęściej wskazywanym systemem identyfikacji jest ORCID. Właściwy format identyfikatora ORCID to XXXX-XXXX-XXXX-XXXX. 
  • Informacja w polu afiliacja powinna zostać podana w tym samym języku, co pozostałe metadane. 
  • Pole ROR instytucji afiliującej to pole podpowiadające – po wprowadzeniu fragmentu nazwy instytucji należy wybrać z listy odpowiednią nazwę. Jeżeli podano afiliację, należy podać także identyfikator ROR, jeśli dana instytucja taki identyfikator posiada. 

Opis zbioru danych

  • W tym polu powinny znaleźć się przede wszystkim informacje o deponowanych plikach lub zestawach plików z danymi: ich zawartości, rodzaju, strukturze, sposobie wewnętrznej organizacji (szczególnie jeśli dołączono archiwa ZIP). Należy podać informacje o oprogramowaniu użytym do wytworzenia danych, opisać kontekst projektu, a także podać wszelkie informacje, które mogą okazać się przydatne dla potencjalnego użytkownika, np. objaśnienia zastosowanych skrótów. 
  • Dobrą praktyką jest utworzenie i dołączenie do zbioru pliku readme, zawierającego szczegółowy opis danych. Jego przygotowanie może ułatwić szablon pliku readme. Należy zapisać plik w jak najprostszym formacie, np. TXT. W opisie zbioru można zasygnalizować obecność pliku readme wśród zdeponowanych materiałów, np. dopiskiem Dodatkowe objaśnienia znajdują się w pliku readme.txt / For detailed description please consult readme.txt file. 
  • Informacje dotyczące powiązanej publikacji lub grantu mogą znaleźć się w polu opis tylko w charakterze uzupełnienia. Powinny zostać umieszczone przede wszystkim w odpowiednich polach metadanych (powiązana publikacja, informacje o grancie). 

Słowa kluczowe

  • Opisywanie zbiorów za pomocą słów kluczowych ułatwia wyszukiwanie efektów badań. 
  • Słowa kluczowe powinny być spójne językowo z resztą metadanych. 
  • Względem poszczególnych słów kluczowych można zastosować słownictwo kontrolowane zgodne z dziedziną badań, np. słownik terminów medycznych, terminologia NATO. Słowniki i bazy można przeszukiwać np. tutaj
  • Każde słowo kluczowe powinno znaleźć się w oddzielnym polu. Słowa wprowadzone do jednego pola należy rozdzielić (można skorzystać z separatorów automatycznie rozdzielających elementy między przecinkami lub średnikami). 

Powiązana publikacja / powiązany zbiór danych

  • Należy wprowadzać tylko publikacje / zbiory danych, które już się ukazały / zostały opublikowane. Wszystkie podpola powinny zostać uzupełnione. 
  • Pole cytowanie powinno zawierać następujące informacje:
    • dla publikacji: autor/autorzy, rok, tytuł, wydawnictwo/czasopismo, numer/tom czasopisma, numery stron, identyfikator DOI (lub inny), najlepiej w postaci adresu URL. Informacje należy podać zgodnie z preferowanym standardem cytowania; 
    • dla zbioru danych: autor/autorzy, rok publikacji, tytuł, identyfikator, nazwa repozytorium, numer wersji. 
  • Rodzaj powiązania powinien być przemyślany i dobrze oddawać relację między zbiorem a publikacją. 
  • Jeżeli wskazano DOI jako typ identyfikatora publikacji/zbioru, należy podać je w zwykłej postaci, a nie w formie adresu URL (np. 10.123456/XYZ123 zamiast https://doi.org/10.123456/01XYZ123). 
  • Jeśli to możliwe, adres URL publikacji/zbioru powinien bazować na trwałym identyfikatorze DOI:
    • dobrze: https://doi.org/10.123456/01XYZ123, 
    • źle: https://strona.wydawcy.pl/tytul-artykulu. 

Informacje o grancie

  • Pola instytucja finansująca, skrócona nazwa instytucji, ROR instytucji finansującej i program grantowy są polami podpowiadającymi. Należy korzystać z sugerowanych informacji i nie dodawać do nich zbędnych elementów, np. numeru konkursu grantowego:
    • dobrze: OPUS, 
    • źle: OPUS 16. 
  • Należy zadbać o właściwy język metadanych w tych polach – powinien być spójny z pozostałymi metadanymi. 

Błędy językowe

Należy zwracać uwagę na poprawną interpunkcję, eliminować literówki i drobne błędy językowe. Przykłady często popełnianych błędów tego rodzaju: kropka na końcu tytułu zbioru; brak kropki na końcu opisu; niejednolity zapis słów kluczowych; wielkie litery w tytule zbioru; pomyłki pisarskie. 

Nazwy plików 

Powinny składać się jedynie ze znaków a–Z, 0–9, _ i nie zawierać spacji, polskich znaków ani innych znaków specjalnych. Dotyczy to również plików znajdujących się wewnątrz archiwów ZIP. 

Plik readme

Element dokumentacji zbioru; powinien znajdować się na szczycie listy plików. Właściwe kodowanie pliku to UTF-8, a właściwy format – TXT. Można skorzystać z szablonu dostępnego na stronie: https://data.research.cornell.edu/data-management/sharing/readme/ lub narzędzia https://rdm.mcmaster.ca/readme

Wersjonowanie

Jeżeli wprowadzono drobne zmiany w metadanych opublikowanego zbioru, osoba weryfikująca  opublikuje jego tzw. małą wersję – np. v. 1.1, 1.2. Jeżeli wprowadzono większe zmiany, szczególnie zmiany w plikach, opublikowana zostanie  wersja duża – v. 2, v. 3. Bardzo duże zmiany w zbiorze danych powinny być publikowane jako nowy zbiór danych, a nie jako nowa wersja istniejącego zbioru. 

Licencje

Należy zwrócić uwagę na konsekwentne stosowanie licencji, np. porównać informacje zawarte w pliku readme czy opisie zbioru z informacjami wskazanymi dla poszczególnych plików. Licencja zalecane dla plików z danymi to CC0 lub CC BY. 

Zalecane formaty plików i opracowanie danych tabelarycznych

Odpowiednie przygotowanie plików jest kluczowe dla umożliwienia poprawnej analizy danych tabelarycznych. Informacje na temat zalecanych formatów oraz właściwego opracowania danych tabelarycznych można znaleźć w dokumencie Zalecane formaty plików.

Data ostatniej aktualizacji: czerwiec 2026