Changelog Dialog
С помощью чейнджлога команда сервиса может рассказать пользователям о произошедших изменениях.
Чейнджлог отображается однократно при открытии сервиса. Возможность повторно открывать чейнджлог не предусмотрена; при необходимости ее можно реализовать самостоятельно.
Поскольку чейнджлог выводится в модальном окне, для него действуют правила закрытия и масштабирования, применимые к модальному окну.
Элементы
Чейнджлог представляет собой модальное окно размера М с расположенными в хронологическом порядке постами. У каждого поста есть:
- дата публикации;
- лейбл
New(опционально); - заголовок;
- изображение (опционально);
- текст;
- кнопка действия (опционально).
Дата публикации
По дате публикации пользователь сможет понять, когда было то или иное изменение в сервисе. По умолчанию дата указывается в формате DD Mon YYYY, но можно использовать и другие форматы даты с учетом локали сервиса.
Лейбл
Лейбл New используется для маркировки новых постов. То, какие посты считать новыми и маркировать этим лейблом, определяется сервисом. Возможно использование других формулировок в тексте, отличных от New.
Заголовок
Заголовок поста используется для краткого описания изменения в сервисе. Заголовок может быть любой длины. Не рекомендуется:
- использовать заголовки, занимающие более одной строки (содержащие более 70 символов), так как это ухудшает читаемость текста;
- дублировать в заголовке текст новости.
Для заголовка используется стиль text-subheader-3. Использование других текстовых стилей не предусмотрено.
Изображение
Изображение опционально и имеет фиксированные размеры 516х240 рх. В качестве изображение можно использовать файлы c расширением JPG и PNG; GIF-изображения и видеофайлы не поддерживаются. Изображение применяется, когда необходимо проиллюстрировать тему поста. Для светлой и темной темы интерфейса используется одно изображение.
Если загрузить изображение, превышающее 516х240 рх, оно будет отмасштабировано и выровнено по центру большей стороны.
С учётом retina-дисплеев рекомендуется загружать изображения, увеличенные в 2 раза по каждой стороне, то есть 1032х480 рх.
Текст
После изображения располагается текст поста, который может быть произвольной длины. Не рекомендуется:
- Использовать очень длинные тексты (более 500 символов). Если нет возможности сократить текст до рекомендуемой длины, то можно добавить в текст ссылки на документацию или сделать переход к полному тексту поста по клику на кнопку после текста.
- Создавать подзаголовки. Так как рекомендуемая длина текста не подразумевает то, что он будет слишком длинным, дополнительное разбиение на блоки с помощью подзаголовков не требуется.
Для текста используется стиль text-body-1. Использование других текстовых стилей не предусмотрено, но возможно форматирование: создание маркированных и нумерованных списков, зачёркивание и подчёркивание текста, а также выделение жирным и курсивом.
Кнопка действия
Кнопка действия опциональна и располагается под текстом поста. Применяется для перехода к полному тексту поста.
Возможно использование только кнопок размера M. Кнопка может быть любого типа, с иконкой и без иконки. Рекомендуется использовать один тип кнопок.
Не предусмотрено наличие нескольких кнопок.
Прочие элементы
Под заголовком модального окна также может быть ссылка View full changelog, ведущая на страницу чейнжлога; это может быть отдельная страница сервиса, сторибук, сторонний сервис с документацией и т.д.
Рекомендации по использованию
Чейнджлог применяется:
- Когда необходимо проинформировать пользователя о произошедших в сервисе значительных изменениях.
- Когда необходимо держать пользователя в курсе о незначительных изменениях. В этом случае стоит показывать чейнджлог с некоторой периодичностью и сообщать о всех небольших изменениях с момента предыдущей записи.
- Когда хочется напомнить пользователю про изменения в сервисе и повысить его осведомленность о предыдущих релизах.
Не рекомендуется:
- Использовать чейнджлог для онбординга.
- Использовать чейнджлог для информирования пользователя о каждом небольшом изменении в сервисе.