|
|
@@ -0,0 +1,428 @@
|
|
|
+# ИНФОРМАЦИОННАЯ СИСТЕМА
|
|
|
+
|
|
|
+# КАРШЕРИНГА
|
|
|
+
|
|
|
+РАБОЧАЯ ДОКУМЕНТАЦИЯ
|
|
|
+
|
|
|
+Руководство пользователся
|
|
|
+
|
|
|
+Листов – 16
|
|
|
+
|
|
|
+Великий Новгород, 2026
|
|
|
+
|
|
|
+Контакт автора: [Telegram](https://t.me/Dan_zxqwerty)
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Аннотация
|
|
|
+
|
|
|
+Настоящий документ представляет собой руководство пользователя информационной веб-системы каршеринга.
|
|
|
+
|
|
|
+Руководство предназначено для пользователей и администраторов системы и описывает порядок работы с веб-приложением: регистрацию и авторизацию, поиск автомобилей, оформление бронирования, управление поездками, просмотр истории поездок, получение чеков, а также выполнение административных операций.
|
|
|
+
|
|
|
+**Перед началом работы с системой рекомендуется ознакомиться с настоящим руководством.**
|
|
|
+
|
|
|
+<details>
|
|
|
+<summary>Цитата о пользовательской документации</summary>
|
|
|
+
|
|
|
+> Руководство пользователя должно помогать выполнить операцию без обращения к разработчику.
|
|
|
+>
|
|
|
+> > Для CarShare это путь от регистрации до получения электронного чека.
|
|
|
+
|
|
|
+</details>
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Содержание
|
|
|
+
|
|
|
+| Раздел | Стр. |
|
|
|
+| :--- | ---: |
|
|
|
+| Аннотация | 2 |
|
|
|
+| 1. Введение | 4 |
|
|
|
+| 1.1. Область применения | 4 |
|
|
|
+| 1.2. Краткое описание возможностей | 4 |
|
|
|
+| 1.3. Уровень подготовки пользователя | 5 |
|
|
|
+| 1.4. Список обозначений и сокращений | 6 |
|
|
|
+| 2. Назначение и условия применения | 7 |
|
|
|
+| 2.1. Назначение системы | 7 |
|
|
|
+| 2.2. Условия применения | 7 |
|
|
|
+| 3. Подготовка к работе | 7 |
|
|
|
+| 3.1. Запуск системы | 7 |
|
|
|
+| 3.2. Проверка работоспособности | 8 |
|
|
|
+| 4. Описание операций | 9 |
|
|
|
+| 4.1. Регистрация пользователя | 9 |
|
|
|
+| 4.2. Вход в систему | 9 |
|
|
|
+| 4.3. Просмотр каталога автомобилей | 9 |
|
|
|
+| 4.4. Поиск и фильтрация автомобилей | 10 |
|
|
|
+| 4.5. Просмотр карточки автомобиля | 11 |
|
|
|
+| 4.6. Оформление бронирования | 12 |
|
|
|
+| 4.7. Управление активной поездкой | 12 |
|
|
|
+| 4.8. Завершение поездки | 13 |
|
|
|
+| 4.9. Просмотр истории поездок | 13 |
|
|
|
+| 4.10. Просмотр и получение чека | 14 |
|
|
|
+| 4.11. Оставление отзыва | 14 |
|
|
|
+| 5. Возможные ошибки и рекомендации по устранению | 16 |
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# 1. Введение
|
|
|
+
|
|
|
+## 1.1. Область применения
|
|
|
+
|
|
|
+Информационная веб-система каршеринга предназначена для автоматизации процессов краткосрочной и длительной аренды автомобилей.
|
|
|
+
|
|
|
+Система применяется для организации взаимодействия между пользователями сервиса каршеринга и администраторами, обеспечивающими управление автомобилями, категориями, бронированиями, тарифами и пользовательскими данными.
|
|
|
+
|
|
|
+С помощью системы пользователь может выбрать подходящий автомобиль, оформить аренду, отслеживать статус бронирования, завершать поездку, просматривать историю поездок и получать электронные чеки.
|
|
|
+
|
|
|
+## 1.2. Краткое описание возможностей
|
|
|
+
|
|
|
+Система обеспечивает выполнение следующих основных функций:
|
|
|
+
|
|
|
+- регистрация и авторизация пользователей;
|
|
|
+- просмотр доступных автомобилей в каталоге;
|
|
|
+- отображение автомобилей в виде списка или на карте;
|
|
|
+- поиск автомобилей по категории, цвету, комплектации и другим параметрам;
|
|
|
+- просмотр подробной информации об автомобиле;
|
|
|
+- выбор дополнительных опций при бронировании;
|
|
|
+- оформление аренды автомобиля на оропределенный срок;
|
|
|
+- расчет стоимости поездки по выбранному тарифу;
|
|
|
+- хранение информации об активных и завершенных бронированиях;
|
|
|
+- автоматическое формирование чека после завершения поездки;
|
|
|
+- просмотр истории поездок;
|
|
|
+- добавление отзывов об автомобиле или сервисе;
|
|
|
+- административное управление пользователями, автомобилями, тарифами и бронированиями.
|
|
|
+
|
|
|
+## 1.3. Уровень подготовки пользователя
|
|
|
+
|
|
|
+В системе предусмотрены следующие роли:
|
|
|
+
|
|
|
+- Пользователь.
|
|
|
+- Администратор.
|
|
|
+
|
|
|
+Пользователь должен уметь:
|
|
|
+
|
|
|
+- иметь общие сведения о системе и ее назначении;;
|
|
|
+- владеть информацией об ИС каршеринга в объеме эксплуатационной документации.
|
|
|
+
|
|
|
+Администратор должен дополнительно уметь:
|
|
|
+
|
|
|
+- иметь общие сведения о системе и ее назначении;;
|
|
|
+- владеть информацией об ИС каршеринга в объеме ксплуатационной документации;
|
|
|
+- владеть информацией о работе в административном интерфейсе ИС каршеринга.
|
|
|
+
|
|
|
+## 1.4. Список обозначений и сокращений
|
|
|
+
|
|
|
+| Обозначение | Расшифровка |
|
|
|
+| :--- | :--- |
|
|
|
+| ИС | Информационная система |
|
|
|
+| Система | Информационная веб-система каршеринга |
|
|
|
+| Пользователь | Клиент сервиса каршеринга |
|
|
|
+| Администратор | Пользователь с расширенными правами управления системой |
|
|
|
+| Бронирование | Предварительное оформление аренды автомобиля |
|
|
|
+| Поездка | Фактическое использование автомобиля пользователем |
|
|
|
+| Тариф | Условия расчета стоимости аренды |
|
|
|
+| Чек | Электронный документ с информацией о завершенной поездке и ее стоимости |
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# 2. Назначение и условия применения
|
|
|
+
|
|
|
+## 2.1. Назначение системы
|
|
|
+
|
|
|
+Информационная веб-система каршеринга предназначена для предоставления пользователям возможности аренды автомобилей через веб-приложение.
|
|
|
+
|
|
|
+Система позволяет:
|
|
|
+
|
|
|
+- упростить процесс поиска и выбора автомобиля;
|
|
|
+- автоматизировать оформление аренды;
|
|
|
+- обеспечить учет активных и завершенных бронирований;
|
|
|
+- предоставить пользователю доступ к истории поездок;
|
|
|
+- автоматически формировать чек после завершения поездки;
|
|
|
+- обеспечить администратору удобные средства управления данными сервиса.
|
|
|
+
|
|
|
+Основная цель системы — обеспечить удобное взаимодействие пользователя с сервисом каршеринга и автоматизировать ключевые процессы аренды автомобилей.
|
|
|
+
|
|
|
+## 2.2. Условия применения
|
|
|
+
|
|
|
+ИС каршеринга может эксплуатироваться и выполнять заданные функции при соблюдении требований предъявляемых к техническому, системному и прикладному программному обеспечению.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# 3. Подготовка к работе
|
|
|
+
|
|
|
+## 3.1. Запуск системы
|
|
|
+
|
|
|
+Для запуска системы необходимо:
|
|
|
+
|
|
|
+1. Открыть веб-браузер.
|
|
|
+2. В адресной строке ввести адрес веб-приложения.
|
|
|
+3. Дождаться загрузки стартовой страницы системы.
|
|
|
+
|
|
|
+## 3.2. Проверка работоспособности
|
|
|
+
|
|
|
+Проверка работоспособности системы может быть выполнена путем выполнения основных пользовательских операций, описанных разделе 4 настоящего документа.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# 4. Описание операций
|
|
|
+
|
|
|
+Пример фрагмента исходного кода, относящегося к оформлению бронирования:
|
|
|
+
|
|
|
+```tsx
|
|
|
+function book() {
|
|
|
+ if (!user) {
|
|
|
+ navigate('/login', { state: { from: location.pathname } });
|
|
|
+ return;
|
|
|
+ }
|
|
|
+
|
|
|
+ if (isAdmin) {
|
|
|
+ return;
|
|
|
+ }
|
|
|
+
|
|
|
+ createBooking.mutate();
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+Изображения, демонстрирующие работу приложения:
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+## 4.1. Регистрация пользователя
|
|
|
+
|
|
|
+Регистрация необходима для получения доступа к функциям бронирования автомобилей и просмотра личной информации.
|
|
|
+
|
|
|
+Для регистрации необходимо:
|
|
|
+
|
|
|
+1. Открыть страницу регистрации.
|
|
|
+2. Ввести фамилию, имя и контактные данные.
|
|
|
+3. Указать адрес электронной почты или номер телефона.
|
|
|
+4. Создать пароль.
|
|
|
+5. Подтвердить согласие с правилами использования сервиса.
|
|
|
+6. Нажать кнопку регистрации.
|
|
|
+
|
|
|
+После успешной регистрации пользователь может выполнить вход в систему.
|
|
|
+
|
|
|
+## 4.2. Вход в систему
|
|
|
+
|
|
|
+Для входа в систему необходимо:
|
|
|
+
|
|
|
+1. Открыть страницу авторизации.
|
|
|
+2. Ввести логин, адрес электронной почты или номер телефона.
|
|
|
+3. Ввести пароль.
|
|
|
+4. Нажать кнопку входа.
|
|
|
+
|
|
|
+После успешной авторизации пользователь получает доступ к каталогу автомобилей, личному кабинету, истории поездок и бронированиям.
|
|
|
+
|
|
|
+## 4.3. Просмотр каталога автомобилей
|
|
|
+
|
|
|
+Каталог автомобилей предназначен для выбора автомобиля, доступного для аренды.
|
|
|
+
|
|
|
+В каталоге отображается следующая информация:
|
|
|
+
|
|
|
+- марка и модель автомобиля;
|
|
|
+- категория автомобиля;
|
|
|
+- цвет;
|
|
|
+- комплектация;
|
|
|
+- стоимость аренды;
|
|
|
+- статус доступности;
|
|
|
+- местоположение автомобиля;
|
|
|
+- краткое описание.
|
|
|
+
|
|
|
+Пользователь может просматривать автомобили в виде списка или на карте.
|
|
|
+
|
|
|
+Для просмотра каталога необходимо:
|
|
|
+
|
|
|
+1. Авторизоваться в системе.
|
|
|
+2. Перейти в раздел каталога автомобилей.
|
|
|
+3. Ознакомиться со списком доступных автомобилей.
|
|
|
+4. Выбрать интересующий автомобиль для просмотра подробной информации.
|
|
|
+
|
|
|
+## 4.4. Поиск и фильтрация автомобилей
|
|
|
+
|
|
|
+Для быстрого выбора подходящего автомобиля пользователь может использовать поиск и фильтры.
|
|
|
+
|
|
|
+Доступные параметры фильтрации могут включать:
|
|
|
+
|
|
|
+- категорию автомобиля;
|
|
|
+- марку и модель;
|
|
|
+- цвет;
|
|
|
+- тип двигателя;
|
|
|
+- комплектацию;
|
|
|
+- стоимость аренды;
|
|
|
+- наличие дополнительных опций;
|
|
|
+- местоположение автомобиля;
|
|
|
+- статус доступности.
|
|
|
+
|
|
|
+Для поиска автомобиля необходимо:
|
|
|
+
|
|
|
+1. Открыть каталог автомобилей.
|
|
|
+2. Указать необходимые параметры поиска.
|
|
|
+3. Применить фильтр.
|
|
|
+4. Просмотреть список автомобилей, соответствующих заданным параметрам.
|
|
|
+5. Выбрать подходящий автомобиль.
|
|
|
+
|
|
|
+## 4.5. Просмотр карточки автомобиля
|
|
|
+
|
|
|
+Карточка автомобиля содержит подробную информацию о выбранном автомобиле.
|
|
|
+
|
|
|
+В карточке могут отображаться:
|
|
|
+
|
|
|
+- марка и модель;
|
|
|
+- категория;
|
|
|
+- цвет;
|
|
|
+- комплектация;
|
|
|
+- тип топлива или двигателя;
|
|
|
+- государственный номер;
|
|
|
+- тарифы аренды;
|
|
|
+- доступные дополнительные опции;
|
|
|
+- местоположение;
|
|
|
+- рейтинг и отзывы пользователей;
|
|
|
+- текущий статус автомобиля.
|
|
|
+
|
|
|
+Для просмотра карточки автомобиля необходимо:
|
|
|
+
|
|
|
+1. Перейти в каталог автомобилей.
|
|
|
+2. Выбрать интересующий автомобиль.
|
|
|
+3. Открыть подробную информацию.
|
|
|
+4. Ознакомиться с характеристиками и условиями аренды.
|
|
|
+
|
|
|
+После просмотра карточки пользователь может перейти к оформлению бронирования.
|
|
|
+
|
|
|
+## 4.6. Оформление бронирования
|
|
|
+
|
|
|
+Бронирование позволяет пользователю заранее выбрать автомобиль и указать условия аренды.
|
|
|
+
|
|
|
+Для оформления бронирования необходимо:
|
|
|
+
|
|
|
+1. Открыть карточку выбранного автомобиля.
|
|
|
+2. Нажать кнопку оформления бронирования.
|
|
|
+3. Указать дату и время начала аренды.
|
|
|
+4. Выбрать длительность аренды: поминутную, почасовую, суточную или длительную.
|
|
|
+5. При необходимости выбрать дополнительные опции.
|
|
|
+6. Проверить предварительную стоимость.
|
|
|
+7. Подтвердить бронирование.
|
|
|
+
|
|
|
+К дополнительным опциям могут относиться:
|
|
|
+
|
|
|
+- детское кресло;
|
|
|
+- отложенный старт бронирования;
|
|
|
+- доставка автомобиля;
|
|
|
+- расширенная комплектация или дополнительные услуги.
|
|
|
+
|
|
|
+## 4.7. Управление активной поездкой
|
|
|
+
|
|
|
+После начала аренды бронирование переходит в статус активной поездки.
|
|
|
+
|
|
|
+В разделе активной поездки пользователь может просматривать:
|
|
|
+
|
|
|
+- выбранный автомобиль;
|
|
|
+- время начала аренды;
|
|
|
+- текущую длительность поездки;
|
|
|
+- предварительную стоимость;
|
|
|
+- выбранные дополнительные опции;
|
|
|
+- статус поездки.
|
|
|
+
|
|
|
+Во время активной поездки пользователь может отслеживать информацию об аренде и при необходимости завершить поездку.
|
|
|
+
|
|
|
+## 4.8. Завершение поездки
|
|
|
+
|
|
|
+После окончания использования автомобиля пользователь должен завершить поездку в системе.
|
|
|
+
|
|
|
+Для завершения поездки необходимо:
|
|
|
+
|
|
|
+1. Перейти в раздел активной поездки.
|
|
|
+2. Проверить сведения об автомобиле и времени аренды.
|
|
|
+3. Нажать кнопку завершения поездки.
|
|
|
+4. Подтвердить завершение.
|
|
|
+5. Дождаться расчета итоговой стоимости.
|
|
|
+
|
|
|
+После завершения поездки система изменяет статус бронирования на завершенный и автоматически формирует чек.
|
|
|
+
|
|
|
+## 4.9. Просмотр истории поездок
|
|
|
+
|
|
|
+История поездок содержит сведения обо всех завершенных и активных бронированиях пользователя.
|
|
|
+
|
|
|
+В истории поездок отображается:
|
|
|
+
|
|
|
+- дата поездки;
|
|
|
+- автомобиль;
|
|
|
+- длительность аренды;
|
|
|
+- итоговая стоимость;
|
|
|
+- статус поездки;
|
|
|
+- доступ к электронному чеку.
|
|
|
+
|
|
|
+Для просмотра истории поездок необходимо:
|
|
|
+
|
|
|
+1. Авторизоваться в системе.
|
|
|
+2. Перейти в личный кабинет.
|
|
|
+3. Открыть раздел истории поездок.
|
|
|
+4. Выбрать нужную поездку для просмотра подробной информации.
|
|
|
+
|
|
|
+## 4.10. Просмотр и получение чека
|
|
|
+
|
|
|
+После завершения каждой поездки система автоматически формирует чек.
|
|
|
+
|
|
|
+Чек содержит:
|
|
|
+
|
|
|
+- номер поездки;
|
|
|
+- дату и время начала аренды;
|
|
|
+- дату и время завершения аренды;
|
|
|
+- марку и модель автомобиля;
|
|
|
+- тариф;
|
|
|
+- длительность поездки;
|
|
|
+- выбранные дополнительные опции;
|
|
|
+- итоговую стоимость;
|
|
|
+- статус оплаты.
|
|
|
+
|
|
|
+Для просмотра чека необходимо:
|
|
|
+
|
|
|
+1. Перейти в раздел истории поездок.
|
|
|
+2. Выбрать завершенную поездку.
|
|
|
+3. Нажать кнопку просмотра чека.
|
|
|
+4. Ознакомиться с информацией о поездке и стоимости.
|
|
|
+
|
|
|
+## 4.11. Оставление отзыва
|
|
|
+
|
|
|
+Для добавления отзыва необходимо:
|
|
|
+
|
|
|
+1. Перейти в историю поездок.
|
|
|
+2. Выбрать завершенную поездку.
|
|
|
+3. Открыть форму добавления отзыва.
|
|
|
+4. Указать оценку автомобиля или сервиса.
|
|
|
+5. Ввести текст отзыва.
|
|
|
+6. Сохранить отзыв.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# 5. Возможные ошибки и рекомендации по устранению
|
|
|
+
|
|
|
+| Описание ошибки | Рекомендации по устранению |
|
|
|
+| :--- | :--- |
|
|
|
+| Пользователь не может войти в систему | Проверить корректность ввода данных и повторить попытку |
|
|
|
+| Пользователь забыл пароль | Воспользоваться восстановлением пароля или обратиться к администратору |
|
|
|
+| Каталог автомобилей не загружается | Проверить подключение к интернету, обновить страницу, повторить попытку позже |
|
|
|
+| Автомобиль не отображается в списке | Сбросить фильтры или изменить параметры поиска |
|
|
|
+| Невозможно оформить бронирование | Выбрать другой автомобиль или изменить время аренды |
|
|
|
+| Не рассчитывается стоимость поездки | Проверить дату, время, тариф и выбранные опции |
|
|
|
+| Не удается завершить поездку | Обновить страницу и повторить действие |
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+# Справочная информация
|
|
|
+
|
|
|
+| Материал | Назначение | Адрес |
|
|
|
+| :--- | :---: | ---: |
|
|
|
+| Руководство пользователя | Исходный документ Word | `Руководство пользователя.docx` |
|
|
|
+| API проекта | Справка по серверному API | [docs/API.md][api-doc] |
|
|
|
+| Архитектура проекта | Описание frontend и backend | [docs/ARCHITECTURE.md][architecture-doc] |
|
|
|
+| Markdown | Справка по синтаксису Markdown | [Doka Guide][markdown-doc] |
|
|
|
+
|
|
|
+[telegram-contact]: https://t.me/Dan_GH_str
|
|
|
+[api-doc]: docs/API.md
|
|
|
+[architecture-doc]: docs/ARCHITECTURE.md
|
|
|
+[markdown-doc]: https://doka.guide/tools/markdown/
|
