|
|
3 nedēļas atpakaļ | |
|---|---|---|
| screen | 3 nedēļas atpakaļ | |
| README.md | 3 nedēļas atpakaļ |
[!NOTE] Настоящее руководство предназначено для сотрудников, администраторов и руководителей ресторанного бизнеса, использующих информационную систему обучения и аттестации персонала.
Настоящий документ является руководством пользователя информационной системы «Система обучения и аттестации сотрудников ресторанного бизнеса».
Документ предназначен для сотрудников ресторанов, администраторов системы и руководителей подразделений.
Руководство содержит сведения о назначении программного продукта, требованиях к окружению, порядке работы с административной панелью и мобильным приложением, а также описание основных операций, выполняемых пользователями системы.
Назначение и условия применения
Настоящий документ предназначен для пользователей информационной системы «Система обучения и аттестации сотрудников ресторанного бизнеса» (далее — Система).
Система используется для организации обучения персонала ресторанов, управления учебными курсами, проведения аттестации сотрудников и контроля результатов обучения.
Доступ к системе осуществляется посредством административной web-панели и мобильного приложения.
Система обеспечивает выполнение следующих функций:
Для работы с системой пользователю достаточно обладать базовыми навыками использования компьютера или мобильного устройства.
Специальной технической подготовки не требуется.
Пользователь должен уметь:
Перед началом эксплуатации рекомендуется ознакомиться со следующими документами:
Программный продукт предназначен для автоматизации процессов обучения и аттестации сотрудников ресторанного бизнеса.
Основной задачей системы является централизованное хранение учебных материалов, организация обучения персонала, проведение тестирования и контроль результатов прохождения аттестации.
Использование системы позволяет:
Система состоит из двух основных компонентов:
Через мобильное приложение сотрудник получает доступ к назначенным курсам, базе знаний, тестированию и результатам обучения.
Через административную панель осуществляется управление пользователями, курсами, тестами, назначениями и аналитикой.
В системе предусмотрены три основные категории пользователей.
Сотрудник выполняет следующие действия:
Администратор выполняет следующие действия:
Руководитель выполняет следующие действия:
Система может использоваться при соблюдении следующих условий.
Для серверной части:
Рекомендуемая конфигурация:
Для рабочих мест пользователей:
Для серверной части:
Для административной панели:
Для мобильного приложения:
[!IMPORTANT] Установка серверной части выполняется администратором системы.
Для подготовки системы к эксплуатации необходимо выполнить следующие действия:
Административная панель публикуется на web-сервере в виде статических файлов.
Дополнительная установка на рабочие станции пользователей не требуется.
Для доступа достаточно открыть браузер и перейти по адресу системы.
Сотрудник устанавливает мобильное приложение на устройство под управлением Android или iOS.
После установки необходимо:
Перед началом эксплуатации рекомендуется выполнить следующие действия:
Перед началом работы необходимо убедиться, что устройство соответствует минимальным требованиям.
[!TIP] Для обеспечения стабильной работы рекомендуется использовать актуальные версии браузеров и операционных систем.
Перед началом работы рекомендуется проверить:
Доступ к системе предоставляется администратором.
Каждому пользователю выдаются:
От выбранной роли зависит набор доступных функций.
| Роль | Интерфейс |
|---|---|
| Сотрудник | Мобильное приложение |
| Администратор | Web-панель |
| Руководитель | Web-панель |
[!NOTE] Не рекомендуется передавать свои учетные данные другим пользователям.
Для начала работы необходимо пройти авторизацию.
Для входа выполните следующие действия:
Форма авторизации представлена ниже (см. Рисунок 1).
Рисунок 1 – Форма авторизации
После ввода учетных данных система выполняет их проверку.
При успешной авторизации пользователь получает доступ к функциям системы согласно своей роли.
Если данные введены неверно, отображается сообщение об ошибке.
[!WARNING] После нескольких неудачных попыток входа доступ к системе может быть временно ограничен.
После успешной авторизации администратор или руководитель попадает на главную страницу административной панели.
Главная страница административной панели представлена ниже (см. Рисунок 2).
Рисунок 2 – Главная страница административной панели
Интерфейс административной панели состоит из следующих элементов:
| Раздел | Назначение |
|---|---|
| Панель управления | Общая статистика |
| Сотрудники | Управление персоналом |
| Обучение | Управление курсами |
| Тесты | Создание тестов |
| Назначения | Назначение обучения |
| Аналитика | Просмотр статистики |
| Отчеты | Формирование отчетности |
| Настройки | Управление параметрами системы |
В разделе «Панель управления» отображаются:
После входа рекомендуется убедиться в корректной работе системы.
Для проверки необходимо:
Если все пункты выполнены успешно, система считается работоспособной.
Для завершения работы рекомендуется выполнить выход из учетной записи.
Для выхода необходимо:
После выхода пользователь перенаправляется на страницу авторизации.
[!IMPORTANT] На общих устройствах рекомендуется всегда выполнять выход из системы после завершения работы.
Раздел «Сотрудники» предназначен для просмотра и управления учетными записями работников ресторана.
Раздел «Сотрудники» представлен на Рисунке 3.
Рисунок 3 – Раздел «Сотрудники»
В разделе отображаются:
Для поиска используется строка поиска и система фильтрации.
Для просмотра подробной информации необходимо открыть карточку сотрудника.
Карточка сотрудника представлена на Рисунке 4.
Рисунок 4 – Карточка сотрудника
Карточка содержит:
Руководитель может использовать данный раздел для анализа эффективности обучения конкретного сотрудника.
Раздел «Обучение» предназначен для создания, редактирования и управления учебными курсами.
Учебный курс представляет собой набор материалов, которые сотрудник должен изучить перед прохождением аттестации или выполнением рабочих обязанностей.
Раздел «Обучение» представлен на Рисунке 5.
Рисунок 5 – Раздел «Обучение»
В списке курсов отображаются:
Для создания нового курса необходимо:
Форма создания курса представлена на Рисунке 6.
Рисунок 6 – Создание учебного курса
При создании курса необходимо указать:
Следующий пример демонстрирует обработчик API для создания нового учебного курса.
func CreateCourse(c *gin.Context) {
var course models.Course
if err := c.ShouldBindJSON(&course); err != nil {
c.JSON(http.StatusBadRequest, gin.H{
"error": "Некорректные данные",
})
return
}
if err := database.DB.Create(&course).Error; err != nil {
c.JSON(http.StatusInternalServerError, gin.H{
"error": "Ошибка создания курса",
})
return
}
c.JSON(http.StatusCreated, course)
}
Обработчик принимает данные курса, сохраняет их в базе данных PostgreSQL и возвращает созданную запись клиентскому приложению.
Курс может содержать:
[!NOTE] До публикации курс доступен только администраторам системы.
Для изменения курса необходимо:
После публикации курс может быть назначен сотрудникам.
Раздел «Тесты» используется для создания аттестаций и проверки знаний сотрудников.
Тесты могут быть связаны с конкретными учебными курсами.
Раздел «Тесты» представлен на Рисунке 7.
Рисунок 7 – Раздел «Тесты»
В списке тестов отображаются:
Для создания тестирования необходимо:
Форма создания теста представлена на Рисунке 8.
Рисунок 8 – Создание теста
При создании теста можно указать:
| Параметр | Описание |
|---|---|
| Название | Наименование тестирования |
| Курс | Связанный курс |
| Проходной балл | Минимальный процент успешного прохождения |
| Время | Ограничение по времени |
| Попытки | Максимальное количество попыток |
Система поддерживает следующие типы вопросов:
После завершения настройки тест публикуется и становится доступным для назначения сотрудникам.
[!IMPORTANT] Изменение опубликованного теста может повлиять на результаты последующих попыток прохождения.
Раздел «Назначения» используется для выдачи курсов сотрудникам и подразделениям.
Назначение определяет, кто должен пройти конкретный курс и в какие сроки.
Раздел «Назначения» представлен на Рисунке 9.
Рисунок 9 – Раздел «Назначения»
В разделе отображаются:
Для создания назначения необходимо:
Форма создания назначения представлена на Рисунке 10.
Рисунок 10 – Создание назначения курса
При создании назначения указываются:
Система поддерживает три варианта назначения:
[!WARNING] В рамках одного назначения допускается выбор только одного типа получателя.
После сохранения назначение автоматически становится доступным сотруднику в мобильном приложении.
Статусы прохождения:
| Статус | Описание |
|---|---|
| Назначено | Курс выдан сотруднику |
| В процессе | Изучение курса начато |
| Завершено | Курс успешно пройден |
| Просрочено | Истек срок прохождения |
Руководитель и администратор могут отслеживать выполнение назначений в режиме реального времени.
После успешной авторизации сотрудник получает доступ к основным функциям мобильного приложения.
Главный экран предоставляет быстрый доступ к курсам, тестированию, базе знаний и личному профилю.
Главный экран мобильного приложения представлен на Рисунке 11.
Рисунок 11 – Главный экран мобильного приложения
На главном экране отображаются:
| Раздел | Назначение |
|---|---|
| Главная | Основная информация и прогресс |
| Курсы | Список назначенных курсов |
| Тесты | Доступные экзамены и аттестации |
| База знаний | Учебные материалы |
| Профиль | Данные пользователя |
Для просмотра доступных курсов необходимо открыть раздел «Курсы».
Список курсов представлен на Рисунке 12.
Рисунок 12 – Список курсов в мобильном приложении
Для каждого курса отображается:
Для начала обучения необходимо выбрать курс из списка.
После выбора курса открывается его подробное описание.
Детальный экран курса представлен на Рисунке 13.
Рисунок 13 – Детальный экран курса
На экране отображаются:
Пользователь может последовательно изучать учебные модули и отслеживать прогресс обучения.
Для изучения материала необходимо открыть соответствующий модуль курса.
Просмотр учебного материала представлен на Рисунке 14.
Рисунок 14 – Просмотр учебного материала
Учебный материал может содержать:
[!TIP] Рекомендуется полностью изучить все материалы курса перед началом тестирования.
После завершения изучения пользователь может перейти к прохождению аттестации.
Тестирование используется для проверки усвоения учебного материала.
Для прохождения теста сотрудник открывает раздел «Тесты» или запускает тестирование непосредственно из курса.
В разделе отображаются все доступные сотруднику тестирования.
Список экзаменов представлен на Рисунке 15.
Рисунок 15 – Список экзаменов в мобильном приложении
Для каждого теста отображаются:
Для начала прохождения необходимо выбрать тест из списка.
Перед запуском теста отображается информационный экран.
Стартовый экран тестирования представлен на Рисунке 16.
Рисунок 16 – Стартовый экран тестирования
На стартовом экране отображаются:
Для запуска тестирования необходимо нажать кнопку «Начать тест».
[!IMPORTANT] После начала тестирования начинается отсчет времени прохождения.
После запуска открывается первый вопрос тестирования.
Экран вопроса теста представлен на Рисунке 17.
Рисунок 17 – Экран вопроса теста
Пользователь может:
После ответа необходимо перейти к следующему вопросу.
Во время прохождения тестирования система автоматически сохраняет ответы пользователя.
После завершения последнего вопроса выполняется автоматическая проверка.
Система рассчитывает:
После проверки отображается итоговый результат.
Результат прохождения тестирования представлен на Рисунке 18.
Рисунок 18 – Результат прохождения теста
На экране результата отображаются:
| Статус | Описание |
|---|---|
| Пройден | Результат равен или превышает проходной балл |
| Не пройден | Результат ниже установленного порога |
Если тест не пройден и остались доступные попытки, пользователь может пройти тестирование повторно.
[!NOTE] Все результаты сохраняются в системе и доступны для просмотра сотруднику, администратору и руководителю в рамках их прав доступа.
Раздел «Аналитика» предназначен для контроля эффективности обучения сотрудников и анализа результатов прохождения курсов и тестирований.
Доступ к разделу имеют администраторы и руководители.
Раздел аналитики представлен на Рисунке 19.
Рисунок 19 – Раздел «Аналитика»
В разделе отображаются:
Система позволяет:
Для более детального анализа доступны фильтры:
[!TIP] Использование фильтров позволяет быстро получать статистику по конкретному направлению обучения.
Раздел «Отчеты» предназначен для формирования итоговой документации по обучению персонала.
Раздел отчетов представлен на Рисунке 20.
Рисунок 20 – Раздел «Отчеты»
В разделе доступны следующие виды отчетов:
Для формирования отчета необходимо:
После обработки данных отчет становится доступным для просмотра или скачивания.
Каждый пользователь имеет доступ к своему профилю.
В профиле отображается информация об учетной записи и персональных данных.
Профиль пользователя представлен на Рисунке 21.
Рисунок 21 – Профиль сотрудника в мобильном приложении
В профиле отображаются:
Пользователь может:
Для администраторов дополнительно доступен раздел настроек системы.
Раздел настроек представлен на Рисунке 22.
Рисунок 22 – Настройки административной панели
Через данный раздел выполняется:
[!IMPORTANT] Изменение системных настроек доступно только пользователям с соответствующими правами.
Для завершения работы рекомендуется выполнять выход из учетной записи.
Это особенно важно при использовании общих или служебных устройств.
Выход из мобильного приложения представлен на Рисунке 23.
Рисунок 23 – Выход из мобильного приложения
Для выхода необходимо:
После завершения сеанса пользователь возвращается на экран авторизации.
В процессе эксплуатации могут возникать различные ошибки. В большинстве случаев система выводит понятное сообщение с описанием проблемы.
| Сообщение | Возможная причина | Решение |
|---|---|---|
| Неверный логин или пароль | Ошибка авторизации | Проверить введенные данные |
| Нет подключения к серверу | Проблемы сети | Проверить интернет-соединение |
| Ошибка загрузки данных | Недоступность сервера | Повторить попытку позже |
| Тестирование недоступно | Отсутствует назначение | Обратиться к администратору |
| Недостаточно прав | Ограничение роли | Выполнить вход под нужной учетной записью |
| Время прохождения истекло | Закончилось время теста | Начать новую попытку при наличии доступных попыток |
[!WARNING] При возникновении повторяющихся ошибок необходимо обратиться к администратору системы.
Для быстрого освоения системы рекомендуется придерживаться следующего порядка работы.
[!TIP] Рекомендуется периодически проверять актуальность учебных материалов и тестов.
| Сокращение | Расшифровка |
|---|---|
| API | Программный интерфейс приложения |
| БД | База данных |
| ИС | Информационная система |
| MVP | Минимально жизнеспособная версия продукта |
| ОС | Операционная система |
| ПП | Программный продукт |
| СУБД | Система управления базами данных |
| REST | Архитектурный стиль взаимодействия клиентской и серверной частей |
| JSON | Формат обмена данными |
| HTTPS | Защищенный протокол передачи данных |
| Go | Язык программирования серверной части |
| PostgreSQL | Система управления реляционными базами данных |
| Vue.js | Фреймворк для административной панели |
| Flutter | Фреймворк мобильного приложения |
| VPS | Виртуальный выделенный сервер |
По вопросам эксплуатации системы необходимо обращаться к администратору информационной системы.
При обращении рекомендуется указать:
| Версия | Дата | Автор | Описание изменений |
|---|---|---|---|
| 0.1 | 2026 | Вдовский И.О. | Первичная версия документа |
[!NOTE] Конец документа.