Лабораторная работа №14. Руководство пользователя

rybkina_aa 48b5dd04b0 Обновить 'README.md'		1 tháng trước cách đây
README.md	48b5dd04b0 Обновить 'README.md'	1 tháng trước cách đây

Руководство пользователя Portfolio

Аннотация

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

Содержание

1 Введение
2 Назначение и условия применения
3 Подготовка к работе
4 Описание операций
5 Аварийные ситуации
6 Рекомендации по освоению
7 Термины и сокращения
8 Контакты
Лист регистрации изменений

1 Введение

1.1 Область применения

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

Система обеспечивает:

хранение информации о достижениях;
формирование отчётности;
проверку достижений преподавателями;
просмотр статистики;
экспорт документов в PDF.

Типичные сценарии использования:

добавление студентами информации о достижениях;
проверка достижений преподавателями;
формирование информационной карты для повышенной стипендии;
анализ статистики научной активности.

1.2 Краткое описание возможностей

Portfolio предоставляет следующие возможности:

добавление и редактирование достижений;
загрузка подтверждающих документов;
фильтрация и поиск достижений;
просмотр статистики активности;
формирование информационной карты;
работа с отчётами;
управление личным профилем;
экспорт PDF-документов.

1.3 Уровень подготовки пользователя

Пользователь должен обладать:

базовыми навыками работы со смартфоном Android;
навыками работы с мобильными приложениями;
доступом к сети Интернет.

1.4 Перечень эксплуатационной документации

При эксплуатации приложения рекомендуется использовать:

Документ	Назначение
Руководство пользователя	Полное описание работы с приложением Portfolio (настоящий документ)
Краткая инструкция по установке	Пошаговое руководство по установке APK-файла на устройство
Справочный раздел в приложении	Встроенная помощь (доступна в профиле → «Политика» → «Справка»)

Полезная информация

При отсутствии подключения к Интернету приложение использует локальный кэш данных.

2 Назначение и условия применения

Приложение предназначено для автоматизации процесса учёта научных достижений студентов и преподавателей.

Основные задачи системы:

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

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

Компонент	Требования
Операционная система	Android 8.0 и выше
Оперативная память	От 2 ГБ
Свободное место	От 100 МБ
Интернет	Wi-Fi или мобильная сеть

3 Подготовка к работе

3.1 Установка приложения

Порядок установки

Скачать APK-файл приложения.
Перенести файл на мобильное устройство.
Открыть APK-файл.
Разрешить установку из неизвестных источников.
Дождаться завершения установки.
Запустить приложение.

Проверка установки

Приложение установлено
Иконка отображается на главном экране
Открывается экран авторизации

3.2 Запуск программы

Для запуска необходимо нажать на иконку Portfolio на главном экране устройства.

3.3 Проверка работоспособности

Для проверки корректной работы необходимо:

Выполнить вход в систему.
Открыть раздел «Достижения».
Проверить загрузку списка достижений.
Попробовать создать новое достижение.

4 Описание операций

4.1 Авторизация пользователя

При запуске приложения отображается экран авторизации.

Для входа в систему необходимо:

Ввести логин в поле «Логин».
Ввести пароль в поле «Пароль».
Нажать кнопку «Войти».

При успешной авторизации выполняется переход на главный экран приложения.

Если данные введены неверно, отображается сообщение:

Неверный логин или пароль

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

4.2 Добавление достижения

Для добавления достижения необходимо нажать кнопку «Добавить достижение» в верхней части главного экрана.

После нажатия открывается форма добавления достижения.

Пользователь должен заполнить следующие поля:

тип мероприятия;
название мероприятия;
место проведения;
результат участия;
преподаватель;
подтверждающий документ.

Поддерживаются файлы форматов:

PDF;
PNG.

После заполнения формы необходимо нажать кнопку «Сохранить».

После успешного сохранения:

достижение появляется в общем списке;
статус устанавливается как «На рассмотрении»;
преподавателю отправляется уведомление.

Для отмены операции используется кнопка «Отмена».

4.3 Редактирование достижения

Редактирование доступно только для достижений со статусом «Отклонено».

Для редактирования необходимо:

Нажать кнопку с иконкой карандаша.
Изменить необходимые данные.
Нажать кнопку «Сохранить».

После сохранения достижение повторно отправляется на проверку преподавателю.

4.4 Удаление достижения

Удаление также доступно только для отклонённых достижений.

Порядок удаления:

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

После подтверждения запись удаляется без возможности восстановления.

4.5 Формирование отчёта

Для формирования информационной карты необходимо:

Перейти в раздел «Портфолио».
Нажать кнопку «СФОРМИРОВАТЬ».
Дождаться завершения генерации PDF-документа.

После формирования появляется карточка предпросмотра документа.

Пользователь может:

открыть документ;
сохранить PDF-файл на устройство;
отправить файл.

Ниже представлен экран отчетов.

4.6 Просмотр статистики

На экране статистики отображаются:

диаграммы активности;
количество достижений;
распределение по типам мероприятий;
статистика по годам.

Данные автоматически загружаются с сервера.

4.7 Управление профилем

В разделе «Профиль» пользователь может:

просматривать личные данные;
редактировать информацию профиля;
ознакомиться с политикой конфиденциальности;
связаться с разработчиками;
выполнить выход из системы.

Ниже представлен экран профиля.

Пример программного кода

suspend fun login(email: String, password: String): NetworkResult<LoginResponse> {
        return safeApiCall {
            val response = RetrofitClient.apiService.login(LoginRequest(email, password))
            saveTokens(response.access_token, response.refresh_token)
            response
        }
    }

5 Аварийные ситуации

Ошибка	Рекомендация
Неверный логин или пароль	Проверить правильность введённых данных
Нет подключения к Интернету	Проверить Wi-Fi или мобильную сеть
Недопустимый формат файла	Использовать PDF или PNG
Файл слишком большой	Уменьшить размер файла
Не удалось сохранить PDF	Проверить свободное место

6 Рекомендации по освоению

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

7 Термины и сокращения

Термин	Значение
НИРС	Научно-исследовательская работа студентов
ПТИ	Политехнический институт
PDF	Portable Document Format
JWT	JSON Web Token
FCM	Firebase Cloud Messaging

8 Контакты

Telegram: Связаться с разработчиком

Лист регистрации изменений

№	Дата	Раздел	Изменение	Автор
1	19.05.2026	Все разделы	Создание README.md	Рыбкина А.А.
2	20.05.2026	4	Добавление изображений и примеров	Рыбкина А.А.

Приложение Portfolio позволяет автоматизировать процесс учёта научных достижений и значительно ускоряет формирование отчётности для повышенной стипендии.

README.md