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

1. Откройте приложение
2. Выберите категорию оборудования либо воспользуйтесь поиском по каталогу вместо пунктов 2–4
3. Выберите бренд
4. Выберите модель
5. Выберите инструкцию
6. Пройдите шаги инструкции

Эксплуатация веб-виджета

1. Откройте веб-страницу с виджетом
2. Найдите кнопку вызова виджета и нажмите её
3. Выберите инструкцию
4. Пройдите шаги инструкции

Эксплуатация редактора инструкций

Глоссарий

• Категория — тип техники по основной функции. Примеры: микроволновые печи, стиральные машины
• Бренд — торговая марка, под которой продаётся техника. Примеры: Candy, DeLongi, Bosch
• Модель — модельный номер конкретного образца техники. Примеры: KMR721000M, HHE 6450 WG
• Маркер — фотография панели управления техникой, всего интерфейса или его части с элементами управления, на которую ориентируется FASTEP при расстановке графических подсказок на фото и в дополненной реальности
• Инструкция — пошаговое руководство по отдельной функции техники. Примеры функций: стирка цветного белья, разморозка рыбы. Это важно! Инструкция решает конкретную задачу пользователя, не описывая работу прибора и не давая руководство по эксплуатации целиком. Например, для стиральных машин актуальны инструкции вида «Стирка кроссовок», а не «Режим Хлопок +».
• Шаг инструкции — одно действие пользователя с техникой (нажатие кнопки, поворот регулятора, выключение и т. д.). Шаг состоит из выделения графикой выбранного органа управления и текстового описания действия.
• Текст шага инструкции — текстовое описание выполняемого в шаге действия (нажмите кнопку…, поверните ручку…).
• Элемент интерфейса (сокр. — кнопка) — часть панели управления или часть устройства, такая как крышка отсека, регулятор, ручка, кнопка, переключатель, дисплей или отдельные его элементы, графические символы на панели управления и так далее. Кнопки выделяются на маркере рамкой.
• Рамка — графический прямоугольный элемент, обозначающий границы кнопки на маркере.
• Название кнопки — текстовое описание выделенного элемента управления на маркере.

1. Авторизация

• В браузере перейдите на страницу sdk.fastep.io
• Введите логин (адрес рабочей электронной почты) и пароль (его можно получить у администратора)
• Нажмите «Войти»

Примечания:

• Если у вас ещё нет логина и пароля, запросите их у администратора. Он зарегистрирует вас с определённой ролью, настроит права доступа и отправит вам данные для входа в учётную запись.
• Смена пароля, удаление пользователя, изменение прав также происходит через администратора.

2. Категории

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

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


2.1. Добавление

• На главной странице каталога нажмите «Добавить категорию»
• Введите название категории, выберите положение моделей, загрузите изображение категории
• Нажмите «Добавить»

2.2. Редактирование

• Выберите категорию
• Для скрытия или отображения категории в мобильном приложении нажмите «Выключить / включить категорию»
• Для замены названия или фото категории нажмите «Редактировать категорию»
• Для замены фото наведите курсор на изображение и нажмите на крестик (×), затем добавьте новую фотографию
• После внесения изменений нажмите «Сохранить». Без этого изменения не сохранятся

2.3. Удаление

Внимание! Категорию можно удалить только после удаления всех моделей, входящих в эту категорию (см. далее), в противном случае появится предупреждение и категория не будет удалена

• Для удаления категории наведите курсор на изображение категории и нажмите на крестик (×)
• Подтвердите удаление, нажав «Удалить»

3. Бренды

3.1. Добавление

• Нажмите «FASTEP» в левом верхнем углу для перехода на главную страницу каталога
• Выберите отображение объектов по брендам
• Нажмите «Добавить категорию», из раскрывающегося списка выберите «Добавить бренд»
• Выберите одну или несколько категорий, входящих в бренд
• Введите название
• Загрузите изображение
• Нажмите «Добавить»
• Для просмотра результата нажмите «FASTEP» в левом верхнем углу для перехода на главную страницу каталога, выберите отображение объектов по брендам и найдите нужный бренд

3.2. Редактирование

• Выберите отображение объектов по брендам
• Выберите бренд для редактирования
• Чтобы скрыть или показать бренд в мобильном приложении, нажмите «Выключить / включить бренд»
• Для замены названия или фото бренда нажмите «Редактировать бренд»
• Для замены фото наведите курсор на изображение и нажмите «×» в правом верхнем углу, после чего добавьте новую фотографию
• После внесения изменений нажмите «Сохранить»

3.3. Удаление

Внимание! Бренд можно удалить только после удаления всех моделей, входящих в него (см. далее), в противном случае появится предупреждение и бренд не будет удалён.

• Для удаления бренда наведите курсор на изображение бренда и нажмите на крестик (×)
• Подтвердите удаление, нажав «Удалить»

4. Модели

4.1. Добавление

Для добавления модели необходимо наличие категории и бренда, к которым относится модель

