Skip to content

Latest commit

 

History

History
218 lines (157 loc) · 16.2 KB

Requirements Document.md

File metadata and controls

218 lines (157 loc) · 16.2 KB

Требования к проекту


Содержание

1 Введение
1.1 Назначение
1.2 Бизнес-требования
1.2.1 Исходные данные
1.2.2 Возможности бизнеса
1.2.3 Границы проекта
1.3 Аналоги
2 Требования пользователя
2.1 Программные интерфейсы
2.2 Интерфейс пользователя
2.3 Характеристики пользователей
2.3.1 Аудитория приложения
2.4 Предположения и зависимости
3 Системные требования
3.1 Функциональные требования
3.1.1 Основные функции
3.1.1.1 Вход пользователя в приложение
3.1.1.2 Переход между разделами. Меню приложения
3.1.1.3 Просмотр диалогов пользователя
3.1.1.4 Просмотр сообщений конкретного диалога
3.1.1.5 Взаимодействие со списком друзей
3.1.1.6 Просмотр профиля пользователя ВКонтакте
3.2 Нефункциональные требования
3.2.1 Атрибуты качества
3.2.1.1 Требования к удобству использования
3.2.1.2 Требования к безопасности
3.2.2 Ограничения

Глоссарий

  • SharedPreferences — постоянное хранилище на платформе Android, используемое приложениями для хранения своих настроек, например. Это хранилище является относительно постоянным, пользователь может зайти в настройки приложения и очистить данные приложения, тем самым очистив все данные в хранилище.
  • Access Token (рус. Маркер доступа) — некий ключ (обычно просто набор символов), являющийся результатом авторизации, предъявление которого является пропуском к защищенным ресурсам. Обращение к ним в самом простом случае происходит по HTTPS с указанием в заголовках или в качестве одного из параметров полученного Access Token'а.
  • Material Design (рус. Материальный дизайн) — стиль дизайна программного обеспечения и приложений, разработанный компанией Google. Поверхности и края элементов в данном направлении дизайна создают визуальные образы и сигналы, которые передают подсказки и помогают интуитивно ориентироваться, как если бы это происходило в реальном мире.
  • Long Polling — это технология, которая позволяет получать данные о новых событиях с помощью «длинных запросов». Сервер получает запрос, но отправляет ответ на него не сразу, а лишь тогда, когда произойдет какое-либо событие (например, придёт новое сообщение), либо истечет заданное время ожидания.

В этом документе описаны функциональные и нефункциональные требования к мобильному приложению «InTouch» для операционной системы Android.

Часть пользователей ВКонтакте используют неофициальные мобильные клиенты на Android. Использование сторонних клиентов связано в первую очередь с ограниченным фукнционалом, каким обладает официальный клиент, внешним видом, а также ограничениями, которые он возлагает на пользователя, например, прослушивание музыки в фоновом режиме возможно только 30 минут. Совокупность этих факторов и побуждает переходить на сторонние мобильные клиенты.

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

Приложение «InTouch» позволяет зарегистрированным пользователям во ВКонтате ввести переписку со своими друзьями, а также просматривать их профили.

Функции VK Kate Mobile VK Mp3 Mode
Сообщения + + +
Друзья + + +
Новости + + +
Музыка + + +
"Невидимка" / "нечиталка" - + +
Настройка внешнего вида приложения - + +
Встроенный браузер - - +
Мультиаккаунты - - +

Приложение использует API ВКонтакте, в частности, специально разработанный SDK под Android для взаимодействия с этим API.

Экран авторизации.
Экран авторизации
Экран выбора раздела.
Экран выбора раздела
Экран сообщений.
Экран сообщений
Экран диалога.
Экран диалога
Экран профиля.
Экран профиля
Экран друзей.
Экран друзей

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

2.4 Предположения и зависимости

  1. Приложение не работает при отсутствии подключения к Интернету.

Описание. Пользователь должен использовать существующий аккаунт ВКонтакте для входа в приложение.

Функция Требования
Вход в приложение, используя существующий аккаунт ВКонтакте При успешной аутентификации приложение должно предоставить доступ к основным функциям приложения, иначе, при ошибки аутентификации, приложение должно сообщить об этом пользователю

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

Функция Требования
Отображение меню приложения Меню должно быть в форме списка, а также доступ к нему должен осуществляться свайпом по экрану
Выбор раздела в меню При выборе раздела, приложение должно открыть соответствующий раздел и предоставить актуальную информацию, соответствующую разделу

Описание. Пользователь должен иметь возможность просматривать список своих диалогов, а также переход к конкретному из них.

Функция Требования
Отображение диалогов пользователя Отображение диалогов должно быть оформлено в виде списка, с краткой информацией об диалоге: название диалога, содержание последнего сообщения и его время, фото пользователя, с которым ведётся диалог.
Выбор конкретного диалога Открытие окна, в котором отображаются сообщения выбранного диалога

Описание. Пользователь должен иметь возможность просматривать сообщения конкретной беседы или с конкретным пользователем.

Функция Требования
Отображение сообщений диалога Информация должна отображаться в удобной форме: сообщения должны быть отделены друг от друга, должно отображаться время их отправки, сообщения пользователя, который использует текущий мобильный клиент, должны быть различимы, т.е. расположены с противоположной стороны сообщений, которые получил пользователь, и выделены другим цветом
Отправка сообщения При нажатии кнопки "Send", сообщение, введенное в поле ввода, должно быть отправлено пользователю, с кем ведётся диалог

Описание. Пользователь должен иметь возможность просмотра списка друзей, а также взаимодействовать с ним.

Функция Требования
Отображение списка друзей Информация должна быть представлена в виде списка, а также содержать: фото друга, имя и фамилию
Выбор конкретного друга Открытие профиля друга
Долгое нажатие на конкретного друга Открытие выпадающего меню, где определены две функции: удаление друга из списка друзей и занесение друга в чёрный список
Удаление друга При нажатии "Delete" из выпадающего меню, выбранный друг должен быть удалён из списка друзей
Добавление друга в чёрный список При нажатии "Black list" из выпадающего меню, выбранный друг должен быть добавлен в чёрный список и удалён из списка друзей

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

Функция Требования
Отображение профиля пользователя ВКонтакте Отображаемая информация должна содержать: фотографию, имя и фамилию, дату рождения, номер телефона, город, ID. Конечно, если эту информацию предоставил пользователь.
Выбор кнопки начала диалога Открытие диалога с пользователем.
  • Интернет соединение
  1. Использование Material Design;
  2. Плавный интерфейс;
  3. Разделы должны быть подписаны.

Приложение должно хранить Access Token в SharedPreferences, и доступ к нему должно иметь только это приложение.

  • Приложение доступно для смартфонов с версией Android 5.0 и выше
  • Приложение реализована на языке Java