Перейти к основному содержимому

Changelog: Исправления бизнес-документации WMS

Дата: 2026-03-27 Источник: wms-autodoc (Docusaurus) vs кодовая база wms Цель: Привести бизнес-документацию в соответствие с реальным состоянием системы


Сводка изменений

КатегорияКоличество
Файлы изменены7
Файлы скопированы без изменений24 (все АРМы)
Новый файл1 (CHANGELOG.md)
Добавлено типов документов2
Добавлено справочников6
Добавлено API endpoint'ов8
Добавлено АРМов3
Исправлено ссылок20+
Исправлено фактических ошибок5

Детальное описание по файлам

1. README.md (главная страница) — НОВЫЙ

Что: Создана главная страница документации. Зачем: В оригинале было дублирование между README.md и intro.md с разным содержимым.


2. intro.md — ИСПРАВЛЕН

ИзменениеБылоСтало
Опечатка"функциональнные""функциональные"
Раздел документацииНет раздела "Интеграции" в спискеДобавлен

3. 00_Overview/README.md — ДОПОЛНЕН

ИзменениеОписание
ИнтеграцииДобавлены упоминания: ERP, курьерские службы (ApiShip), система маркировки (Честный Знак)
СкладированиеДобавлен пункт "Управление контейнерами"
Новый раздел"Маркировка и серийные номера" — работа с Честным Знаком, серийными номерами, пулом кодов
УведомленияДобавлено упоминание системы уведомлений (мессенджеры)
Технологическая платформаРасширено: веб + мобильный интерфейс, REST API, уведомления в реальном времени

4. 01_Entities/00_References/README.md — ДОПОЛНЕН

Добавлены справочники в группу "Товарная информация":

СправочникОписаниеПочему отсутствовал
Упаковка товараВарианты упаковки одного SKU (штука, коробка, палет)Критически важный справочник, используется во всех операциях
Партия товараНомер партии, дата производства, срок годностиНеобходим для партионного учёта
Кондиция товараСостояние товара (годный, брак, карантин)Используется в регистрах учёта

Добавлена новая группа "7. Складская логика":

СправочникОписание
Тип зоныНазначение зоны (хранение, отбор, приёмка, отгрузка)
Рабочее пространствоЛогическая зона работы сотрудника
Правила размещенияАлгоритмы выбора ячеек при размещении товара

5. 01_Entities/01_Documents/README.md — ДОПОЛНЕН

Добавлены типы документов в блок "Склад":

ДокументОписаниеСтатус в коде
Дополнительная обработкаМаркировка, стикеровка, переупаковка товаровРеализован (AdditionalProcessingDoc)
Распаковка упаковокРазбор заводских упаковок на отдельные единицы товараРеализован (SkuPackagingUnpackingDoc)

Общее количество типов документов: явно указано 33 (было неявно ~27-32).

Остальные типы, ранее считавшиеся пропущенными, были найдены в оригинале:

  • Документ несоответствий — был в блоке "Склад"
  • Эмиссия серийных номеров — был в блоке "Отгрузка"
  • План обработки контейнера — был в блоке "Отгрузка"
  • Рейс — был в блоке "Отгрузка"

6. 02_ARMs/README.md — ПЕРЕРАБОТАН

Исправлены битые ссылки (20+):

Все ссылки на АРМы вели на несуществующие файлы (например, ./01_Receiving/ARM_Receiving_Main.md). Заменены на реальные файлы (./01_Receiving/receiving_arm.md).

Добавлены 3 отсутствующих АРМа:

АРМРазделОписание
Дополнительная обработкаСкладМаркировка, стикеровка, переупаковка товаров
Мониторинг заказовОтгрузкаОтслеживание статусов и прогресса обработки заказов
Управление транспортными местамиОтгрузкаФормирование и управление транспортными местами для погрузки

Удалены пустые категории:

Категории 04_Billing — 10_KPI ссылались на несуществующие файлы. Перенесены в раздел "Планируемые АРМы" как список планов на развитие.


7. 03_Reports/README.md — ПЕРЕРАБОТАН