• Нажмите «FASTEP» в левом верхнем углу для перехода на главную страницу каталога
• Нажмите «Добавить категорию»
• В раскрывающемся списке выберите «Добавить модель»
• Выберите категорию и бренд модели из выпадающих списков, введите название модели, загрузите фото. Название модели должно быть уникальным. Нажмите «Добавить».
• Модель создана. Страница обновится, появится кнопка добавления маркера (плюс +). Нажмите на кнопку и загрузите подготовленное по описанным ниже требованиям изображение.
• Откроется страница добавления и разметки маркера.
• Нажмите на плюс, выберите изображение.
• Поверх загруженного изображения появится контрастная рамка. Потяните рамку за любой угол и переместите, чтобы выбрать область обрезки. Также укажите ширину маркера в мм (измерьте на реальном объекте или рассчитайте из габаритов, указанных производителем) и название маркера (оно будет использоваться при создании инструкции - вам должно быть из названия понятно, что это за маркер).
• Нажмите «Создать». Появится окончательный вид маркера, по которому FASTEP ориентирует графические подсказки.
• Нажмите «Добавить кнопку» для разметки первого элемента интерфейса. Предварительно вы можете задать цвет для всех рамок, которыми будут выделены кнопки маркера.
• На изображении маркера появится рамка.
• Измените положение и размеры рамки так, чтобы размечаемый элемент интерфейса (кнопка, ручка, дисплей, переключатель и т. д.) оказался внутри рамки
• Дважды кликните на название кнопки по умолчанию (Новая кнопка №№) и введите новое название, заполнив текстовое поле (30 символов)
• Цвет каждой кнопки можно поменять не смотря на выбранный по умолчанию.
• Разметьте остальные элементы интерфейса и по окончании нажмите на стрелку выхода из инструмента разметки в верхнем левом углу.
• Маркер добавлен, теперь можно добавить инструкции. Если нужен ещё один маркер (например, фото модели сбоку, где есть ещё важные элементы управления), снова нажмите плюс «+» и добавьте ещё маркер.

4.2. Редактирование

• Нажмите «FASTEP» в левом верхнем углу для перехода на главную страницу каталога. Выберите категорию и бренд модели.
• Выберите модель, на её странице нажмите «Редактировать модель»
• Можно внести необходимые изменения в категорию, бренд, название, заменить фото, отредактировать маркеры с размеченными элементами управления (см. 4.2.1)
• Для сохранения изменений нажмите «Сохранить»

4.2.1. Редактирование маркера

• Нажмите на изображение маркера
• Для замены изображения нажмите на кнопку «Заменить маркер» в правом верхнем углу.
• Изображение удалится. Список кнопок останется. Вы можете загрузить новое изображение. Внимание: Если вы удалите кнопки на данном шаге, то удалятся все шаги с этими кнопками во всех существующих инструкциях.
• Вы можете отменить редактирование или приступить к загрузке нового изображения на замену.
• На данном этапе вы можете изменить имя маркера, ширину. Нажмите «Обновить маркер» и «Сохранить изменения».
• Рамки, которыми размечены органы управления, сместятся в левый верхний угол изображения одна поверх другой (последние поверх первых)
• Распределите рамки по элементам интерфейса соответственно названиям, перетаскивая их на нужные места. Положение рамок сохраняется в реальном времени

4.3. Удаление

• Нажмите «FASTEP» в левом верхнем углу для перехода на главную страницу каталога
• Выберите категорию, к которой относится модель
• Выберите бренд, которому принадлежит модель
• Наведите курсор на удаляемую модель
• Нажмите крестик в верхнем правом углу карточки модели
• Подтвердите удаление. Внимание! Вместе с моделью удаляются все её маркеры и инструкции. Действие необратимо

5. Инструкция

5.1. Создание инструкции

Инструкция создаётся для конкретной модели. Этот процесс доступен со страницы модели

• Нажмите «FASTEP» в левом верхнем углу для перехода на главную страницу каталога
• Выберите категорию, к которой относится модель
• Выберите бренд, которому принадлежит модель
• Выберите модель для редактирования
• Откроется страница модели
• Нажмите «Создать инструкцию»
• Введите название инструкции вместо текста «Инструкция №...»
• Нажмите «Добавить шаг»
• Выберите нужный маркер из списка в выпадающем меню
• После выбора маркера выберите кнопку (можно вводить название кнопки, тогда будут появляться подсказки)
• Выбранная кнопка выделится рамкой. Введите текст шага, до 44 символов с пробелами
• Для удаления шага нажмите на крестик (×)
• После добавления всех шагов нажмите «Сохранить»
• Инструкция добавлена (статус «Создано»). Модератор после проверки может изменить её статус на «Опубликовано» для появления инструкции в каталоге приложения

5.2. Редактирование и удаление

• Нажмите на логотип FASTEP в левом верхнем углу для перехода на главную страницу каталога
• Выберите категорию, к которой относится модель
• Выберите бренд, которому принадлежит модель
• Выберите модель для редактирования
• Откроется страница модели
• Для удаления инструкции нажмите крестик (×) в строке с её названием и подтвердите удаление
• Для редактирования выберите нужную инструкцию и воспользуйтесь информацией из пункта 5.1