Skip to content

Latest commit

 

History

History
148 lines (101 loc) · 11.5 KB

README.md

File metadata and controls

148 lines (101 loc) · 11.5 KB

Tele2Teen

2023

Документация к API

Содержание

  1. Введение
    1. Название
    2. Назначение
    3. Определения, акронимы и сокращения
    4. Краткий обзор
  2. Общее описание
    1. Взаимодействие продукта с системой
    2. Функции продукта
    3. Характеристики пользователя
    4. Ограничения
  3. Детальные требования
    1. Требования к внешним интерфейсам
      1. Основной интерфейс приложения
      2. Интерфейсы диалоговых окон
    2. Функциональные требования
      1. Особенности хранения данных
      2. Описание основных алгоритмов
      3. Описание функций отдельных элементов
    3. Требования к производительности
  4. Дополнения

Введение

1. Название

Tele2Teen - [ˈtelɪ tu tiːn] - ТелеТуТин

2. Назначение

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

3. Определения, акронимы и сокращения

Подростки, теле два, викторины теле два

4. Краткий обзор

Приложение с интересными и познавательными викторинами предназначенное для подростков 11-16 лет.
Позволяет проходить опросы, получать баллы за правильные ответы, а также обменивать баллы на услуги от Теле2.
Вы можете: Зарегистрироваться в системе, играть в одиночку или вместе с другими игроками, обменивать баллы на услуги от Теле2.

Общее описание

1. Взаимодействие продукта с системой

Для запуска приложения требуется устройство с ОС Android 8.0 или выше.
Приложение обменивается файлами с сервером благодаря чему осуществляется работа приложения.
Приложение способно к считыванию сигналов с сенсорного экрана, а также способно выводить информацию через устройства вывода (конкретно, через тот же экран).

2. Функции продукта

При первом запуске приложения пользователь увидит страницу входа/регистрации.
Приложение будет отправлять данные пользователя на сервер, а также сохранять их локально, генерировать ежедневные задачи, однопользовательские викторины.
С помощью приложение будет доступно создать свою викторину, к которой могут присоединиться другие участники по qr-коду. Заработанные очки за прохождения викторин можно перевести в гигабайты и минуты Tele2.
Пользователю в главном окне предоставляются следующие функции:

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

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

3. Характеристика пользователя

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

4. Ограничения

  1. Приложение должно быть полностью безопасным для личных данных пользователя.

  2. Приложение не должно пагубно влиять на физическое и психологическое здоровье пользователя.

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

  4. Приложение не должно нести никакого вреда системе пользователю, а также должно рационально использовать ее ресурсы.

  5. Приложение должно быть максимально оптимизировано и оттестировано на критических ситуациях.

  6. Приложение должно работать как в режиме оффлайн, так и онлайн.

Детальные требования

1. Требования к внешним интерфейсам

1.1. Основной интерфейс приложения

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

P.s. К дизайну могут быть применены изменения, при согласовании их с заказчиком.

1.2. Интерфейсы страниц приложения

В приложении присутствуют следующие страницы:

  • Авторизация/Регистрация
  • Главная страница с ежедневными заданиями, квизами
  • Страницы квизов, вопросов
  • Друзья
  • Настройки

Макеты страниц:

image image

2. Функциональные требования

2.1. Особенности хранения данных

2.1.1. Структура БД

image

2.1.2. API

В рамках приложения должно быть реализовано API для связи клиента и сервера. Сервер должен обрабатывать запросы от клиента и “админки”.

2.2. Описание основных алгоритмов

лавная цель приложения – предоставить детям и подросткам школьный и профильный материал в игровой форме с вознаграждением.
Должна быть реализована возможность добавления в друзья и возможность играть в викторины с другими людьми.
Должна быть реализована возможность проходить викторины на разные темы.
По возможности реализовать все алгоритмы, которые работают с данными, с использованием БД и соответственно запросов.

2.3. Описание функций отдельных элементов

По возможности, приложение должно быть построено на функциях и классах с их описаниями, для дальнейшей поддержки продукта.
Дизайн приложения должен быть рассчитан как можно на большее количество типов разрешения экрана.
Элементы интерфейса не должны “сползать” или быть недоступными из-за особенности системы.

3. Требования к производительности

3.1. Приложение должно запускаться как можно на большем разнообразии конфигурации Систем.

Приложение должно запускаться как можно на большем разнообразии конфигурации систем.
Приложение не должно требовать от системы пользователя дискретный видеоадаптер (дискретную видеокарту/GPU).
По возможности протестировать продукт на наличие утечек памяти, при долгом или ненадлежащем использовании продукта.
Приложение должно использовать пространство на физическом накопителе экономно.
Другими словами, приложение не должно записывать одни и те же данные по несколько раз, а также, по возможности, использовать общий вид (формулы, особенности разрешений файлов) для получения информации.

Дополнения

оно не работает Настоящее Техническое Задание может уточняться/дополняться/изменяться в период создания и поддержки продукта