Документирование новых функций и изменений¶

С каждым выпуском Blender’а появляются новые захватывающие функции, улучшения и изменения. Чтобы пользователи Blender’а могли извлечь максимальную пользу из этих обновлений, необходимо обновлять документацию параллельно с этими релизами.

Проект по документации Blender’а отслеживает изменения, требующие обновлений или дополнений к руководству. Внося свой вклад, вы помогаете поддерживать точность и ценность руководства для мирового сообщества Blender’а.

Это руководство проведёт вас через процесс документирования этих изменений с использованием отчётов по выпускам и журналов подтверждения.

Использование отчётов по выпускам для отслеживания изменений¶

Каждый выпуск Blender’а имеет взаимодействующий отчёт по проекту документации „предстоящих выпусков“. Эти отчёты содержат организованный список коммитов кода из процесса разработки Blender’а, которые вносят изменения, с которыми сталкивается пользователь. Эти изменения, как правило, требуют обновления руководства пользователя, например, новых разделов, изменённых инструкций или обновлённых иллюстраций.

Шаги по внесению своего вклада

Найдите отчёт по выпуску:
- Перейдите в систему отслеживания отчётов проекта документации и откройте отчёт для текущего или предстоящего выпуска Blender’а.
- Просмотрите список коммитов, предоставленный в описании отчёта. Каждый коммит представляет собой изменение или функцию, требующую документирования.
Выберите отчёт:
- Выберите коммит, который вас интересует или соответствует вашему опыту. Например, если вы знакомы с инструментами моделирования, выберите изменение, связанное с этими функциями.
- Убедитесь, что никто другой не работает над той же задачей, проверив комментарии или обновления статуса в отчёте.
Поймите суть изменения:
- Прочтите сообщение коммита:
  
  Сообщения коммитов часто суммируют цель и область действия самого изменения. Они могут ссылаться на пул-реквест (PR) или содержать ссылки на обсуждения.
- Проверьте PR или код:
  
  Связанный пул-реквест предоставляет дополнительный контекст, включая описания, изображения или видео, объясняющие функцию. Просмотр изменений кода также может помочь вам понять, как работает интересующая вас функция.
- Протестируйте функцию:
  
  Откройте Blender и протестируйте функцию, чтобы увидеть её в действии. Этот практический опыт прояснит, как ведёт себя функция и как будут взаимодействовать с ней пользователи.
Обращайтесь, если необходимо:
- Если сообщение коммита или PR не содержит достаточно информации, вы можете:
  - Обратиться к разработчику изменения (его „имя пользователя“ обычно указано в PR).
  - Задавать вопросы на каналах разработки Blender’а или на форумах.

Ключевые соображения по документации¶

При документировании изменений помните следующее:

Какова цель изменения?:

Поймите, почему было сделано это изменение. Улучшает ли оно удобство использования, вводит ли новую возможность или устраняет проблему?
Кому это принесёт пользу?:

Подумайте о целевой аудитории рассматриваемой функции. Предназначена ли она для аниматоров, моделлеров или другой группы пользователей?
Как это работает?:

Пишите чёткие, краткие инструкции. По возможности включите практические примеры или варианты использования.
Проверьте возможные зависимости:

Некоторые изменения могут зависеть от других функций или влиять на существующую функциональность. Проверьте, влияет ли изменение на другие части руководства.
Скриншоты и иллюстрации:

Если изменение затрагивает интерфейс Blender’а, – сделайте скриншоты, чтобы проиллюстрировать его. Убедитесь, что иллюстрации отражают соответствующую версию Blender’а.

Отправка вашей работы¶

После составления документации:

Соблюдайте стиль руководства пользователя:

Придерживайтесь руководству по стилю документации Blender’а, чтобы обеспечить ясность и последовательность.
Отправьте свой «вклад»:
- Откройте пул-реквест в проекте документации.
- Укажите отчёт релиза и коммит в описании вашего PR.
- Приложите все созданные вами снимки экрана, диаграммы или примеры.
Сотрудничайте:

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

Каждый вклад имеет значение¶

Участие в документации Blender’а – это полезный способ поддержки сообщества и обеспечивание понимания пользователями новейших функций. Документируя эти изменения, вы играете ключевую роль в том, чтобы сделать Blender более доступным и приятным для всех.

Начните изучать отчёты предстоящего релиза уже сегодня и помогите воплотить инновации Blender’а в жизнь!