فهرست منبع

Change readme

shitsobu 1 هفته پیش
والد
کامیت
6c28c1080e
1فایلهای تغییر یافته به همراه106 افزوده شده و 47 حذف شده
  1. 106 47
      README.md

+ 106 - 47
README.md

@@ -1,70 +1,129 @@
-# Информационная система для формирования отчетности о правонарушениях студентов ПТК НовГУ
+# Информационная система «Гостиничный корпус»
 
-Информационная система предназначена для автоматизации учета правонарушений студентов Политехнического колледжа НовГУ, хранения информации о студентах, группах и совершенных нарушениях, а также формирования отчетности для администрации учебного заведения. Приложение разработано с использованием платформы .NET MAUI и базы данных PostreSQL.
+## Аннотация
+
+Информационная система «Гостиничный корпус» предназначена для автоматизации процессов управления гостиницей. Программа обеспечивает централизованное хранение информации о клиентах, бронированиях, номерах и туристических фирмах, а также предоставляет средства поиска, редактирования данных и формирования отчетов.
+
+Приложение разработано на платформе .NET MAUI и использует систему управления базами данных PostgreSQL. Для взаимодействия с базой данных применяется сервер приложений ASP.NET Core Web API. Развертывание системы осуществляется с помощью установщика, созданного в Inno Setup.
+
+---
 
 # Введение
 
-Основные возможности системы:
+Информационная система предназначена для автоматизации основных процессов работы гостиницы и уменьшения объема ручной обработки данных.
 
-* Ведение базы данных студентов и учебных групп.
-* Регистрация правонарушений студентов.
-* Хранение информации о видах нарушений.
-* Поиск студентов и нарушений.
-* Редактирование и удаление записей.
-* Формирование отчетов по нарушениям.
-* Авторизация пользователей с разграничением прав доступа.
+Основные возможности программы:
+
+- авторизация пользователей;
+- разграничение прав доступа (Администратор / Менеджер);
+- просмотр списка бронирований;
+- добавление, изменение и удаление бронирований;
+- ведение базы клиентов;
+- ведение базы туристических фирм;
+- просмотр информации о номерах гостиницы;
+- обновление рейтинга комнат;
+- поиск по фамилии клиента;
+- поиск по номеру комнаты;
+- формирование отчетов по бронированиям за выбранный период;
+- автоматический расчет итоговой стоимости проживания.
+
+---
 
 # Назначение и условия применения
 
-Система предназначена для сотрудников образовательной организации, осуществляющих учет дисциплинарных нарушений студентов.
+Информационная система предназначена для использования администраторами и менеджерами гостиницы при ведении базы данных клиентов, бронирований и гостиничных номеров.
+
+Для корректной работы программы необходимы:
 
-Для работы программы необходимы:
+- операционная система Windows 10 или Windows 11 (64-разрядная);
+- установленная СУБД PostgreSQL версии 14 и выше;
+- установленный .NET Runtime;
+- не менее 512 МБ оперативной памяти;
+- наличие базы данных гостиницы;
+- подключение к серверу базы данных PostgreSQL.
 
-* Операционная система Windows 10 или выше.
-* Установленное приложение.
-* Установленное .NET 10 
-* Доступ к базе данных PostgreSQL.
-* Минимум 4 ГБ оперативной памяти.
-* Не менее 200 МБ свободного места на диске.
+---
 
 # Установка
 
-1. Скачать установочный файл приложения.
-2. Запустить `Setup_PM11.exe`.
-3. Следовать инструкциям мастера установки.
-4. Дождаться завершения установки.
-5. Запустить приложение через ярлык на рабочем столе или из меню «Пуск».
+1. Скачать файл **Setup_MP11.exe**.
+2. Запустить установщик от имени администратора.
+3. Следовать указаниям мастера установки.
+4. Выбрать каталог установки программы.
+5. Дождаться окончания копирования файлов.
+6. Завершить установку.
+7. Запустить приложение.
 
-Контроль выполнения установки:
+### Контроль выполнения установки
 
-* [x] Скачан установочный файл.
-* [x] Выполнена установка программы.
-* [x] Создан ярлык приложения.
-* [x] Приложение успешно запускается.
+- [ ] Установщик завершил работу без ошибок.
+- [ ] Создан ярлык на рабочем столе.
+- [ ] Создан ярлык в меню «Пуск».
+- [ ] Приложение успешно запускается.
+- [ ] Выполняется подключение к базе данных PostgreSQL.
+
+---
 
 # Описание операций
 
-После запуска пользователю необходимо выполнить вход в систему.
+После запуска программы пользователь проходит авторизацию, выбрав необходимую роль.
+
+## Авторизация
+
+Пользователь вводит учетные данные и входит в систему в роли администратора либо менеджера.
+
+## Работа с бронированиями
+
+Система позволяет:
+
+- просматривать список бронирований;
+- создавать новые бронирования;
+- изменять существующие записи;
+- удалять бронирования (для администратора);
+- выполнять поиск по клиенту или номеру комнаты.
+
+## Работа с клиентами
+
+Пользователь может:
+
+- добавлять клиентов;
+- редактировать информацию;
+- удалять записи (при наличии соответствующих прав);
+- выполнять поиск по фамилии и номеру телефона.
+
+## Работа с комнатами
+
+Предусмотрены:
+
+- просмотр информации о номерах;
+- просмотр вместимости;
+- просмотр типа комнаты;
+- обновление рейтинга комнат.
+
+## Формирование отчетов
+
+Программа формирует отчет по бронированиям за выбранный период.
+
+Отчет содержит:
 
-Возможности программы:
+- сведения о клиентах;
+- информацию о бронированиях;
+- стоимость проживания;
+- итоговую сумму.
 
-* авторизация пользователя;
-* просмотр списка студентов;
-* добавление, изменение и удаление студентов;
-* управление учебными группами;
-* регистрация правонарушений;
-* просмотр информации о совершенных нарушениях;
-* поиск данных;
-* формирование отчетов о правонарушениях студентов.
+---
 
 # Термины и сокращения
 
-| Термин         | Описание                                                                  |
-| -------------- | ------------------------------------------------------------------------- |
-| ИС             | Информационная система                                                    |
-| ПТК            | Политехнический колледж                                                   |
-| НовГУ          | Новгородский государственный университет                                  |
-| PostgreSQL     | Cистема управления базами данных                                          |
-| .NET MAUI      | Платформа для разработки кроссплатформенных приложений                    |
-| Пользователь   | Сотрудник, работающий с системой                                          |
-| Правонарушение | Зарегистрированный факт нарушения студентом правил внутреннего распорядка |
+| Термин | Определение |
+|---------|-------------|
+| Гостиничный корпус | Информационная система управления гостиницей |
+| Инсталлятор | Установочный файл Setup_MP11.exe |
+| PostgreSQL | Система управления реляционными базами данных |
+| .NET MAUI | Платформа разработки кроссплатформенных приложений |
+| ASP.NET Core Web API | Сервер приложений для обработки запросов клиента |
+| Администратор | Пользователь с полным набором прав |
+| Менеджер | Пользователь с ограниченными правами |
+| Бронирование | Запись о резервировании гостиничного номера |
+| Клиент | Лицо, осуществляющее бронирование номера |
+| Inno Setup | Программа для создания установщиков Windows |