From 043b14b65fb698cda758888dd61369086bba2345 Mon Sep 17 00:00:00 2001 From: Nikolay Vigdorov Date: Mon, 12 Jan 2026 22:55:12 +0300 Subject: [PATCH] fix style --- BUSINESS_REQUIREMENTS.md | 191 ++++++++++++++++++++++++--------------- NOTIONS.md | 16 ++++ 2 files changed, 132 insertions(+), 75 deletions(-) create mode 100644 NOTIONS.md diff --git a/BUSINESS_REQUIREMENTS.md b/BUSINESS_REQUIREMENTS.md index 3d8c4c7..24b012b 100644 --- a/BUSINESS_REQUIREMENTS.md +++ b/BUSINESS_REQUIREMENTS.md @@ -1,107 +1,148 @@ -MVP «Таск-менеджер для сотрудников отеля HotelTask». -Платформа, состоящая из ряда сервисов, которые решают повседневные задачи, эффективно распределяют ресурсы объекта размещения, а так же предоставляют аналитику для улучшения. +# HotelTask - Бизнес-требования +> **MVP** — Таск-менеджер для сотрудников отеля. +> Платформа, состоящая из ряда сервисов, которые решают повседневные задачи, эффективно распределяют ресурсы объекта размещения, а также предоставляют аналитику для улучшения. + +--- + +## 1. Пользователи и роли -Пользователи Система должна поддерживать следующие роли: -Администратор системы -- управление пользователями -- настройка ролей и прав доступа -- просмотр всех задач и отчетов +### Администратор системы +- Управление пользователями +- Настройка ролей и прав доступа +- Просмотр всех задач и отчетов -Менеджер / Супервайзер -- создание и распределение задач -- контроль статусов выполнения -- приоритизация задач +### Менеджер / Супервайзер +- Создание и распределение задач +- Контроль статусов выполнения +- Приоритизация задач -Линейный сотрудник -- просмотр назначенных задач -- изменение статуса задачи -- добавление комментариев и отметок о выполнении +### Линейный сотрудник +- Просмотр назначенных задач +- Изменение статуса задачи +- Добавление комментариев и отметок о выполнении -API интерфейс -- постановка задач для сотрудников -- изменение статуса задачи +### API-интерфейс +- Постановка задач для сотрудников +- Изменение статуса задачи +--- + +## 2. Управление пользователями -Управление пользователями Система должна обеспечивать: -- регистрацию и авторизацию пользователей -- назначение ролей пользователям -- редактирование профиля пользователя -- деактивацию пользователей +- Регистрацию и авторизацию пользователей +- Назначение ролей пользователям +- Редактирование профиля пользователя +- Деактивацию пользователей +--- -Управление задачами -Система должна позволять пользователям cоздавать задачу с указанием: -- названия -- описания -- типа задачи (уборка, ремонт, обслуживание гостей и т. д.) -- приоритета (низкий / средний / высокий / срочный) -- срока выполнения -- ответственного сотрудника -- ответственный супервайзер -- приоритетность +## 3. Управление задачами -а также иметь возможность: -- редактировать задачу -- удалять задачу (при наличии прав) -- назначать и переназначать исполнителей -- включать трекинг времени задачи, +### Создание задачи +Система должна позволять создавать задачу с указанием: -Система должна поддерживать следующие статусы: -- новая -- в работе -- ожидает -- выполнена -- пауза -- отменена -Сотрудник должен иметь возможность менять статус своих задач. +| Поле | Описание | +|------|----------| +| **Название** | Краткое название задачи | +| **Описание** | Детальное описание задачи | +| **Тип задачи** | Уборка, ремонт, обслуживание гостей и т.д. | +| **Приоритет** | Низкий / Средний / Высокий / Срочный | +| **Срок выполнения** | Дедлайн задачи | +| **Исполнитель** | Ответственный сотрудник | +| **Супервайзер** | Ответственный менеджер | +### Операции с задачами -Уведомления -Система должна с помощью push уведомлений: -- уведомлять сотрудника о назначении новой задачи -- уведомлять менеджера о завершении задачи -- отправлять напоминания о приближении срока выполнения +- Редактировать задачу +- Удалять задачу *(при наличии прав)* +- Назначать и переназначать исполнителей +- Включать трекинг времени задачи +### Статусы задач + +| Статус | Описание | +|--------|----------| +| **Новая** | Задача создана, ожидает выполнения | +| **В работе** | Сотрудник приступил к выполнению | +| **Ожидает** | Задача приостановлена (ждет чего-то) | +| **Выполнена** | Задача завершена | +| **Пауза** | Временно отложена | +| **Отменена** | Задача отменена | + +> Сотрудник должен иметь возможность менять статус своих задач. + +--- + +## 4. Уведомления + +Система должна отправлять **push-уведомления**: +- Сотруднику — о назначении новой задачи +- Менеджеру — о завершении задачи +- Напоминания — о приближении срока выполнения + +--- + +## 5. Комментарии и вложения - Комментарии и вложения Система должна позволять: -- добавлять комментарии к задачам -- прикреплять фотографии или файлы (например, фото выполненной уборки -- просматривать историю изменений задачи +- Добавлять комментарии к задачам +- Прикреплять фотографии или файлы *(например, фото выполненной уборки)* +- Просматривать историю изменений задачи +--- + +## 6. Поиск и фильтрация -Поиск и фильтрация Система должна обеспечивать: -- поиск задач по названию и описанию -- фильтрацию по: статусу, приоритету, сотруднику, дате выполнения, типу задачи +**Поиск:** +- По названию задачи +- По описанию задачи + +**Фильтрация:** +- По статусу +- По приоритету +- По сотруднику +- По дате выполнения +- По типу задачи + +--- + +## 7. Отчеты и аналитика -Отчеты и аналитика Система должна предоставлять: -- отчет по выполненным задачам за период -- статистику по сотрудникам -- статистику по типам задач -- процент просроченных задач +- Отчет по выполненным задачам за период +- Статистику по сотрудникам +- Статистику по типам задач +- Процент просроченных задач +--- +## 8. Доступ с разных устройств -Доступ с разных устройств Система должна: -- корректно работать в веб-браузере -- поддерживать мобильные устройства (адаптивный интерфейс) -- app +- Корректно работать в веб-браузере +- Поддерживать мобильные устройства *(адаптивный интерфейс)* +- Иметь мобильное приложение +--- -Интеграции -Система должна взаимодействовать с внешнеими PMS: -- получать бронирования с информацией о гостях и номер -- получать статус номера -- изменять статус номера -Система должна взаимодействовать с Консьерж Resonline: -- получать данные в нужный номер с информацией о заказе -- передавать статус заказа +## 9. Интеграции + +### PMS (Property Management System) + +Система должна взаимодействовать с внешними PMS: +- Получать бронирования с информацией о гостях и номерах +- Получать статус номера +- Изменять статус номера + +### Консьерж Resonline + +Система должна взаимодействовать с сервисом Консьерж Resonline: +- Получать данные о заказе в номер +- Передавать статус заказа diff --git a/NOTIONS.md b/NOTIONS.md new file mode 100644 index 0000000..7fafb5f --- /dev/null +++ b/NOTIONS.md @@ -0,0 +1,16 @@ +Проработка: +- Прототипы интерфейсов +- Контракты API (swagger) +- Пользовательские сценарии (use cases) +- Sequence диаграммы +- Сервис лицензий, или какой-то способ модульной поставки сервисов? Может с помощью helm чартов? +- UI спецификация? Обработка ошибок на UI +- Система логирования бека, фронта, дебагинг, мониторинг, алертнинг +- Схема деплоя. Ставимся в кластер? А что если нет кластера? Как упаковывать коробку? +- Аналитика фичей по отдельности, разделить MVP на небольшие кусочки, поставлять фичи этапами +- Нагрузочное тестирование + + +Вопросы от Леши: +- Оценка временных затрат +- Оценка денежных затрат (человеческий ресурс от минимум до комфорт, дать диапазон с ролями, стоимостью по сотрудникам) \ No newline at end of file