Функциональные характеристики ПО и эксплуатация ПО
Введение
Данное руководство описывает функциональные характеристики, возможности и принципы работы программного обеспечения «PASS», разработанного ООО «ПАРИТЕТ».
1.Функциональные характеристики ПО
1.1 Возможности программного обеспечения
PASS – платформа лояльности для геймификации пользователей, которая предоставляет широкий круг возможностей для осуществления увеличения активности пользователей цифровых продуктов и позволяет выполнять:
1.2 Вход в программное обеспечение
Для начала работы с программным обеспечением требуется пройти аутентификацию, после которой предоставляется доступ к функционалу приложения.
Способы аутентификации:
1.3 Каталог заданий
После успешного входа в приложение пользователь попадает автоматически на главную страницу c Заданиями, где отображается каталог с доступными заданиями представленных в виде категорий.
Категория задания — это группировка заданий по некоторому признаку, например, по типу заданий или игре. Например, это могут быть задания Dota 2 или Counter-Strike 2. Кроме того, по запросу Заказчика могут быть добавлены новые категории заданий, которые бы означали совершения целевого действия в продукте Заказчика.
Например, оформление платной подписки или оформление заказа в интернет магазине Заказчика. За выполнение подобных заданий конечный пользователь ПО получает баллы. Которые в дальнейшем он может обменять на товары в магазине ПО.
1.4 Каталог товаров
Для перехода между разделами ПО требуется выбрать соответствующий раздел в левом боковом меню. Одним из таких разделов является «Магазин». В котором размещается каталог цифровых товаров в соответствующих категориях. По умолчанию доступны следующие категории:
Некоторые особенности скинов:
Для каждого товара в Магазине указывается администратором ПО следующие поля в Бэкофисе:
Валюта используется виртуальная, например это могут быть коины. Виртуальная валюта подразумевает, что пользователь может копить, выполняя различные задания. А затем потратить в магазине.
Название внутренней валюты может быть изменено по запросу со стороны Заказчика.
1.5 Рейтинг пользователей
В данном разделе показывается список пользователей с наибольшем количеством балансов на счетах своих аккаунтов. В самом верху списка выводится пользователи с максимальными суммами. Список отсортирован по убыванию сумм на балансах аккаунтов пользователей.
Если на момент посещения раздела в Базе Данных зарегистрировано менее 200 клиентов, выводится список всех клиентов, зарегистрированных в ПО.
По каждому пользователю из данного списка выводится следующая информация:
1.6 Раздел «Новости»
В данном разделе собраны все новости, которые были опубликованы с важной для пользователей информацией. Здесь могут важные анонсы о добавление новых заданий, новых товаров в магазине или любая другая важная информация.
Каждая новость сопровождается следующей информацией:
Каждый баннер содержит следующую информацию:
1.7 Раздел «Pick’em»
Сделай предсказание на турнир и получи призы.
Пользователям предлагается принять участие в угадывание каких-либо событий. Например, указать в какие дни месяца будет дождливая погода в городе Москва или какая команда выиграет в следующем матче с футбольным клубом Спартак.
Пользователь должен открыть задание и сделать выбор на своё усмотрение. Когда сбор прогнозов будет завершен — администратор подводит итоги розыгрыша и пользователи, которые смогли ответить правильно могут забрать свои награды за правильные предсказания.
В данном разделе также размещается слайдер с изображениями для привлечения внимания пользователей к важным обновлениям, например публикации новых заданий или пополнению новых товаров в магазине.
Каждый баннер содержит следующую информацию:
1.8 Раздел «FAQ»
В данном разделе собраны и опубликованы вопросы и ответы на них, чтобы пользователям было понятные условия проведения акций, способов регистрации на проекте и так далее.
Все вопросы и ответы могут быть сгруппированы по соответствующим темам для более удобного поиска пользователем интересующего вопроса/ответа.
При нажатии на нужный вопрос — раскрывается текст с ответом на него.
Каждый вопрос содержит следующие атрибуты:
1.9 Профиль пользователя
Любой авторизованный пользователь можете перейти в разделе «Мой профиль», в котором собрана информация о профиле пользователя и другая информация, которая отражает активность пользователь на проекте.
Основная информация о пользователе выводится сразу при открытии данного раздела:
1.9.1 Статистика
В данном подразделе выводится информация об активности пользователя:
1.9.2 Стоимость рюкзака
В данном информационном окне содержится информация с итоговой стоимостью всех купленных товаров пользователем. А также показывается краткая информация о пяти последних товарах, которые купил пользователь.
1.9.3 Ачивки
В данном информационном окне содержится информация с ачивками, которые заработал пользователь в ходе своей игровой активности на проекте.
А также возможность ознакомится со всеми доступными для получения ачивками, чтобы пользователь мог узнать условия получения любой выбранной им ачивки.
Ачивка — это виртуальная награда, которую человек получает за выполнение какого-то условия или достижения результата. Полученная награда появляется в Профиле пользователя, где будет указано за что она была выдана пользователю.
Каждая ачивка содержит следующую информацию:
1.9.4 Рюкзак
В данном разделе выводится список всех товаров, которые покупал пользователь. При этом выводятся даже товары, которые имеют статус отменных заказов. Каждый товар заказанных в Магазине выводится со следующей информацией:
1.9.5 Настройка профиля
В данном разделе пользователь может внести изменения в информацию о своем профиле. Информация, которую может отредактировать на своё усмотрение делится на несколько категорий.
1. Аватар
По умолчанию при регистрации в ПО у каждого пользователя в профиле автоматически прогружается стандартная аватарка (изображение профиля). При желании пользователь может загрузить свою собственную версию аватара, которые будут отвечать требованиям.
Требования к изображению пользователя для загрузки в Профиле:
Ник или никнейм это короткое название профиля игрока, которое будет выводится в рейтинге.
По умолчанию каждый пользователь получает при регистрации ник в формате memberXXX, где ХХХ — это порядковый номер пользователя при регистрации. Пользователь в любой момент может его изменить в режиме редактирования. После внесенных изменений пользователю требуется нажать кнопку «Сохранить» для того, чтобы в Базе Данных сохранился новый ник.
3. Tradelink
Для того, чтобы иметь возможность получить скины Dota 2 или Counter Strike2, пользователь должен указать свой Tradelink.
Tradelink (или ссылка для обмена) в Steam — это специальная ссылка, которую можно сгенерировать в настройках инвентаря.
Она позволяет другим людям отправлять тебе предложения обмена без добавления тебя в друзья. Удобно, если ты, например, продаёшь/обмениваешь скины в Counter Strike S2 или Dota 2.
Tradelink можно найти в Steam → Инвентарь → Предложения обмена → Кто может отправлять мне предложения → там будет кнопка «Сгенерировать ссылку».
Эту ссылку можно отправить человеку или вставить на сайт/в профиль.
Формат Tradelinek:
https://steamcommunity.com/tradeoffer/new/?partner=XXXXXXXXXXX&token=ABCDE, где XXXXXXXXXXX — идентификатор площадки Steam, ABCDE — токен сгенерированный на стороне площадки Steam.
1.9.6 Настройка заданий
В данном разделе пользователь может увидеть статус подключения своего профиля со своим аккаунтом в Steam*. Для того чтобы привязать или отвязать свой профиль Steam, ему требуется нажать кнопку «Привязать», а чтобы отвязать свой аккаунт — соответственно нажать на кнопку «Отвязать».
*Steam — онлайн-сервис цифрового распространения компьютерных игр и программ, разработанный и поддерживаемый компанией Valve.
Дополнительная информация разбита по следующим блокам:
1. Данные Steam — статус привязки аккаунтв в Steam;
2. Код последней соревновательной игры CS2 — требуется для получения данных об игровом процессе пользователя в игре Couner – Strike 2.
3. Код аутентификации CS2 — требуется для получения данных об игровом процессе пользователя в игре Couner – Strike 2.
Данная информация (привязка к Steam и коды) необходимо для того, чтобы пользователь мог выполнять задания в соответствующих компьютерных играх за что будет получать вознаграждения в ПО.
2.Функциональные характеристики Бэкофиса
2.1 Возможности Бэкофиса
Бэкофис позволяет администратору осуществлять следующие функции:
2.2 Вход в Бэкофис
Перед тем, как начать пользоваться системой Бэкофиса необходимо аутентифицироваться. При переходе по адресу если пользователь не был ранее аутентифицирован, отобразится форма, где предлагается ввести логин и пароль.
Примечание: Для целей демонстрации в приложении имеется встроенная учетная запись демо- пользователя.
2.3 Поиск клиентов и редактирование данных клиента
Для того, чтобы можно было легко найти карточку клиента (она же форма Информация о клиенте) система имеет поиск доступный через меню Пользователи/Поиск клиентов. В форме поиска надо ввести имя клиента и нажать кнопку «Поиск» - отобразится список возможных кандидатов, соответствующих введенному запросу.
Чтобы открыть карточку клиента надо щелкнуть по имени клиента в поле «Имя пользователя». Далее можно внести изменения в данные существующего клиента.
3. Режим функционирования программного обеспечения
В основном режиме функционирования программное обеспечение обеспечивает:
Термины
Геймификация — это применение игровых механик и принципов в неигровых контекстах для повышения вовлечённости, мотивации и продуктивности. Проще говоря, это превращение рутинных процессов в увлекательную игру.
Counter Strike 2 — компьютерная игра в жанре многопользовательского тактического шутера от первого лица, разработанная компанией Valve.
Dota 2 — многопользовательская командная компьютерная игра в жанре MOBA, разработанная и изданная корпорацией Valve.
ПО — программное обеспечение.
СУБД — система управления базами данных.
Бэкофис — это внутренняя часть ПО, которая не взаимодействует напрямую с клиентами, но обеспечивает работу содержимого ПО, которое будет доступно для конечного клиента и визуально доступно для последующего взаимодействия с ним (контент, текстовая информация, товары и так далее).
Данное руководство описывает функциональные характеристики, возможности и принципы работы программного обеспечения «PASS», разработанного ООО «ПАРИТЕТ».
1.Функциональные характеристики ПО
1.1 Возможности программного обеспечения
PASS – платформа лояльности для геймификации пользователей, которая предоставляет широкий круг возможностей для осуществления увеличения активности пользователей цифровых продуктов и позволяет выполнять:
- Размещать информацию с карточками заданий в компьютерных играх Counter Strike 2* и Dota 2**;
- Управлять базой клиентов (блокировать, выдавать вознаграждения в виде бонусных баллов);
- Публиковать задания, где требуется ответить на вопросы (викторины) с возможностью получить вознаграждения в виде бонусных баллов;
- Публиковать в специальном разделе товары, которые пользователи могут обменять на полученные баллы (офлайн товары, билеты на мероприятия или скидки в магазине Заказчика);
- Публиковать и редактировать правила проведения акций;
- Публиковать и редактировать раздел с вопросами и ответами (FAQ).
1.2 Вход в программное обеспечение
Для начала работы с программным обеспечением требуется пройти аутентификацию, после которой предоставляется доступ к функционалу приложения.
Способы аутентификации:
- На основе имени пользователя и пароля. Например, для проведения демонстраций ПО. В этом случае, для аутентификации применяется логин и пароль демо-пользователя.
1.3 Каталог заданий
После успешного входа в приложение пользователь попадает автоматически на главную страницу c Заданиями, где отображается каталог с доступными заданиями представленных в виде категорий.
Категория задания — это группировка заданий по некоторому признаку, например, по типу заданий или игре. Например, это могут быть задания Dota 2 или Counter-Strike 2. Кроме того, по запросу Заказчика могут быть добавлены новые категории заданий, которые бы означали совершения целевого действия в продукте Заказчика.
Например, оформление платной подписки или оформление заказа в интернет магазине Заказчика. За выполнение подобных заданий конечный пользователь ПО получает баллы. Которые в дальнейшем он может обменять на товары в магазине ПО.
1.4 Каталог товаров
Для перехода между разделами ПО требуется выбрать соответствующий раздел в левом боковом меню. Одним из таких разделов является «Магазин». В котором размещается каталог цифровых товаров в соответствующих категориях. По умолчанию доступны следующие категории:
- Скины Dota 2*;
- Скины Couner-Strike 2*;
- Офлайн товары;
- Дополнительная категория под запрос Заказчика.
Некоторые особенности скинов:
- Могут включать разные модели героев;
- Могут включать анимации, эффекты способностей, реплики;
- Могут быть специальными стилями для оружия и снаряжения.
Для каждого товара в Магазине указывается администратором ПО следующие поля в Бэкофисе:
- Название;
- Стоимость;
- Описание;
- Категория.
Валюта используется виртуальная, например это могут быть коины. Виртуальная валюта подразумевает, что пользователь может копить, выполняя различные задания. А затем потратить в магазине.
Название внутренней валюты может быть изменено по запросу со стороны Заказчика.
1.5 Рейтинг пользователей
В данном разделе показывается список пользователей с наибольшем количеством балансов на счетах своих аккаунтов. В самом верху списка выводится пользователи с максимальными суммами. Список отсортирован по убыванию сумм на балансах аккаунтов пользователей.
Если на момент посещения раздела в Базе Данных зарегистрировано менее 200 клиентов, выводится список всех клиентов, зарегистрированных в ПО.
По каждому пользователю из данного списка выводится следующая информация:
- Позиция в рейтинге;
- Аватарка (изображение из ЛК пользователя);
- Никнейм пользователя;
- Ачивки (последние 5 полученных пользователем);
- Количество коинов.
1.6 Раздел «Новости»
В данном разделе собраны все новости, которые были опубликованы с важной для пользователей информацией. Здесь могут важные анонсы о добавление новых заданий, новых товаров в магазине или любая другая важная информация.
Каждая новость сопровождается следующей информацией:
- Изображение;
- Заголовок;
- Текст новости;
- Дата и время публикации.
Каждый баннер содержит следующую информацию:
- Заголовок;
- Текстовое описание;
- Изображение.
1.7 Раздел «Pick’em»
Сделай предсказание на турнир и получи призы.
Пользователям предлагается принять участие в угадывание каких-либо событий. Например, указать в какие дни месяца будет дождливая погода в городе Москва или какая команда выиграет в следующем матче с футбольным клубом Спартак.
Пользователь должен открыть задание и сделать выбор на своё усмотрение. Когда сбор прогнозов будет завершен — администратор подводит итоги розыгрыша и пользователи, которые смогли ответить правильно могут забрать свои награды за правильные предсказания.
В данном разделе также размещается слайдер с изображениями для привлечения внимания пользователей к важным обновлениям, например публикации новых заданий или пополнению новых товаров в магазине.
Каждый баннер содержит следующую информацию:
- Заголовок;
- Текстовое описание;
- Изображение.
1.8 Раздел «FAQ»
В данном разделе собраны и опубликованы вопросы и ответы на них, чтобы пользователям было понятные условия проведения акций, способов регистрации на проекте и так далее.
Все вопросы и ответы могут быть сгруппированы по соответствующим темам для более удобного поиска пользователем интересующего вопроса/ответа.
При нажатии на нужный вопрос — раскрывается текст с ответом на него.
Каждый вопрос содержит следующие атрибуты:
- Категория;
- Вопрос;
- Ответ.
1.9 Профиль пользователя
Любой авторизованный пользователь можете перейти в разделе «Мой профиль», в котором собрана информация о профиле пользователя и другая информация, которая отражает активность пользователь на проекте.
Основная информация о пользователе выводится сразу при открытии данного раздела:
- Баланс;
- Изображение пользователя.
- Статистика;
- Настройка профиля;
- Настройка заданий;
- Ачивки;
- Рюкзак.
1.9.1 Статистика
В данном подразделе выводится информация об активности пользователя:
- Количество выполненных заданий (итого);
- Количество выполненных заданий по категориям;
- Количество активированных кодов;
- Рейтинг пользователя.
1.9.2 Стоимость рюкзака
В данном информационном окне содержится информация с итоговой стоимостью всех купленных товаров пользователем. А также показывается краткая информация о пяти последних товарах, которые купил пользователь.
1.9.3 Ачивки
В данном информационном окне содержится информация с ачивками, которые заработал пользователь в ходе своей игровой активности на проекте.
А также возможность ознакомится со всеми доступными для получения ачивками, чтобы пользователь мог узнать условия получения любой выбранной им ачивки.
Ачивка — это виртуальная награда, которую человек получает за выполнение какого-то условия или достижения результата. Полученная награда появляется в Профиле пользователя, где будет указано за что она была выдана пользователю.
Каждая ачивка содержит следующую информацию:
- Изображение;
- Название;
- Описание;
- Условие для получения;
- Статус: Получена / Не получена;
- Количество пользователей получивших ачивку.
1.9.4 Рюкзак
В данном разделе выводится список всех товаров, которые покупал пользователь. При этом выводятся даже товары, которые имеют статус отменных заказов. Каждый товар заказанных в Магазине выводится со следующей информацией:
- ID заказа;
- Статус покупки;
- Наименование товара;
- Изображение;
- Стоимость;
- Описание.
1.9.5 Настройка профиля
В данном разделе пользователь может внести изменения в информацию о своем профиле. Информация, которую может отредактировать на своё усмотрение делится на несколько категорий.
1. Аватар
По умолчанию при регистрации в ПО у каждого пользователя в профиле автоматически прогружается стандартная аватарка (изображение профиля). При желании пользователь может загрузить свою собственную версию аватара, которые будут отвечать требованиям.
Требования к изображению пользователя для загрузки в Профиле:
- Изображение должно быть в формате JPEG/PNG;
- Размер не больше 1 Мб;
- Ширина/высота в пределах 240px — 1024px.
Ник или никнейм это короткое название профиля игрока, которое будет выводится в рейтинге.
По умолчанию каждый пользователь получает при регистрации ник в формате memberXXX, где ХХХ — это порядковый номер пользователя при регистрации. Пользователь в любой момент может его изменить в режиме редактирования. После внесенных изменений пользователю требуется нажать кнопку «Сохранить» для того, чтобы в Базе Данных сохранился новый ник.
3. Tradelink
Для того, чтобы иметь возможность получить скины Dota 2 или Counter Strike2, пользователь должен указать свой Tradelink.
Tradelink (или ссылка для обмена) в Steam — это специальная ссылка, которую можно сгенерировать в настройках инвентаря.
Она позволяет другим людям отправлять тебе предложения обмена без добавления тебя в друзья. Удобно, если ты, например, продаёшь/обмениваешь скины в Counter Strike S2 или Dota 2.
Tradelink можно найти в Steam → Инвентарь → Предложения обмена → Кто может отправлять мне предложения → там будет кнопка «Сгенерировать ссылку».
Эту ссылку можно отправить человеку или вставить на сайт/в профиль.
Формат Tradelinek:
https://steamcommunity.com/tradeoffer/new/?partner=XXXXXXXXXXX&token=ABCDE, где XXXXXXXXXXX — идентификатор площадки Steam, ABCDE — токен сгенерированный на стороне площадки Steam.
1.9.6 Настройка заданий
В данном разделе пользователь может увидеть статус подключения своего профиля со своим аккаунтом в Steam*. Для того чтобы привязать или отвязать свой профиль Steam, ему требуется нажать кнопку «Привязать», а чтобы отвязать свой аккаунт — соответственно нажать на кнопку «Отвязать».
*Steam — онлайн-сервис цифрового распространения компьютерных игр и программ, разработанный и поддерживаемый компанией Valve.
Дополнительная информация разбита по следующим блокам:
1. Данные Steam — статус привязки аккаунтв в Steam;
2. Код последней соревновательной игры CS2 — требуется для получения данных об игровом процессе пользователя в игре Couner – Strike 2.
3. Код аутентификации CS2 — требуется для получения данных об игровом процессе пользователя в игре Couner – Strike 2.
Данная информация (привязка к Steam и коды) необходимо для того, чтобы пользователь мог выполнять задания в соответствующих компьютерных играх за что будет получать вознаграждения в ПО.
2.Функциональные характеристики Бэкофиса
2.1 Возможности Бэкофиса
Бэкофис позволяет администратору осуществлять следующие функции:
- Управление пользователями;
- Управлять администраторами Бэкофиса;
- Управлять новостями;
- Управлять разделом FAQ;
- Управлять каталогом товаров в магазине;
- Управлять заданиями;
- Управлять разделом Pick’em;
- Управлять баннерами.
2.2 Вход в Бэкофис
Перед тем, как начать пользоваться системой Бэкофиса необходимо аутентифицироваться. При переходе по адресу если пользователь не был ранее аутентифицирован, отобразится форма, где предлагается ввести логин и пароль.
Примечание: Для целей демонстрации в приложении имеется встроенная учетная запись демо- пользователя.
2.3 Поиск клиентов и редактирование данных клиента
Для того, чтобы можно было легко найти карточку клиента (она же форма Информация о клиенте) система имеет поиск доступный через меню Пользователи/Поиск клиентов. В форме поиска надо ввести имя клиента и нажать кнопку «Поиск» - отобразится список возможных кандидатов, соответствующих введенному запросу.
Чтобы открыть карточку клиента надо щелкнуть по имени клиента в поле «Имя пользователя». Далее можно внести изменения в данные существующего клиента.
3. Режим функционирования программного обеспечения
В основном режиме функционирования программное обеспечение обеспечивает:
- беспрерывную работу в режиме – 24 часа в день, 7 дней в неделю (24/7);
- выполнение всех функций в полном объеме; за исключением периодов проведения профилактических и других работ, а также устранения возникших нештатных ситуаций.
Термины
Геймификация — это применение игровых механик и принципов в неигровых контекстах для повышения вовлечённости, мотивации и продуктивности. Проще говоря, это превращение рутинных процессов в увлекательную игру.
Counter Strike 2 — компьютерная игра в жанре многопользовательского тактического шутера от первого лица, разработанная компанией Valve.
Dota 2 — многопользовательская командная компьютерная игра в жанре MOBA, разработанная и изданная корпорацией Valve.
ПО — программное обеспечение.
СУБД — система управления базами данных.
Бэкофис — это внутренняя часть ПО, которая не взаимодействует напрямую с клиентами, но обеспечивает работу содержимого ПО, которое будет доступно для конечного клиента и визуально доступно для последующего взаимодействия с ним (контент, текстовая информация, товары и так далее).