Руководство по человеческому интерфейсу

Руководство по человеческому интерфейсу GNOME - основной источник документации по UX-дизайну для GNOME. Размещены по адресу developer.gnome.org/hig.

Эта версия заменяет предыдущую версию, которая была размещена как часть модуля gnome-devel-docs.

HIG написан на reStructuredText, сгенерирован с помощью Sphinx и размещен на GitLab Pages. Его можно посмотреть онлайн здесь.

Цели для HIG

Цели:

• Основная аудитория - дизайнеры и разработчики приложений.
• Документировать наиболее важные и распространенные паттерны проектирования.
• Быть легким для усвоения: не быть слишком длинным или многословным.
• Используйте примеры и демонстрации как можно чаще.

Не является целью:

• Не является общим руководством по UX-дизайну и не должно пытаться восполнить базовые знания о дизайне, но должно быть доступно для тех, кто имеет относительно небольшой опыт в дизайне.
• Не документируйте каждый паттерн дизайна или его возможную вариацию.
• Не будьте директивными: позвольте дизайнерам делать свой собственный выбор и дайте им пространство для творчества.

Как создавать и редактировать

Sphinx можно использовать для создания и предварительного просмотра статического HTML-сайта локально, либо в браузере, либо в редакторе, таком как VS Code.

1. Установите зависимости

Linux (например, Fedora):

dnf install -y python3-sphinx python3-pip
pip3 install --upgrade furo

Windows:

1. Убедитесь, что Python установлен и добавлен в PATH. Скачайте его с python.org.
2. Установите зависимости через PowerShell:

   pip install sphinx furo
   

2. Внесите изменения

Используйте редактор, поддерживающий просмотр HTML. VS Code - отличный выбор благодаря своим расширениям для работы с Sphinx.

3. Сборка

Сборка документации проверяет наличие ошибок и создаёт локальный статический HTML-сайт.

Linux:

Для сборки запустите:

./00localbuild.sh

Windows:

Для сборки запустите:

./00localbuild.bin

Результаты сборки можно найти в папке build.

4. Развертывание изменений

Изменения в ветке main автоматически разворачиваются на сайте с помощью CI. Для ручной сборки и публикации убедитесь, что все файлы находятся в папке build или соответствующей папке для публикации.