Москва: проверенные б/у ноутбуки с гарантией и проверкой перед оплатой
+7 906 722-94-45

Главная → Статьи → Структура папок исследовательского проекта: версии и артефакты

Структура папок исследовательского проекта: версии и артефакты

Рабочая структура папок научного проекта: raw, processed, code, docs, output. Именование файлов, README, версии, архив и передача проекта коллеге.

Структура папок исследовательского проекта: версии и артефакты

Через год после защиты проектная папка обычно выглядит как археологический слой: данные_новые, данные_новые_2, финал, финал_правки, старое_не_трогать. Восстановить логику невозможно, а передать проект коллеге — тем более.

Правильная структура — скучная и предсказуемая. Ниже — рабочая схема.

Базовая структура

project/
  README.md
  data/
    raw/
    processed/
  code/
  docs/
    manuscript/
    notes/
  refs/
  output/
    figures/
    tables/
  archive/

Пояснения:

  • raw — исходные данные, которые нельзя менять.
  • processed — очищенные и объединённые данные.
  • code — скрипты обработки и графиков.
  • docs — текст, заметки, протоколы.
  • refs — библиография и PDF.
  • output — результаты, которые можно удалить и пересобрать.
  • archive — старые версии и сданные материалы.

Правила именования

  1. Дата в формате ISO. 2026-10-20_протокол.pdf.
  2. Никаких пробелов. Используйте дефисы или подчёркивания.
  3. Латиница. Кириллица ломает скрипты и архивы.
  4. Версия в имени. v01, v02, а не «финал».
  5. Коротко и осмысленно. survey_2026-09_clean.csv.
  6. Без личных данных. Имена участников — только в защищённой папке.

Запрещённые имена: final, final2, new, копия, исправленный.

Почему raw нельзя трогать

Исходные данные — доказательство. Если вы «поправили» их вручную, воспроизвести анализ невозможно.

  • Делайте копию в processed.
  • Все изменения — скриптом.
  • Ошибки в raw фиксируйте в журнале и исправляйте отдельным файлом с пометкой.

README: пять абзацев, которые спасают

  1. Что это за проект и кто автор.
  2. Откуда данные и когда собраны.
  3. Как запустить обработку (команда, порядок скриптов).
  4. Что где лежит (краткая карта папок).
  5. Ограничения и известные проблемы.

README обновляется при изменении структуры. Устаревший README хуже отсутствующего.

Версии

  • Текст. История версий в облаке или Git.
  • Код. Git с осмысленными коммитами (Pro Git).
  • Данные. Дата и версия в имени; старые версии — в archive.
  • Библиография. Zotero хранит базу в папке данных; копируйте её целиком (Zotero).

История версий Office работает для файлов в OneDrive или SharePoint (Microsoft Support); для локальных файлов её нет.

Резервные копии

  1. Рабочая копия на ноутбуке.
  2. Копия на внешнем диске.
  3. Копия в облаке или на сервере вуза.
  4. Проверка восстановления раз в месяц.
  5. Журнал копий: когда и что.

Синхронизация Zotero не заменяет резервную копию (Zotero): удаление на одном устройстве отражается на остальных.

Архив и передача

Перед передачей проекта:

  • удалите временные файлы;
  • проверьте, что скрипты запускаются с нуля;
  • приложите README и список зависимостей;
  • укажите, какие данные конфиденциальны;
  • заархивируйте папку с датой;
  • передайте доступ, а не копию на флешке.

Получатель должен суметь воспроизвести ключевую таблицу или график без ваших пояснений.

Типичные ошибки

  1. Данные в папке с текстом. Пересборка ломается.
  2. Файлы с пробелами. Скрипты падают.
  3. Нет README. Проект живёт только в голове автора.
  4. «Финальная» версия в трёх экземплярах. Непонятно, что сдано.
  5. Бэкап на том же диске. При поломке теряется всё.
  6. PDF источников вперемешку с данными. Поиск занимает минуты.

Пример для одного эксперимента

project/
  data/raw/exp01/
    survey_2026-09.csv
    protocol_2026-09.pdf
  data/processed/exp01/
    survey_clean_v01.csv
  code/
    clean_survey_v01.py
    figures_v01.py
  output/exp01/
    table1.csv
    figure1.png

