Добавлены README и скриншоты

README.md

@@ -0,0 +1,464 @@
+# Руководство пользователя
+
+Веб-приложение «Информационная система учёта научных достижений участников образовательного процесса ПТИ»
+
+---
+
+> [!NOTE]
+> Данное руководство поможет вам освоить работу с системой.  
+> > Система разработана для Политехнического института НовГУ.  
+> <details>
+> <summary>Краткое описание системы (нажмите, чтобы развернуть)</summary>
+> Система предназначена для централизованного учёта, проверки и анализа научных достижений.
+> </details>
+
+---
+
+## Аннотация
+
+Настоящий документ является руководством пользователя веб-приложения «Информационная система учёта научных достижений участников образовательного процесса ПТИ». Документ предназначен для студентов, преподавателей и руководителей Политехнического института, использующих систему для добавления, проверки и анализа научных достижений.
+
+---
+
+## Содержание
+
+1. [Введение](#1-введение)
+   - 1.1 [Область применения](#11-область-применения)
+   - 1.2 [Краткое описание возможностей](#12-краткое-описание-возможностей)
+   - 1.3 [Уровень подготовки пользователя](#13-уровень-подготовки-пользователя)
+   - 1.4 [Перечень эксплуатационной документации](#14-перечень-эксплуатационной-документации)
+2. [Назначение и условия применения](#2-назначение-и-условия-применения)
+   - 2.1 [Назначение](#21-назначение)
+   - 2.2 [Условия применения](#22-условия-применения)
+3. [Установка](#3-установка)
+4. [Подготовка к работе](#4-подготовка-к-работе)
+   - 4.1 [Требования к окружению](#41-требования-к-окружению)
+   - 4.2 [Доступ к системе](#42-доступ-к-системе)
+   - 4.3 [Вход в систему](#43-вход-в-систему)
+   - 4.4 [Основные элементы интерфейса](#44-основные-элементы-интерфейса)
+   - 4.5 [Порядок проверки работоспособности](#45-порядок-проверки-работоспособности)
+   - 4.6 [Выход из системы](#46-выход-из-системы)
+5. [Описание операций](#5-описание-операций)
+   - 5.1 [Управление достижениями](#51-управление-достижениями)
+   - 5.2 [Верификация достижений](#52-верификация-достижений)
+   - 5.3 [Формирование отчётов](#53-формирование-отчётов)
+   - 5.4 [Просмотр статистики](#54-просмотр-статистики)
+   - 5.5 [Импорт достижений из внешних систем](#55-импорт-достижений-из-внешних-систем)
+   - 5.6 [Управление профилем](#56-управление-профилем)
+6. [Аварийные ситуации](#6-аварийные-ситуации)
+7. [Рекомендации по освоению](#7-рекомендации-по-освоению)
+8. [Термины и сокращения](#8-термины-и-сокращения)
+9. [Контакты](#9-контакты)
+[Лист регистрации изменений](#лист-регистрации-изменений)
+
+---
+
+## 1. Введение
+
+### 1.1. Область применения
+
+Настоящий документ предназначен для пользователей веб-приложения «Информационная система учёта научных достижений участников образовательного процесса ПТИ» (далее — Система).
+
+Система используется в Политехническом институте Новгородского государственного университета. Доступ к Системе осуществляется через веб-браузер с персонального компьютера или ноутбука.
+
+### 1.2. Краткое описание возможностей
+
+Система обеспечивает выполнение следующих основных функций:
+
+- ведение единого реестра научных достижений (публикации, конференции, олимпиады, конкурсы, гранты);
+- автоматический импорт данных из внешних источников (корпоративный портал НовГУ, система ДО, ПУМА, eLibrary);
+- ручное добавление достижений с последующей проверкой преподавателем;
+- формирование информационных карт на повышенную стипендию и сводных отчётов НИРС в формате PDF;
+- визуализацию статистики научной активности с помощью интерактивных графиков;
+- разграничение прав доступа для трёх ролей пользователей.
+
+### 1.3. Уровень подготовки пользователя
+
+Для работы с Системой пользователю достаточно иметь базовые навыки работы с веб-браузером: переход по ссылкам, заполнение форм, загрузка файлов. Специальной подготовки не требуется.
+
+Пользователи с разными ролями должны знать свои функциональные обязанности:
+
+- **студент** должен уметь добавлять, редактировать и удалять собственные достижения, отслеживать статус верификации, формировать стипендиальную карту;
+- **преподаватель** должен уметь просматривать достижения закреплённых студентов, подтверждать или отклонять их, формировать стипендиальные карты;
+- **руководитель** должен уметь формировать сводные отчёты НИРС и просматривать аналитику.
+
+### 1.4. Перечень эксплуатационной документации
+
+Перед началом работы с Системой рекомендуется ознакомиться со следующими документами:
+
+- техническое задание на веб-приложение;
+- спецификация требований;
+- руководство программиста;
+- руководство пользователя (настоящий документ).
+
+---
+
+## 2. Назначение и условия применения
+
+### 2.1. Назначение
+
+Система предназначена для централизованного учёта, проверки и анализа научных достижений студентов и сотрудников Политехнического института НовГУ.
+
+Система позволяет:
+- обеспечить взаимодействие студентов, преподавателей и руководителей в процессах учёта достижений;
+- повысить прозрачность процесса верификации научных достижений;
+- сократить время на формирование отчётной документации за счёт автоматизации;
+- обеспечить руководство института достоверной и актуальной информацией о научной активности подразделений.
+
+### 2.2. Условия применения
+
+Система может эксплуатироваться и выполнять заданные функции при соблюдении следующих условий.
+
+**Аппаратные требования к рабочему месту пользователя:**
+- персональный компьютер или ноутбук;
+- разрешение экрана не менее 1280×720 пикселей;
+- доступ к сети Интернет со скоростью не менее 1 Мбит/с.
+
+**Программные требования:**
+- один из современных веб-браузеров: Google Chrome 90+, Mozilla Firefox 88+, Microsoft Edge 90+, Яндекс.Браузер, Safari 14+;
+- операционная система: Windows, Linux или macOS.
+
+---
+
+## 3. Установка
+
+Для установки и настройки системы выполните следующие шаги:
+
+1. [x] Установите один из современных веб-браузеров (Google Chrome 90+, Mozilla Firefox 88+, Edge 90+)
+2. [x] Убедитесь, что у вас есть доступ к сети Интернет
+3. [ ] Получите учётные данные (логин и пароль) у руководства института
+4. [ ] Перейдите по адресу, предоставленному администратором
+5. [ ] Войдите в систему, используя свои учётные данные
+
+> **Важно:** Для корректной работы системы необходимо включить поддержку JavaScript в браузере.
+
+---
+
+## 4. Подготовка к работе
+
+### 4.1. Требования к окружению
+
+Для работы с Системой необходимо обеспечить выполнение требований, указанных в разделе 2.2.
+
+Перед началом работы рекомендуется убедиться, что:
+- браузер обновлён до актуальной версии;
+- включена поддержка JavaScript;
+- разрешено получение уведомлений от сайта (для работы внутренних уведомлений).
+
+### 4.2. Доступ к системе
+
+Учётные данные (логин и пароль) выдаются руководством Политехнического института. При наличии корпоративной учётной записи НовГУ возможен вход через единую систему (SSO) с использованием протоколов OAuth2 или LDAP.
+
+### 4.3. Вход в систему
+
+Для входа в Систему необходимо выполнить следующие действия:
+1. открыть веб-браузер и перейти по адресу, предоставленному администратором;
+2. ввести логин в поле «Электронная почта / Логин»;
+3. ввести пароль в поле «Пароль» (символы скрываются для безопасности);
+4. нажать кнопку «Войти».
+
+Форма авторизации представлена ниже.
+
+![Форма авторизации](screenshots/auth.png)
+
+При неверных учётных данных отображается сообщение:
+
+> «Неверный логин или пароль»
+
+### 4.4. Основные элементы интерфейса
+
+Интерфейс Системы включает следующие разделы, доступ к которым осуществляется через верхнее навигационное меню, которое вы можете увидеть ниже.
+
+![Главное навигационное меню](screenshots/navigation.png)
+
+| Раздел | Описание |
+|--------|----------|
+| Мои достижения | Просмотр, добавление, редактирование, фильтрация и поиск достижений |
+| Мои отчеты | Формирование стипендиальной карты или просмотр сводных отчётов НИРС |
+| Моя статистика | Интерактивные графики и диаграммы научной активности |
+| Мой профиль | Просмотр личных данных, выход из системы |
+| Уведомления | Отображение внутренних уведомлений о смене статуса верификации |
+| Корзина | Восстановление или окончательное удаление ранее удалённых записей |
+
+Пользователи с ролью «Преподаватель» дополнительно имеют возможность фильтровать достижения, ожидающие проверки.
+
+### 4.5. Порядок проверки работоспособности
+
+Для проверки работоспособности Системы необходимо выполнить следующие действия:
+1. выполнить вход в Систему в соответствии с разделом 3.3;
+2. убедиться, что главная страница загрузилась корректно;
+3. перейти в раздел «Достижения» и проверить, что список достижений отображается;
+4. проверить, что кнопки фильтрации и поиска активны.
+
+Если все перечисленные действия выполнены успешно, Система считается работоспособной.
+
+### 4.6. Выход из системы
+
+Для выхода из Системы необходимо:
+1. перейти в раздел «Мой профиль»;
+2. нажать кнопку «Выход из профиля»;
+3. подтвердить действие в диалоговом окне: 
+
+> «Вы действительно хотите выйти?»
+
+Внешний вид окна выхода из системы, вы можете увидеть ниже.
+
+![Окно выхода из системы](screenshots/logout.png)
+
+После выхода все сохранённые данные сессии удаляются, и пользователь перенаправляется на страницу авторизации.
+
+---
+
+## 5. Описание операций
+
+### 5.1. Управление достижениями
+
+#### 5.1.1. Просмотр списка достижений
+
+На странице «Мои достижения» предусмотрены два режима отображения записей о научных достижениях:
+- вкладка «Мои достижения» — карточный режим, позволяющий визуально оценить каждое достижение с основными данными;
+- вкладка «Быстрый просмотр» — табличный режим, отображающий все достижения в виде компактной таблицы.
+
+Вкладка «Мои достижения» (карточный режим) вы можете увидеть ниже.
+
+![Вкладка «Мои достижения» (карточный режим)](screenshots/achievements_card.png)
+
+Каждая запись в списке содержит следующую информацию:
+- тип достижения (публикация, конференция, олимпиада, конкурс, грант, иное);
+- название мероприятия или публикации;
+- уровень достижения (международный, всероссийский, региональный, вузовский);
+- дата проведения или публикации;
+- статус верификации (ожидает проверки, подтверждено, отклонено);
+- подтверждающий документ (при наличии).
+
+Вкладка «Быстрый просмотр» (табличный режим) представлен ниже.
+
+![Вкладка «Быстрый просмотр» (табличный режим)](screenshots/achievements_table.png)
+
+#### 5.1.2. Фильтрация и поиск
+
+Для быстрого поиска нужной записи в Системе предусмотрены следующие инструменты:
+- фильтрация по типу достижения, уровню, статусу верификации и году;
+- поиск по названию мероприятия или публикации.
+
+Вы можете увидеть, как выглядит визуально панель фильтрации и поиска ниже.
+
+![Панель фильтрации и поиска](screenshots/filter.png)
+
+При изменении параметров фильтрации или вводе поискового запроса список достижений автоматически обновляется.
+
+#### 5.1.3. Добавление достижения
+
+Функция добавления достижения доступна пользователям с ролью «Студент».
+
+Для добавления нового достижения необходимо выполнить следующие действия:
+1. нажать кнопку «Добавить достижение» на странице «Достижения»;
+2. заполнить форму добавления, указав: тип достижения, название мероприятия или публикации, уровень достижения, дату проведения или публикации, преподавателя, ответственного за проверку (выбрать из выпадающего списка), подтверждающий документ (прикрепить файл в формате PDF, JPG или PNG);
+3. нажать кнопку «Создать достижение».
+
+Окно добавления достижения представлен ниже.
+
+![Окно добавления достижения](screenshots/add_achievement.png)
+
+> **Обратите внимание:** Подтверждающий документ должен быть в формате PDF, JPG или PNG. Максимальный размер файла — 10 МБ.
+
+После сохранения достижение появляется в общем списке со статусом «ожидает проверки». Преподаватель, выбранный ответственным, получает уведомление о необходимости проверки.
+
+*Пример кода для отправки нового достижения через API:*
+
+```javascript
+async function addAchievement(achievementData) {
+    try {
+        const response = await fetch('/api/achievements', {
+            method: 'POST',
+            headers: {
+                'Authorization': `Bearer ${localStorage.getItem('token')}`,
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify(achievementData)
+        });
+        
+        if (response.ok) {
+            const result = await response.json();
+            console.log('Достижение добавлено:', result);
+            return result;
+        } else {
+            throw new Error('Ошибка при добавлении');
+        }
+    } catch (error) {
+        console.error('Ошибка:', error);
+    }
+}
+```
+
+#### 5.1.4. Редактирование достижения
+
+Функция редактирования доступна пользователям с ролью «Студент», но только для достижений, имеющих статус «отклонено».
+
+Для редактирования достижения необходимо:
+1. найти нужную запись в списке достижений;
+2. нажать кнопку редактирования (иконка карандаша);
+3. внести необходимые изменения в открывшейся форме;
+4. нажать кнопку «Сохранить».
+
+После редактирования достижение повторно отправляется на проверку со статусом «ожидает проверки».
+
+#### 5.1.5. Удаление достижения
+
+Функция удаления доступна пользователям с ролью «Студент», но только для достижений, имеющих статус «отклонено».
+
+При удалении запись не удаляется окончательно, а перемещается в раздел «Корзина». Для удаления необходимо:
+1. найти нужную запись в списке достижений;
+2. нажать кнопку «Удалить» (иконка корзины);
+3. подтвердить действие в диалоговом окне.
+
+#### 5.1.6. Восстановление достижения из корзины
+
+Раздел «Корзина» доступен пользователям с ролью «Студент». В нём отображаются все ранее удалённые записи.
+
+Для восстановления записи необходимо нажать кнопку «Восстановить» рядом с соответствующей записью. Запись возвращается в основной список достижений.
+
+Для окончательного удаления записи без возможности восстановления необходимо нажать кнопку «Удалить навсегда» и подтвердить действие.
+
+### 5.2. Верификация достижений
+
+Функция верификации достижений доступна пользователям с ролью «Преподаватель». Преподаватель получает внутреннее уведомление о поступлении нового достижения на проверку.
+
+Для проверки достижения необходимо выполнить следующие действия:
+1. перейти в раздел «Мои достижения»;
+2. отфильтровать записи по статусу «ожидает проверки»;
+3. нажать на запись, чтобы открыть карточку достижения;
+4. ознакомиться с загруженным подтверждающим документом (скачать или просмотреть онлайн);
+5. принять решение, нажав кнопку «Одобрить» или «Отклонить».
+
+При одобрении статус достижения изменяется на «подтверждено». При отклонении статус изменяется на «отклонено», при этом преподаватель может указать причину отклонения. Студент получает уведомление о результатах проверки.
+
+### 5.3. Формирование отчётов
+
+#### 5.3.1. Формирование стипендиальной карты
+
+Функция формирования стипендиальной карты доступна пользователям с ролями «Студент» и «Преподаватель».
+
+Для формирования информационной карты на повышенную академическую стипендию необходимо:
+1. перейти в раздел «Мои отчёты» и во вкладку «Формирование отчета»;
+2. выбрать период формирования;
+3. нажать кнопку «Сформировать отчет»;
+4. дождаться окончания генерации (отображается индикатор ожидания);
+5. скачать готовый документ в формате PDF.
+
+Страница «Мои отчёты» с кнопкой «Сформировать отчет представлена ниже.
+
+![Страница «Мои отчёты»](screenshots/report.png)
+
+#### 5.3.2. Формирование сводных отчётов НИРС
+
+Функция формирования сводных отчётов НИРС доступна пользователям с ролью «Руководитель».
+
+В разделе «Мои отчёты» во вкладке «История отчетов» для руководителя отображается список ранее сформированных сводных отчётов по научно-исследовательской работе студентов.
+
+Как отчеты отображаются списком представлено ниже.
+
+![Список отчётов НИРС](screenshots/reports_list.png)
+
+Для просмотра отчёта необходимо нажать на кнопку «Просмотр», для повторного скачивания отчёта в формате PDF — на кнопку «Скачать». Для создания нового отчёта следует перейти на вкладку «Формирование отчета», выбрать подразделение и период.
+
+### 5.4. Просмотр статистики
+
+В разделе «Моя статистика» отображаются интерактивные графики и диаграммы научной активности пользователя:
+- распределение достижений по типам мероприятий;
+- распределение достижений по уровням (международный, всероссийский, региональный);
+- динамика активности по годам.
+
+Страница статистики с графиками представлена ниже.
+
+![Страница статистики с графиками](screenshots/statistics.png)
+
+Пользователь может переключать типы диаграмм: линейные графики, столбчатые диаграммы, круговые диаграммы, а также таблицы.
+
+### 5.5. Импорт достижений из внешних систем
+
+Система в автоматическом режиме (в фоновом режиме) выполняет импорт достижений из следующих внешних источников:
+- корпоративный портал НовГУ;
+- система дистанционного обучения (ДО);
+- система учёта публикаций ПУМА;
+- научная электронная библиотека eLibrary.
+
+Ручной запуск импорта не требуется. При импорте система автоматически проверяет записи на дублирование и предотвращает повторное добавление.
+
+Журнал операций синхронизации доступен пользователям с ролью «Руководитель» в отдельном разделе.
+
+### 5.6. Управление профилем
+
+В разделе «Профиль» отображаются личные данные пользователя:
+- фамилия, имя, отчество;
+- роль (студент, преподаватель, руководитель);
+- институт и кафедра;
+- курс (только для студентов);
+- электронная почта.
+
+Как выглядит страница профиля пользователя представлена ниже.
+
+![Страница профиля](screenshots/profile.png)
+
+Для выхода из системы необходимо нажать кнопку «Выйти» в этом разделе.
+
+---
+
+## 6. Аварийные ситуации
+
+В данном разделе описаны возможные ошибки при работе с Системой и рекомендации по их устранению.
+
+| Описание ошибки | Рекомендации по устранению |
+|----------------|---------------------------|
+| «Неверный логин или пароль» | Проверить правильность ввода (учитывать регистр символов). При повторных неудачах обратиться к руководству института |
+| «Превышено максимальное количество попыток входа. Ваш аккаунт заблокирован» | Обратиться к администратору Системы для разблокировки |
+| «Отсутствует подключение к Интернету» | Проверить сетевое соединение. Обновить страницу после восстановления связи |
+| «Не заполнены обязательные поля» | Убедиться, что заполнены тип, название, уровень, дата, выбран преподаватель |
+| «Недопустимый формат файла» | Использовать файлы форматов PDF, JPG или PNG |
+| «Файл слишком большой. Максимальный размер — 10 МБ» | Сжать файл или выбрать файл меньшего размера |
+| «Ошибка при формировании отчёта» | Повторить операцию через несколько минут. При повторном сбое обратиться к администратору |
+| «У вас нет прав для выполнения данной операции» | Обратиться к администратору для получения необходимых прав |
+| «Редактирование недоступно. Достижение имеет статус «подтверждено» или «ожидает проверки» | Редактирование доступно только для отклонённых достижений |
+| «Не удалось сохранить файл» | Проверить наличие свободного места на устройстве и права на запись |
+
+При возникновении ошибок, не описанных в данной таблице, необходимо обратиться к администратору Системы или в службу технической поддержки.
+
+---
+
+## 7. Рекомендации по освоению
+
+Для быстрого освоения работы в Системе рекомендуется выполнить контрольный пример, описанный в разделе 4.1.3 («Добавление достижения»), и ознакомиться с разделом 4.3.1 («Формирование стипендиальной карты»). Это позволит ознакомиться с основными операциями, доступными пользователю.
+
+При возникновении трудностей рекомендуется обратиться к разделу 5 «Аварийные ситуации» настоящего документа или направить запрос в службу технической поддержки.
+
+Рекомендуется также ознакомиться со следующими документами:
+- техническое задание на веб-приложение;
+- руководство администратора Системы.
+
+---
+
+## 8. Термины и сокращения
+
+| Термин | Расшифровка |
+|--------|-------------|
+| НИРС | Научно-исследовательская работа студентов |
+| ПТИ | Политехнический институт |
+| Верификация | Процесс проверки и подтверждения достоверности сведений о достижении преподавателем |
+| JWT | JSON Web Token — токен для аутентификации |
+| RBAC | Ролевая модель доступа (студент, преподаватель, руководитель) |
+
+---
+
+## 9. Контакты
+
+По всем вопросам, связанным с работой системы, обращайтесь:
+
+[Мой Telegram](https://t.me/arpink_land)
+
+---
+
+## Лист регистрации изменений
+
+| № | Дата | Раздел | Изменение | Автор |
+|:--|:-----|:-------|:----------|:------|
+| 1 | 20.05.2026 | Все разделы | Создание README.md | Овчаренко А.В. |