ИзменениеОписание
Убраны emojiУбраны значки из заголовков разделов
Google Sheets ссылкаЗаменена на примечание о переносе в документацию
Бизнес-описанияДобавлены краткие описания назначения каждой группы отчётов

8. 07_Integration/README.md — СУЩЕСТВЕННО ДОПОЛНЕН

Добавлены отсутствующие endpoint'ы Merchant API:

ГруппаМетодURLОписание
ВозвратыGET/merchant-api/returningПолучить список возвратов
ВозвратыPOST/merchant-api/returningСоздать возврат
ПеремещенияGET/merchant-api/movementПолучить движения товаров
ДоставкаGET/merchant-api/deliveryИнформация о доставке
НаборыGET/merchant-api/bundleИнформация о наборах

Добавлены описания новых endpoint'ов (разделы 4.8-4.11):

  • 4.8 Возвраты — полный цикл возвратов через API
  • 4.9 Перемещения — получение информации о движениях товаров
  • 4.10 Доставка — статусы и информация о доставке
  • 4.11 Наборы — комплекты и наборы товаров

Исправлен раздел "Честный Знак" (раздел 5):

БылоСтало
"Блок не актуален, по причине пересмотра алгоритма. На данный момент алгоритм активно переписывается."Убрана пометка. Функционал реализован и работает в коде

Добавлен раздел "Прочие интеграции" (раздел 6):

  • Интеграция с ERP-системами
  • Интеграция с курьерскими службами (ApiShip)
  • Система уведомлений (мессенджеры)
  • Печать документов и этикеток (PDF, штрихкоды, термоэтикетки)

Файлы скопированные без изменений (24 АРМа)

Все файлы АРМов скопированы из wms-autodoc без изменений, так как их содержание в целом корректно описывает бизнес-процессы:

Приёмка (5 файлов):

  • unloading_arm.md — АРМ Разгрузка
  • receiving_arm.md — АРМ Приёмка
  • placing_arm.md — АРМ Размещение
  • QualityControl.md — АРМ Контроль качества
  • ReceivingReturnsARM.md — АРМ Приёмка возвратов

Склад (11 файлов):

  • inventory_arm.md — АРМ Инвентаризация
  • moving_arm.md — АРМ Перемещение
  • blocking_arm.md — АРМ Блокировка
  • topology_arm.md — АРМ Топология
  • processing_arm.md — АРМ Обработка
  • set_packing_arm.md — АРМ Обработка наборов
  • kto.md — АРМ Контроль товарных остатков
  • print_stickers_arm.md — АРМ Печать стикеров
  • arm_tsd_info.md — Информация ТСД
  • instruction_creation_arm.md — АРМ Создание инструкций
  • uproshchennaya_obrabotka_naborov_arm.md / V2 — Упрощённая обработка наборов

Отгрузка (7 файлов):

  • picking_arm.md — АРМ Отбор
  • batch_arm.md — АРМ Формирование батчей
  • packing_arm.md — АРМ Упаковка
  • sorting_arm.md — АРМ Сортировка
  • shipping_arm.md — АРМ Отгрузка
  • replenishment_arm.md — АРМ Подпитка
  • creating_tl_arm.md — АРМ Создание транспортных мест

Что НЕ изменено и почему

РазделПричина
Содержимое АРМовБизнес-описания процессов в целом корректны
Mermaid-диаграммыКорректно отражают бизнес-процессы
Структура frontmatterСохранена совместимость с Docusaurus
quality_ratingНе пересчитан — требует отдельной процедуры оценки

Рекомендации на будущее

  1. Создать описания для 3 новых АРМов — ✅ Выполнено: добавлены additional_processing_arm.md, order_monitoring_arm.md, transport_unit_arm.md
  2. Детализировать отчёты — перенести описания полей и параметров из Google Sheets в документацию
  3. Добавить описания справочников — по шаблону из _templates/entity_example.md для каждого справочника
  4. Пересчитать quality_rating — после внесения изменений
  5. Синхронизировать с wms-autodoc — после согласования перенести изменения в основной репозиторий документации