Чтобы задокументировать источник набора данных на Mac, создайте текстовый файл README рядом с данными и укажите поставщика, исходную страницу или идентификатор, дату загрузки, версию, лицензию и любые внесенные вами изменения. Храните эту заметку вместе с файлами проекта, чтобы источник можно было найти снова, даже если тег Finder, закладка или история загрузок будут утеряны. Это руководство предназначено для пользователей Mac, работающих с локальной папкой проекта.

Создайте заметку об источнике рядом с набором данных

В Finder откройте папку проекта и выберите Файл > Новая папка (или нажмите Shift-Command-N), если вам нужна папка для исходного файла и сопроводительной документации. Дайте ей понятное имя, например data-source, либо сохраните заметку в папке, где уже находится набор данных. Apple описывает эту команду создания папок в Finder; хранение метаданных рядом с данными соответствует государственным рекомендациям по учету информации о наборах данных. Упорядочение файлов в Finder на Mac, Запись информации о наборах данных, которыми вы делитесь с другими

Откройте TextEdit из папки «Программы» или через Spotlight. Выберите Формат > Конвертировать в простой текст, затем создайте новый документ. Простой текст (plain text) — практичный выбор, поскольку его можно открыть без специального текстового редактора и легко читать рядом с набором данных; Корнеллская служба данных (Cornell Data Services) рекомендует использовать простой текст для файлов README к данным. Сохраните его в той же папке, что и набор данных, под именем README.txt или README.md. Если в диалоговом окне сохранения TextEdit предлагает расширение форматированного текста, проверьте имя файла и формат перед сохранением; названия меню и диалоговые окна могут различаться в зависимости от версии macOS. Написание файлов README для исследовательских данных

Зафиксируйте достаточно деталей для точной идентификации источника

Используйте компактную запись, подобную приведенной ниже, заменяя каждый пункт проверенной информацией. Оставляйте поле с пометкой «неизвестно» («unknown»), если не можете его подтвердить; не пытайтесь угадывать.

  • Название набора данных и имя файла:
  • Исходный поставщик или создатель:
  • URL страницы источника или постоянный идентификатор:
  • Версия, выпуск или дата публикации:
  • Дата получения (ГГГГ-ММ-ДД):
  • Лицензия или условия повторного использования, указанные поставщиком:
  • Охват или содержимое, относящееся к этому проекту:
  • Изменения, внесенные в загруженную копию:
  • Связанные файлы или документация:

URL страницы источника должен указывать на страницу набора данных на сайте поставщика (при ее наличии), а не только на временную ссылку для скачивания. Добавьте идентификатор, такой как DOI, если поставщик его предоставляет. Стандарты каталогов данных разграничивают целевую страницу набора данных, издателя, лицензию, версию и происхождение; их раздельная фиксация упрощает понимание того, откуда взялась копия и какой именно выпуск она представляет. Стандарты данных: Набор данных

Указывайте дату загрузки или получения файла, не путая ее с датой создания самого набора данных. Если вы можете подтвердить дату выпуска или обновления от поставщика, укажите ее отдельно. Используйте фактическое название поставщика и пишите наименование организации полностью, не полагаясь на неоднозначные сокращения. Руководство GOV.UK рекомендует указывать автора набора данных, время его создания и уникальный идентификатор, а также советует использовать пометку «неизвестно», если информация недоступна. Запись информации о наборах данных, которыми вы делитесь с другими

Опишите, что произошло после загрузки

Запись об источнике должна четко разграничивать исходные данные поставщика и версию, используемую в вашем проекте. Укажите, переименовывали ли вы файлы, фильтровали ли строки, объединяли ли источники, конвертировали ли форматы или исправляли значения. Если данные не менялись, утверждайте это только в том случае, если уверены в этом. Для производного файла укажите имя исходного файла и кратко опишите операцию; дайте ссылку на скрипт или аналитическую записку, если они содержат воспроизводимые шаги. Руководство по документированию данных Sandia специально рекомендует называть исходный источник для производных данных и перечислять шаги обработки. Документирование данных – FAIR(ER) Data Sharing

Например, пишите «Отфильтровано по строкам за 2022–2024 гг.; сохранено как sales_2022_2024.csv» только тогда, когда это точно описывает проделанную работу. Не перезаписывайте исходный файл без явного указания: по возможности сохраняйте нетронутую копию и давайте преобразованным результатам другие имена файлов. Если на странице поставщика указана лицензия или ограничения на использование, зафиксируйте эту формулировку или укажите ссылку на нее; заметка помогает найти условия, но не освобождает от проверки того, разрешено ли планируемое вами использование.

Используйте теги Finder только для быстрого доступа

Тег Finder может помочь быстрее найти набор данных или README позже. Выберите элемент в Finder, выберите Файл > Теги или щелкните его, удерживая клавишу Control, и выберите тег. Apple отмечает, что теги можно использовать для поиска отмеченных элементов на боковой панели Finder или через поиск; теги — это ярлыки для поиска файлов, а не замена документированию поставщика, версии и изменений в файле README. Использование тегов для упорядочения файлов на Mac

Перед тем как считать источник задокументированным, откройте файл README из папки проекта и убедитесь, что имя файла совпадает с тем, который вы использовали, его URL-адрес или идентификатор достаточно конкретны для повторного поиска источника, а каждая дата имеет ясное значение. Если вы не можете определить точную версию, укажите это ограничение в заметке. Краткая, но точная запись гораздо полезнее, чем заполнение каждого поля догадками.

Источники