|
|
@@ -1 +1,351 @@
|
|
|
- https://gogs.itiscaf.ru/rybkina_aa/rybkina_lr14/src/master/%d0%b0%d0%b2%d1%82%d0%be%d1%80%d0%b8%d0%b7%d0%b0%d1%86%d0%b8%d1%8f.jpg
|
|
|
+# Руководство пользователя Portfolio
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Аннотация
|
|
|
+
|
|
|
+Настоящий документ является руководством пользователя мобильного приложения **Portfolio** – информационной системы учёта научных достижений участников образовательного процесса.
|
|
|
+Документ предназначен для студентов, преподавателей и руководителей Политехнического института, использующих систему для добавления, проверки и анализа достижений.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Содержание
|
|
|
+
|
|
|
+- [1 Введение](#1-введение)
|
|
|
+ - [1.1 Область применения](#11-область-применения)
|
|
|
+ - [1.2 Краткое описание возможностей](#12-краткое-описание-возможностей)
|
|
|
+ - [1.3 Уровень подготовки пользователя](#13-уровень-подготовки-пользователя)
|
|
|
+ - [1.4 Перечень эксплуатационной документации](#14-перечень-эксплуатационной-документации)
|
|
|
+- [2 Назначение и условия применения](#2-назначение-и-условия-применения)
|
|
|
+- [3 Подготовка к работе](#3-подготовка-к-работе)
|
|
|
+ - [3.1 Установка приложения](#31-установка-приложения)
|
|
|
+ - [3.2 Запуск программы](#32-запуск-программы)
|
|
|
+ - [3.3 Проверка работоспособности](#33-проверка-работоспособности)
|
|
|
+
|
|
|
+- [4 Описание операций](#4-описание-операций)
|
|
|
+ - [4.1 Авторизация пользователя](#41-авторизация-пользователя)
|
|
|
+ - [4.2 Добавление достижения](#42-добавление-достижения)
|
|
|
+ - [4.3 Редактирование достижения](#43-редактирование-достижения)
|
|
|
+ - [4.4 Удаление достижения](#44-удаление-достижения)
|
|
|
+ - [4.5 Формирование отчёта](#45-формирование-отчёта)
|
|
|
+ - [4.6 Просмотр статистики](#46-просмотр-статистики)
|
|
|
+ - [4.7 Управление профилем](#47-управление-профилем)
|
|
|
+- [5 Аварийные ситуации](#5-аварийные-ситуации)
|
|
|
+- [6 Рекомендации по освоению](#6-рекомендации-по-освоению)
|
|
|
+- [7 Термины и сокращения](#7-термины-и-сокращения)
|
|
|
+- [8 Контакты](#8-контакты)
|
|
|
+- [Лист регистрации изменений](#лист-регистрации-изменений)
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# 1 Введение
|
|
|
+
|
|
|
+## 1.1 Область применения
|
|
|
+
|
|
|
+Приложение **Portfolio** применяется в образовательных учреждениях для централизованного учёта научных достижений студентов.
|
|
|
+
|
|
|
+Система обеспечивает:
|
|
|
+
|
|
|
+- хранение информации о достижениях;
|
|
|
+- формирование отчётности;
|
|
|
+- проверку достижений преподавателями;
|
|
|
+- просмотр статистики;
|
|
|
+- экспорт документов в PDF.
|
|
|
+
|
|
|
+Типичные сценарии использования:
|
|
|
+
|
|
|
+- добавление студентами информации о достижениях;
|
|
|
+- проверка достижений преподавателями;
|
|
|
+- формирование информационной карты для повышенной стипендии;
|
|
|
+- анализ статистики научной активности.
|
|
|
+
|
|
|
+## 1.2 Краткое описание возможностей
|
|
|
+
|
|
|
+Portfolio предоставляет следующие возможности:
|
|
|
+
|
|
|
+- добавление и редактирование достижений;
|
|
|
+- загрузка подтверждающих документов;
|
|
|
+- фильтрация и поиск достижений;
|
|
|
+- просмотр статистики активности;
|
|
|
+- формирование информационной карты;
|
|
|
+- работа с отчётами;
|
|
|
+- управление личным профилем;
|
|
|
+- экспорт PDF-документов.
|
|
|
+
|
|
|
+## 1.3 Уровень подготовки пользователя
|
|
|
+
|
|
|
+Пользователь должен обладать:
|
|
|
+
|
|
|
+- базовыми навыками работы со смартфоном Android;
|
|
|
+- навыками работы с мобильными приложениями;
|
|
|
+- доступом к сети Интернет.
|
|
|
+
|
|
|
+## 1.4 Перечень эксплуатационной документации
|
|
|
+
|
|
|
+При эксплуатации приложения рекомендуется использовать:
|
|
|
+
|
|
|
+
|
|
|
+| Документ | Назначение |
|
|
|
+|:---------|:-----------|
|
|
|
+| Руководство пользователя | Полное описание работы с приложением Portfolio (настоящий документ) |
|
|
|
+| Краткая инструкция по установке | Пошаговое руководство по установке APK-файла на устройство |
|
|
|
+| Справочный раздел в приложении | Встроенная помощь (доступна в профиле → «Политика» → «Справка») |
|
|
|
+
|
|
|
+<details>
|
|
|
+<summary>Полезная информация</summary>
|
|
|
+При отсутствии подключения к Интернету приложение использует локальный кэш данных.
|
|
|
+</details>
|
|
|
+---
|
|
|
+
|
|
|
+# 2 Назначение и условия применения
|
|
|
+
|
|
|
+Приложение предназначено для автоматизации процесса учёта научных достижений студентов и преподавателей.
|
|
|
+
|
|
|
+Основные задачи системы:
|
|
|
+
|
|
|
+- централизованное хранение достижений;
|
|
|
+- ускорение процесса проверки достижений;
|
|
|
+- формирование отчётности для повышенной стипендии;
|
|
|
+- анализ активности участников образовательного процесса.
|
|
|
+
|
|
|
+## Минимальные требования
|
|
|
+
|
|
|
+| Компонент | Требования |
|
|
|
+|---|---|
|
|
|
+| Операционная система | Android 8.0 и выше |
|
|
|
+| Оперативная память | От 2 ГБ |
|
|
|
+| Свободное место | От 100 МБ |
|
|
|
+| Интернет | Wi-Fi или мобильная сеть |
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# 3 Подготовка к работе
|
|
|
+
|
|
|
+## 3.1 Установка приложения
|
|
|
+
|
|
|
+### Порядок установки
|
|
|
+
|
|
|
+1. Скачать APK-файл приложения.
|
|
|
+2. Перенести файл на мобильное устройство.
|
|
|
+3. Открыть APK-файл.
|
|
|
+4. Разрешить установку из неизвестных источников.
|
|
|
+5. Дождаться завершения установки.
|
|
|
+6. Запустить приложение.
|
|
|
+
|
|
|
+### Проверка установки
|
|
|
+
|
|
|
+- [x] Приложение установлено
|
|
|
+- [x] Иконка отображается на главном экране
|
|
|
+- [x] Открывается экран авторизации
|
|
|
+
|
|
|
+## 3.2 Запуск программы
|
|
|
+
|
|
|
+Для запуска необходимо нажать на иконку **Portfolio** на главном экране устройства.
|
|
|
+
|
|
|
+## 3.3 Проверка работоспособности
|
|
|
+
|
|
|
+Для проверки корректной работы необходимо:
|
|
|
+
|
|
|
+1. Выполнить вход в систему.
|
|
|
+2. Открыть раздел «Достижения».
|
|
|
+3. Проверить загрузку списка достижений.
|
|
|
+4. Попробовать создать новое достижение.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# 4 Описание операций
|
|
|
+
|
|
|
+## 4.1 Авторизация пользователя
|
|
|
+
|
|
|
+При запуске приложения отображается экран авторизации.
|
|
|
+
|
|
|
+Для входа в систему необходимо:
|
|
|
+
|
|
|
+1. Ввести логин в поле «Логин».
|
|
|
+2. Ввести пароль в поле «Пароль».
|
|
|
+3. Нажать кнопку **«Войти»**.
|
|
|
+
|
|
|
+При успешной авторизации выполняется переход на главный экран приложения.
|
|
|
+
|
|
|
+Если данные введены неверно, отображается сообщение:
|
|
|
+
|
|
|
+> Неверный логин или пароль
|
|
|
+
|
|
|
+При повторном запуске приложения вход выполняется автоматически по сохранённому токену. Ниже представлен экран авторизации.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 4.2 Добавление достижения
|
|
|
+
|
|
|
+Для добавления достижения необходимо нажать кнопку **«Добавить достижение»** в верхней части главного экрана.
|
|
|
+
|
|
|
+После нажатия открывается форма добавления достижения.
|
|
|
+
|
|
|
+Пользователь должен заполнить следующие поля:
|
|
|
+
|
|
|
+- тип мероприятия;
|
|
|
+- название мероприятия;
|
|
|
+- место проведения;
|
|
|
+- результат участия;
|
|
|
+- преподаватель;
|
|
|
+- подтверждающий документ.
|
|
|
+
|
|
|
+Поддерживаются файлы форматов:
|
|
|
+
|
|
|
+- PDF;
|
|
|
+- PNG.
|
|
|
+
|
|
|
+После заполнения формы необходимо нажать кнопку **«Сохранить»**.
|
|
|
+
|
|
|
+После успешного сохранения:
|
|
|
+
|
|
|
+- достижение появляется в общем списке;
|
|
|
+- статус устанавливается как «На рассмотрении»;
|
|
|
+- преподавателю отправляется уведомление.
|
|
|
+
|
|
|
+Для отмены операции используется кнопка **«Отмена»**.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 4.3 Редактирование достижения
|
|
|
+
|
|
|
+Редактирование доступно только для достижений со статусом **«Отклонено»**.
|
|
|
+
|
|
|
+Для редактирования необходимо:
|
|
|
+
|
|
|
+1. Нажать кнопку с иконкой карандаша.
|
|
|
+2. Изменить необходимые данные.
|
|
|
+3. Нажать кнопку **«Сохранить»**.
|
|
|
+
|
|
|
+После сохранения достижение повторно отправляется на проверку преподавателю.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 4.4 Удаление достижения
|
|
|
+
|
|
|
+Удаление также доступно только для отклонённых достижений.
|
|
|
+
|
|
|
+Порядок удаления:
|
|
|
+
|
|
|
+1. Нажать кнопку с иконкой корзины.
|
|
|
+2. Подтвердить удаление в диалоговом окне.
|
|
|
+
|
|
|
+После подтверждения запись удаляется без возможности восстановления.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 4.5 Формирование отчёта
|
|
|
+
|
|
|
+Для формирования информационной карты необходимо:
|
|
|
+
|
|
|
+1. Перейти в раздел **«Портфолио»**.
|
|
|
+2. Нажать кнопку **«СФОРМИРОВАТЬ»**.
|
|
|
+3. Дождаться завершения генерации PDF-документа.
|
|
|
+
|
|
|
+После формирования появляется карточка предпросмотра документа.
|
|
|
+
|
|
|
+Пользователь может:
|
|
|
+
|
|
|
+- открыть документ;
|
|
|
+- сохранить PDF-файл на устройство;
|
|
|
+- отправить файл.
|
|
|
+
|
|
|
+Ниже представлен экран отчетов.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 4.6 Просмотр статистики
|
|
|
+
|
|
|
+На экране статистики отображаются:
|
|
|
+
|
|
|
+- диаграммы активности;
|
|
|
+- количество достижений;
|
|
|
+- распределение по типам мероприятий;
|
|
|
+- статистика по годам.
|
|
|
+
|
|
|
+Данные автоматически загружаются с сервера.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## 4.7 Управление профилем
|
|
|
+
|
|
|
+В разделе «Профиль» пользователь может:
|
|
|
+
|
|
|
+- просматривать личные данные;
|
|
|
+- редактировать информацию профиля;
|
|
|
+- ознакомиться с политикой конфиденциальности;
|
|
|
+- связаться с разработчиками;
|
|
|
+- выполнить выход из системы.
|
|
|
+
|
|
|
+Ниже представлен экран профиля.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+## Пример программного кода
|
|
|
+
|
|
|
+```kotlin
|
|
|
+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: [Связаться с разработчиком](https://t.me/anastiii21)
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Лист регистрации изменений
|
|
|
+
|
|
|
+| № | Дата | Раздел | Изменение | Автор |
|
|
|
+|---|---|---|---|---|
|
|
|
+| 1 | 19.05.2026 | Все разделы | Создание README.md | Рыбкина А.А. |
|
|
|
+| 2 | 20.05.2026 | 4 | Добавление изображений и примеров | Рыбкина А.А. |
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+**Приложение Portfolio позволяет автоматизировать процесс учёта научных достижений и значительно ускоряет формирование отчётности для повышенной стипендии.**
|
