Rewrite technical specification in formal style

docs/tz/data-integrations.md

@@ -1,4 +1,4 @@
-# 5. Данные и интеграции
+# 5. Требования к данным и интеграциям
 
 ## 5.1 Основные сущности данных
 
@@ -17,27 +17,27 @@
 - событие изменения статуса
 - уведомление
 - бонусная связь
-- бонусная транзакция
-- заявка на вывод вознаграждения
+- бонусная операция
+- заявка на использование либо вывод бонусов
 
 ## 5.2 Обязательные данные по сущностям
 
-### Пользователь
+### 5.2.1 Пользователь
 
-Обязательные поля:
+Обязательные данные:
 
 - идентификатор
 - имя
-- email
+- адрес электронной почты
 - телефон
 - роль
 - статус учетной записи
 - связанный контрагент
 - подключенные каналы уведомлений
 
-### Контрагент
+### 5.2.2 Контрагент
 
-Обязательные поля:
+Обязательные данные:
 
 - идентификатор
 - наименование компании
@@ -47,93 +47,99 @@
 - контактные лица
 - закрепленный менеджер
 
-### Товар
+### 5.2.3 Товар
 
-Обязательные поля:
+Обязательные данные:
 
 - идентификатор
 - SKU
 - наименование
 - тип продукции
 - набор параметров
+- доступные варианты
 - остатки по складам
-- признаки доступности
+- признаки доступности и кастомизации
 
-### Заявка на заказ
+### 5.2.4 Заявка на заказ
 
-Обязательные поля:
+Обязательные данные:
 
 - идентификатор
 - инициатор
-- дата создания
+- дата и время создания
 - состав позиций
+- параметры позиций
 - количество
 - комментарий клиента
 - статус
 - закрепленный менеджер
 - стоимость после обработки
-- параметры доставки после обработки
+- условия поставки после обработки
 
-### Заявка на расчет
+### 5.2.5 Заявка на расчет
 
-Обязательные поля:
+Обязательные данные:
 
 - идентификатор
 - инициатор
-- дата создания
+- дата и время создания
 - параметры изделия
 - комментарий клиента
 - статус
 - закрепленный менеджер
 - стоимость после обработки
-- параметры доставки после обработки
+- условия поставки после обработки
 
-### Заказ
+### 5.2.6 Заказ
 
-Обязательные поля:
+Обязательные данные:
 
 - внутренний идентификатор
-- внешний идентификатор 1С
+- внешний идентификатор учетной системы
 - статус
-- даты изменений
+- даты изменения
 - состав заказа
 - стоимость
-- доставка
-- связанная клиентская заявка
+- условия поставки
+- ссылка на исходную клиентскую заявку
+
+### 5.2.7 Бонусная операция
+
+Обязательные данные:
+
+- идентификатор операции
+- связанный клиент
+- тип операции
+- сумма или объем операции
+- основание операции
+- дата и время операции
+- текущий статус операции
 
 ## 5.3 Требования к данным каталога
 
-Для каждой позиции в каталоге система должна хранить и отображать:
+Для каждой позиции и для каждого товарного направления система должна хранить и отображать:
 
-- тип товара
-- параметры выбора
-- описание параметров
+- тип продукции
+- доступные параметры выбора
+- стандартные значения параметров
+- описания параметров
+- признаки доступности индивидуальной длины, втулки с логотипом и нанесения надписи
+- доступные варианты товара
 - остатки по складам
-- доступные варианты
-- признаки кастомизации, если они применимы
+- сведения об актуальности данных
 
-## 5.4 Интеграция с 1С
+## 5.4 Требования к интеграции с 1С
 
-Интеграция с 1С должна обеспечивать обмен данными о заказах и каталоге.
+Интеграция с 1С должна обеспечивать обмен данными, необходимыми для сопровождения каталога и заказов.
 
-### Входящие события
+Система должна обеспечивать получение из 1С следующих данных:
 
-Система должна принимать:
-
-- событие создания заказа
-- событие изменения заказа
-- событие изменения статуса
-- событие изменения доставки
-- событие изменения состава или иных параметров
-
-### Методы получения данных
-
-Система должна получать:
-
-- список заказов клиентов
 - каталог товаров
 - характеристики товаров
-- остатки по складам
+- складские остатки
+- сведения о заказах
+- статусы заказов
+- изменения состава, стоимости, доставки и иных существенных параметров заказа
 
 ## 5.5 Требования к интеграционному обмену
 
@@ -141,27 +147,29 @@
 
 - сопоставление внутренних идентификаторов и идентификаторов 1С
 - защиту от дублирования событий
-- журналирование входящих событий
-- повторную обработку неуспешных событий
-- сохранение истории обновлений
+- регистрацию входящих и исходящих операций обмена
+- повторную обработку неуспешных сообщений
+- хранение истории обновлений по интеграционным операциям
 
-## 5.6 Требования к журналированию
+## 5.6 Требования к журналированию данных
 
-Для ключевых операций система должна хранить:
+Для ключевых действий и изменений система должна сохранять:
 
-- кто инициировал действие
-- когда произошло действие
-- какой объект был изменен
-- какое состояние было до изменения
-- какое состояние стало после изменения
+- тип объекта
+- идентификатор объекта
+- предыдущее состояние объекта
+- новое состояние объекта
+- дату и время изменения
+- пользователя либо источник, выполнивший изменение
 
-## 5.7 Бонусные данные
+## 5.7 Требования к данным бонусного контура
 
-Для бонусного контура система должна хранить:
+Для бонусной и реферальной программы система должна хранить:
 
-- текущий баланс
+- текущий бонусный баланс клиента
 - историю начислений
 - историю списаний
+- историю использования бонусов
 - реферальные связи
-- заявки на вывод
-- статус обработки заявок на вывод
+- заявки на использование либо вывод бонусов
+- статусы обработки таких заявок