Repository navigation
Non Functional Requirements
Denis Revyagin edited this page Nov 12, 2026
·
2 revisions
Это целевые требования и способы их будущей проверки, а не подтверждённые показатели работающего сервиса. Фактический статус — на странице Home.
Страница описывает требования к качеству работы Telegram-бота «ЮУрГУ.Пары»: насколько быстро, надёжно и безопасно система выполняет функции из Requirements.
Каждое требование содержит целевое значение и способ проверки. Идентификаторы NFR используются на страницах функций и в бэклоге; наличие записи не означает, что проверка уже проведена.
- Номинальная нагрузка — проектное допущение: 60 активных пользователей и пик 5 запросов в секунду в течение 10 минут перед первой парой. Это сценарий испытания, а не измеренная нагрузка и не утверждение, что все 60 зарегистрированных пользователей активны одновременно.
- Ключевые операции — просмотр расписания на день или неделю, сохранение заметки, сохранение настроек.
- Целевое окружение — один VPS, сервисы бота, парсера и планировщика уведомлений в Docker-контейнерах, PostgreSQL на том же сервере.
| ID | Требование | Значение | Как проверяется |
|---|---|---|---|
| NFR-10 | Бот отвечает на команды пользователей | ≥ 99,5 % времени за календарный месяц; простой не более 0,5 % его длительности | Внешний монитор раз в 5 минут проверяет /health как сигнал доступности HTTP-процесса. Отдельно проверяется пользовательский сценарий запроса расписания через Telegram, регистрируются отказы и восстановление. Месячный показатель бота подтверждается этими наблюдениями и журналом инцидентов; один отчёт /health его не доказывает |
| NFR-10.1 | Автоматическое восстановление после сбоя процесса | Перезапуск упавшего контейнера ≤ 1 мин | Контролируемое аварийное завершение основного процесса на тестовом стенде; замер до восстановления /health, затем проверка команды бота. Штатная административная остановка контейнера не подменяет проверку сбоя |
| ID | Требование | Значение | Как проверяется |
|---|---|---|---|
| NFR-1 | Время обработки ключевых операций при номинальной нагрузке | ≤ 2 с для 95 % запросов | Нагрузочный тест: 5 запросов/с в течение 10 минут. Измеряется время от поступления тестового запроса до завершения соответствующей операции, включая БД, формирование ответа и его передачу в заглушку Telegram. Ранний HTTP-ответ о приёме вебхука не считается завершением операции; внешний сайт и доставка Telegram не входят в измерение |
| NFR-2 | Задержка отправки уведомления о паре | ≤ 60 с от расчётного времени до успешного ответа Telegram Bot API на отправку | Сравнение расчётного времени и времени успешной отправки по журналу за неделю. Превышения и пропущенные отправки отражаются в результате, в том числе при внешних сбоях и ограничениях скорости. Время доставки на устройство пользователя не измеряется |
| ID | Требование | Значение | Как проверяется |
|---|---|---|---|
| NFR-11 | Рост нагрузки без изменения архитектуры | Рост в 3 раза (180 пользователей, 15 запросов/с) с выполнением NFR-1 без изменения кода, только за счёт увеличения ресурсов сервера | Нагрузочный тест с интенсивностью 15 запросов/с; критерий — 95-й перцентиль ≤ 2 с |
| NFR-6 | Подключение нового вуза | Реализация одного модуля парсера без изменений в боте, API и схеме базы данных | Ревью кода: парсер вуза реализует общий интерфейс, остальные модули не меняются |
| ID | Требование | Значение | Как проверяется |
|---|---|---|---|
| NFR-12 | Шифрование внешних соединений | Только HTTPS (TLS 1.2 и выше) для API и приёма обновлений от Telegram; HTTP-запросы отклоняются | Проверка сертификата и версий TLS через SSL Labs, попытка обращения по HTTP |
| NFR-13 | Хранение паролей и секретов | Пароли пользователей не хранятся (вход по Telegram ID); токен бота и пароль базы данных передаются через окружение или GitHub Secrets, в репозитории — 0 секретов | Сканирование на секреты в CI при push и pull request; найденные совпадения разбираются. Отсутствие находок сканера не заменяет ревью конфигурации |
| NFR-4 | Учётные данные портала ЮУрГУ | Не запрашиваются и не хранятся; используется только общедоступное расписание | Ревью схемы базы данных и кода парсера |
| NFR-5 | Минимум данных о пользователе | Хранятся Telegram ID, группа, даты регистрации и последней активности, личные заметки, настройки и необходимые записи служебных журналов. ФИО и телефон из профиля пользователя не собираются. Имена преподавателей относятся к публичным данным расписания, а не к профилям пользователей бота | Ревью схемы, кода сбора данных и состава журналов |
Если в проекте появится веб-интерфейс администратора с входом по паролю, пароли хранятся только в виде хэша (Argon2 или bcrypt).
| ID | Требование | Значение | Как проверяется |
|---|---|---|---|
| NFR-14 | Резервное копирование базы данных | Не реже 1 раза в сутки, хранение 7 последних копий на внешнем хранилище (не на том же сервере) | Проверка наличия копий за последние 7 дней по журналу резервного копирования |
| NFR-14.1 | Восстановление из копии | Потеря данных ≤ 24 ч, время восстановления ≤ 2 ч | Пробное восстановление на тестовый стенд 1 раз в месяц с замером времени |
| NFR-3 | Щадящее обновление расписания | Между началами обычных циклов обновления одной группы ≥ 1 ч; более ранний запрос ждёт в очереди. Внутри цикла допустимы до трёх повторов при временном сбое по UC-07; между группами пауза ≥ 5 с | Проверка плановых и внеплановых запросов, времени их начала, последовательности групп и ограниченного числа повторов |
| NFR-7 | Устойчивость к ошибкам парсера | Ошибка разбора страницы одной группы не прерывает обработку остальных и не влияет на работу бота | Тест с подменённым HTML страницы: парсер логирует ошибку и обрабатывает следующие группы |
| ID | Требование | Значение | Как проверяется |
|---|---|---|---|
| NFR-15 | Поддерживаемые клиенты | Официальные клиенты Telegram для Android, iOS, Windows/macOS/Linux и Telegram Web — текущая и предыдущая основная версия | Ручной прогон реализованных к проверяемому релизу сценариев UC-01, UC-03, UC-08, UC-10 на каждом типе клиента; фактические версии и непроверенные комбинации фиксируются. Полная проверка всех четырёх сценариев проводится после готовности функций релиза 1.2, перед его выпуском |
| NFR-15.1 | Используемые элементы интерфейса | Только стандартные элементы Bot API (текстовые сообщения, обычные и встроенные кнопки); без Mini App и сторонних виджетов | Ревью кода обработчиков бота |
| ID | Требование | Значение | Как проверяется |
|---|---|---|---|
| NFR-16 | Число действий в ключевых сценариях | Просмотр расписания на сегодня из главного меню — 1 нажатие; успешная регистрация с однозначным поиском — ≤ 4 действия; добавление заметки на сегодня из главного меню — ≤ 5; включение уведомлений из главного меню — ≤ 4 | Действие — одно нажатие кнопки или отправка введённого текста; автоматические ответы бота не считаются. Проверяются стандартные успешные пути UC-01, UC-03, UC-08, UC-10; повторный ввод после ошибки и выбор другой даты описываются отдельно |
| NFR-8 | Работа без знания команд | 100 % реализованных пользовательских функций доступны через кнопки меню, первоначальный запуск — через штатную кнопку запуска бота | Сценарии проходят без знания текстовых команд. Ввод названия группы, даты, заметки или обращения остаётся допустимым способом ввода данных |
| NFR-16.1 | Понятность интерфейса | Для каждого проверяемого сценария ≥ 4 из 5 пользователей завершают его без подсказок | Два этапа проверки: UC-01 перед релизом MVP; UC-08 после реализации заметок, перед релизом 1.1. Успешность оценивается отдельно для каждого сценария |
| ID | Требование | Значение | Как проверяется |
|---|---|---|---|
| NFR-17 | Канал связи с командой | Команда /feedback в боте пересылает сообщение администратору; контакт команды указан в /help
|
Отправка тестового обращения и проверка его получения |
| NFR-17.1 | Время реакции на обращения | Критичная проблема (бот не отвечает, расписание неверное) — ≤ 4 ч; остальные обращения — ≤ 24 ч в рабочие дни | Журнал обращений: время получения и время первого ответа |
| NFR-9 | Изменение структуры базы данных | Только через миграции Alembic, 100 % изменений схемы покрыты миграциями | Проверка в CI: применение всех миграций к пустой базе завершается без ошибок |