Підготовка README-файлу
Ми допомагаємо дослідникам та дослідницьким групам готувати чіткі, структуровані та багаторазові файли README для наборів даних, програмного забезпечення, робочих процесів та пакетів даних FAIR.
У гарному файлі README пояснюється, що містять файли, як вони були створені, як їх слід використовувати, яке програмне забезпечення або методи потрібні, як слід цитувати набір даних та які ліцензійні умови або умови доступу застосовуються.
Надіслати запит на консультацію
Що підтримує цей сервіс
Документація набору даних
Ми допомагаємо описати вміст, структуру, призначення та контекст набору даних, щоб інші користувачі могли його зрозуміти та повторно використовувати.
Пояснення структури файлів
Ми підтримуємо опис папок, файлів, форматів, правила іменування, версій та зв'язків між файлами.
Інструкції щодо повторного використання
Ми допомагаємо документувати, як дані можна відкривати, обробляти, аналізувати або повторно використовувати.
Інформація про цитування та доступ
Ми допомагаємо включити інструкції з цитування, ліцензію, умови доступу, пов'язані публікації, посилання на DOI або репозиторії.
Як процес працює
1. Запит
Ви надсилаєте запит на консультацію та коротко описуєте набір даних, програмне забезпечення, робочий процес або пакет FAIR.
2. Початковий огляд
Центр компетенцій переглядає доступні матеріали та визначає, який тип README потрібен.
3. Аналіз структури файлів
Переглянуто структуру файлів, папок, форматів та пов'язаної з ними документації.
4. Підготовка README
Чернетка README готується з використанням структурованого шаблону та належних практик управління дослідницькими даними.
5. Готовий до публікації
Файл README можна включити до депозиту DataverseUA, пакету даних FAIR, запису репозиторію або проекту.
Що слід підготувати користувачам
Для ефективного процесу користувачам рекомендується підготувати:
- назву набору даних або проекту;
- короткий опис набору даних або результатів дослідження;
- список файлів або структуру папок;
- інформацію про формати файлів;
- опис методів, інструментів, програмного забезпечення або робочих процесів;
- посилання на пов’язану публікацію, проект, DOI або репозиторій, якщо є;
- інформацію про авторів, учасників та контактну особу;
- умови ліцензії або доступу, якщо відомі;
- існуючі метадані або чернетку репозиторію, якщо є;
- питання щодо того, як дані слід описувати або повторно використовувати.
Очікувані результати
Залежно від запиту, результат може включати:
- повний файл README;
- вдосконалений проект README;
- рекомендації щодо організації файлів та документації;
- чітке пояснення структури набору даних та форматів файлів;
- інструкції щодо повторного використання даних;
- інформацію про цитування та ліцензії;
- посилання на пов'язані публікації, набори даних, програмне забезпечення або робочі процеси;
- файл README, підготовлений для публікації DataverseUA;
- файл README, підготовлений як частина пакету даних FAIR;
- рекомендації щодо покращення зрозумілості набору даних та потенціалу повторного використання.
Структура README
Типовий README-файл для дослідницького набору даних може містити:
- Назву набору даних та короткий опис
Стисле пояснення того, що містить набір даних і чому він був створений.
2. Автори та контактна інформація
Імена, місця роботи та контактна особа, відповідальна за набір даних.
3. Структура файлів і папок
Опис файлів, папок, правил іменування, версій та зв'язків між файлами.
4. Методи та походження
Інформація про те, як дані були згенеровані, зібрані, оброблені або куровані.
5. Програмне забезпечення та залежності
Програмне забезпечення, скрипти, блокноти, бібліотеки, інструменти або обчислювальні середовища, необхідні для використання даних
6. Формати даних
Опис форматів файлів, одиниць вимірювання, змінних, стовпців, параметрів або таблиць метаданих.
7. Умови ліцензування та доступу
Інформація про те, як дані можуть бути повторно використані та чи застосовуються якісь обмеження.
8. Цитування та пов'язані ресурси
Рекомендоване цитування, DOI, пов'язані публікації, проекти, програмне забезпечення, моделі або робочі процеси.
9. Примітки щодо повторного використання
Практична інформація для користувачів, які хочуть відтворити, перевірити, проаналізувати або розширити набір даних.
Надіслати запит
Щоб отримати допомогу з підготовкою README, будь ласка, скористайтеся формою запиту на консультацію.
Надіслати запит на консультацію