Такой набор можно передать коллеге: он видит, что исходное, что производное и чем это получено.

Журнал изменений

Один файл CHANGELOG.md в корне проекта. Формат простой:

  • дата;
  • что изменено;
  • зачем;
  • какой файл затронут.

Запись в две строки экономит часы объяснений. Особенно если данные правились после замечаний руководителя.

Права доступа и чувствительные данные

  • Персональные данные — только в защищённом хранилище вуза.
  • В общей папке — обезличенные выгрузки.
  • Доступ выдаётся пофамильно, а не «всем сотрудникам».
  • Список тех, у кого есть доступ, хранится отдельно.
  • При передаче проекта доступ отзывается у прежних участников.

Если в данных есть имена, адреса или номера документов, папка не синхронизируется с личным облаком.

Шаблон README

  1. Название и цель проекта.
  2. Автор и контакт.
  3. Источник данных и дата сбора.
  4. Структура папок.
  5. Порядок запуска скриптов.
  6. Требования к окружению.
  7. Ограничения и известные проблемы.
  8. Лицензия или правила использования.

README пишется в начале, а не в конце. Дописывать проще, чем восстанавливать по памяти.

Что делать при смене темы

Тема меняется чаще, чем кажется. Правила:

  • старую папку не удаляйте, а переносите в archive;
  • новый проект начинайте с чистого каталога;
  • общие источники выносите в отдельную библиотеку;
  • README нового проекта ссылается на старый, если данные пересекаются.

Передача данных в журнал

Многие журналы просят данные и код при подаче. Подготовьте заранее:

  • таблицу с описанием переменных;
  • инструкцию по запуску;
  • список пропущенных значений;
  • версию скрипта, которой получены результаты;
  • лицензию на использование данных.

Папка output в таком архиве не нужна: её можно пересобрать.

Мини-проверка структуры за десять минут

  1. Откройте корень проекта.
  2. Убедитесь, что видны data, code, docs.
  3. Проверьте, что в raw нет файлов с датой сегодняшнего дня.
  4. Найдите файлы с пробелами в имени.
  5. Откройте README и пройдите по шагам запуска.
  6. Удалите пустые папки.
  7. Проверьте, что резервная копия свежая.

Как быть с общими файлами в команде

  • У каждого раздела один ответственный.
  • Общие файлы лежат в одном месте, а не в личных папках.
  • Правки в общий файл вносятся по очереди.
  • Крупные изменения обсуждаются до сохранения.
  • Раз в неделю делается снимок общей папки.

Что не хранить в проекте

  • Личные фото и документы.
  • Черновики, не относящиеся к исследованию.
  • Установщики программ.
  • Дубликаты архивов.
  • Файлы с именами вида «копия копии».

Каждый лишний файл усложняет поиск и увеличивает архив.

Как объяснить структуру коллеге

Покажите не схему, а файл: «вот исходные данные, вот скрипт, вот результат». Коллеге достаточно знать три вещи: где брать данные, чем их обрабатывают и куда складывать итог. Всё остальное он найдёт по README.

Чек-лист

  1. Папки raw/processed/output разделены.
  2. Имена файлов по схеме.
  3. README написан.
  4. Версии фиксируются.
  5. Три копии данных.
  6. Архив с датой.
  7. Скрипты запускаются с нуля.
  8. Конфиденциальные данные отмечены.

Частые вопросы

Нужна ли отдельная папка для каждого эксперимента?

Да, если экспериментов несколько: data/raw/exp01, exp02. Так проще сравнивать и архивировать.

Можно ли хранить данные в облаке?

Да, если это разрешено политикой вуза и данные не содержат чувствительной информации. Для персональных данных — только защищённые хранилища.

Сколько версий держать?

Последнюю рабочую, сданную и одну предыдущую. Остальное — в архив.

Что делать со старыми скриптами?

Хранить в archive/code с датой. Они объясняют, как получены старые результаты.

Как передать проект, если он на 200 ГБ?

Внешний диск плюс README. Облако может не подойти по лимитам; проверьте скорость канала.