aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md146
-rw-r--r--docs/images/database.pngbin0 -> 217662 bytes
-rw-r--r--docs/images/pages.pngbin0 -> 224656 bytes
3 files changed, 146 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..fa908e0
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,146 @@
+# Складской учет
+
+## Принятое именование
+
+- Операция - поставка или выдача
+- Клиент / партнер - поставщик или получатель
+
+## Описание страниц
+
+![pages](./images/pages.png)
+
+У всех страниц сверху есть навигационная панель, позволяющая вернуться на главную страницу или любую другую страницу со списком информации (товары, клиенты, хранение).
+
+### Главная страница
+
+- Список всех операций. Каждая операция представляется:
+ - Номер операции
+ - Тип операции
+ - Статус операции
+ - Название партнера (кликабельно для перехода на страницу партнера)
+- Форма фильтрации операций
+ - По типу (dropdown)
+ - По статусу (dropdown)
+ - По включению какого-то товара (по названию или по ID ?)
+ - По партнеру (по названию)
+- Кнопка создания новой операции
+
+### Страница просмотра информации об операции
+
+- Просмотр информации
+ - Информация о клиенте (Название, ИНН), переход к клиенту ссылкой по имени
+ - Информация об ответственном лице (Имя Фамилия, почта, телефон, должность)
+ - Список товаров (Название, количество товара)
+ - Статус операции (Формирование, Сборка/Отгрузка, Выполнена, Отменена, Согласование)
+ - Информация о местах хранения, выданных под текущую операцию (откуда брать товар/куда складывать)
+ Показывается автоматически в статусе Сборка/Отгрузка
+- Изменение операции (кнопка, включающая режим изменения. повторное нажатие - сохранение изменений)
+ - Добавление/удаление товаров, если статус позволяет
+ - Изменение статуса
+ - Изменение отвественного лица
+
+### Список клиентов
+
+- Список
+ - Название клиента
+ - ИНН
+ - Вид (поставщик/получатель)
+ - Адрес
+- Форма фильтрации
+ - По виду
+ - По имени
+ - По ИНН
+- Кнопка создания нового клиента
+
+### Страница просмотра информации о клиенте
+
+- Форма информации
+ - Название клиента
+ - ИНН
+ - Вид
+ - Адрес
+ - Контактные лица
+ - ФИ
+ - Email
+ - Телефон
+ - Должность
+- Кнопка редактирования-сохранения, включающая-выключающая режим изменения
+- Кнопка перехода к операциям данного клиента
+
+### Список товаров
+
+- Список
+ - Название
+ - Габариты
+- Форма фильтрации
+ - По названию
+ - По габаритам (от-до по каждому измерению)
+- Кнопка создания нового товара
+
+### Страница товара
+
+- Информация
+ - Название
+ - Габариты
+ - Срок хранения
+- Кнопка редактирования-сохранения
+- Кнопка перехода к списку хранимого товара с фильтром по данному
+- Кнопка перехода к списку операций с фильтром по данному
+
+### Список хранимых товаров
+
+- Список
+ - Название продукта, кликабельно для перехода на товар
+ - Локация
+ - Количество
+ - Время размещения
+ - Статус хранения
+- Фильтр
+ - По продукту (по названию)
+ - По статусу размещения
+
+### Список ячеек хранения
+
+- Список ячеек
+ - Номер ячейки
+ - Локация ячейки
+ - Габариты
+- Кнопка создания новой ячейки
+
+### Управление ячейкой хранения
+
+- Информация о ячейке
+ - Локация
+ - Габариты
+- Кнопка редактирования-сохранения
+
+## Сценарии использования
+
+### Добавление товара (клиента, ячейки хранения)
+
+- Перейти в список товаров (клиентов, ячеек хранения)
+- Нажать кнопку создать товар (...)
+- Заполнить все необходимые поля и сохранить изменения
+
+### Оформление новой операции
+
+- Нажать кнопку "новая операция"
+- Выбрать клиента
+- Добавить товары и их количество
+- Нажать кнопку сохранить
+
+### Изменение операции (товара, клиента)
+
+- Зайти в меню управления операцией
+- Нажать кнопку изменить
+- Внести необходимые изменения
+- Нажать кнопку сохранить
+
+### Получение хранимых товаров
+
+- Зайти в раздел хранимых товаров
+- Отфильтровать запрос, при необходимости
+
+## Схема базы данных
+
+![pages](./images/database.png)
diff --git a/docs/images/database.png b/docs/images/database.png
new file mode 100644
index 0000000..4bf740f
--- /dev/null
+++ b/docs/images/database.png
Binary files differ
diff --git a/docs/images/pages.png b/docs/images/pages.png
new file mode 100644
index 0000000..9f7a11a
--- /dev/null
+++ b/docs/images/pages.png
Binary files differ