Skip to content

Стандарт иллюстраций

Все скриншоты документации создаются только на официальных демонстрационных сайтах автора Revolution. Магазины клиентов, рабочие заказы, покупатели, контакты и другие клиентские данные использовать запрещено.

Источник списка: официальная страница Revolution. Публичный вход в демо-админку указан автором: demo / demo.

Разрешённые демо

ДемоАдресДля каких примеров подходит
Универсальныйuniversam.oc-mod.ruадминка, базовая структура Revolution
Климатclimat.oc-mod.ruкатегории, товарные блоки, каталог
Запчасти для мобильныхmobile.oc-mod.ruплотный каталог и характеристики
Универсамmarket.oc-mod.ruпродуктовый каталог и навигация
Кроссовкиshoes.oc-mod.ruопции, изображения, визуальный каталог
Техника Appleapple.oc-mod.ruминималистичная витрина и карточка товара
Запчасти для автоzap.oc-mod.ruсложная каталогизация
Автотоварыauto.oc-mod.ruфильтры и товарные представления
Одеждаmoda.oc-mod.ruопции, размеры и изображения
Пиццаpizza.oc-mod.ruкорзина и быстрый заказ
Косметикаpersona.oc-mod.ruисторическая версия 3.1.2; только для явно помеченных примеров

Обязательные требования к снимку

  1. Viewport — не меньше 1920×1080.
  2. Снимается официальный демо-сайт или его демо-админка.
  3. Вместо рамок используются контрастные красные стрелки с номерами шагов.
  4. Стрелки показывают полный маршрут пользователя по экрану в порядке 1 → 2 → 3 (при необходимости шагов может быть больше).
  5. Первая стрелка указывает вход в нужный раздел настроек, следующая — нужную вкладку или подраздел, последняя — поле, кнопку либо переключатель, с которым нужно работать.
  6. Под изображением показывается только источник. Разрешение, дата, версия и координаты хранятся в служебном манифесте.
  7. В кадре должно быть достаточно окружения, чтобы пользователь видел все шаги и понимал расположение элементов.
  8. Изображение открывается по клику в lightbox с оригинальным разрешением.
  9. Технические выводы подтверждаются исходниками нужной версии, а не только внешним видом демо.

DOC рассчитан на пользователя без знания интерфейса

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

Версионность

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

Хранение и именование

Файлы размещаются по схеме:

text
/images/official-demo/{section}/{component}-{viewport}.png

Для каждого изображения фиксируются:

  • URL официального демо;
  • дата съёмки;
  • viewport;
  • видимая версия Revolution;
  • координаты, номера, направления и подписи всех стрелок;
  • страница документации, которая использует изображение.

Запрещено

  • брать изображения с клиентских или рабочих сайтов;
  • публиковать заказы, покупателей, адреса, телефоны и другие персональные данные;
  • растягивать снимок низкого разрешения до десктопного размера;
  • выделять большие области рамками вместо пошаговых стрелок;
  • показывать только конечное поле без пути к нему по интерфейсу;
  • вставлять скриншот без нумерации порядка действий;
  • выдавать интерфейс старой демо-версии за доказательство поведения Revolution 5.x.

Все права на шаблон принадлежат его автору