Завжди легше створити документацію даних на початку дослідницького проєкту та оновлювати її протягом усього процесу дослідження. Гарна документація даних зазвичай пояснює:

Рівень проєкту:

• передумови та дизайн дослідження, наприклад, хто дослідники, спонсори, які цілі дослідження, гіпотези тощо
• метод збору даних
• структура файлів даних
• процедура очищення даних та інші прийняті заходи забезпечення якості
• версія набору даних та внесені зміни
• джерело використаних вторинних даних, якщо такі є
• ліцензія на повторне використання
• пов’язані публікації та інші результати досліджень

Змінний рівень:

• • визначення параметрів
  • одиниця вимірювання
  • формат даних, часу та інших параметрів
  • значення коду, наприклад, 1=жінка; 2=чоловік тощо
  • код для відсутніх значень
  • відповідний номер питання

Залежно від характеру дослідження та методу збору даних, документація даних може бути записана в різних формах, таких як файл Readme, словник даних, книга кодів, лабораторний зошит тощо. Усі вони мають однакову мету – забезпечити розуміння даних вашого дослідження поточними та майбутніми дослідниками (у тому числі вами), які хотіли б використовувати ці дані знову.

Файл Readme

Файл Readme містить інформацію про файл даних. Він допомагає іншим дослідникам та вам самим зрозуміти та повторно використовувати дані в майбутньому. Типовий файл Readme зазвичай зберігається у звичайному текстовому файлі, а не у власних форматах (наприклад, MS Word) для довгострокового доступу.

Ви можете дізнатися, як створити файл Readme чи адаптувати запропонований шаблон для даних за покликанням:

• Writing READMEs for Research Data
• AUTHOR_DATASET_ReadmeTemplate.txt

Словник даних

Словник даних – це файл, який містить змістовні описи для кожної змінної та значення вашого набору даних. Нижче наведено приклад з Open Science Framework (OSF). Дізнайтеся більше з розділу про те, як створити словник даних.

Кодова книга

Кодова книга надає інформацію про дані з інструменту опитування. Вона описує вміст, структуру та макет файлу даних, коди відповідей, що використовуються для запису відповідей на опитування, та іншу інформацію. Нижче наведено приклад з Посібника з кодових книг ICPSR Рекомендуємо вам ознайомитися з посібником ICPSR для отримання додаткової інформації.

Електронний лабораторний зошит

Лабораторний журнал документує вхідні дані, умови, робочі процеси та іншу інформацію під час проведення експерименту. Він фіксує походження даних, і таким чином покращує прозорість дослідницького процесу, а також підвищує правдивість результатів дослідження. Багато дослідників зараз використовують електронний лабораторний зошит (ELN) для заміни традиційних паперових лабораторних зошитів, оскільки він:

• Спрощує управління даними: ELN дозволяє зберігати інформацію в централізованому місці, що допомагає оптимізувати процес управління даними.
• Дозволяє проводити аудиторські випробування та забезпечує контрольований доступ: ELN надає організовану та контрольовану систему, яка сприяє проведенню аудитів та перевірок. Усі процеси редагування будуть реєструватися та мати позначку часу.
• Дозволяє пошук: ELN оцифровує весь процес дослідження, що полегшує відстеження попередніх експериментів.
• Забезпечує довгостроковий доступ: резервну копію ELN можна створити на сервері або в хмарі, що гарантує доступність у майбутньому.
• Покращує співпрацю: Обмін науковими даними, що зберігаються в ELN, між співробітниками набагато простіший порівняно з паперовими блокнотами.

Метадані означають дані про дані. Вони забезпечують структурований спосіб опису наборів даних стандартизованим чином, що читається машиною. Тобто це дозволяє різним комп’ютерам автоматично інтерпретувати вміст. Нижче наведено загальні елементи метаданих:

Стандарти метаданих

Метадані можуть бути записані в різних форматах, таких як текстові документи, HTML або XML. Прикладом широко використовуваного стандарту метаданих для загальних дослідницьких даних є Dublin Core (DC). Ви також можете скористатися наступними інструментами для визначення загальних стандартів метаданих, що використовуються у ваших предметних галузях:

• Дисциплінарні метадані – Центр цифрового курування (DCC)
• Каталог метаданих – Альянс дослідницьких даних (RDA)
• Пошук стандартів – Fairsharing.org