docs: обновлён README - добавлена ссылка на документацию, актуализирован список возможностей

Author: Segate-ekb

README.md

@@ -2,17 +2,19 @@
 
 [![Статус порога качества](https://sonar.1cdevelopers.ru/api/project_badges/measure?project=integration_subsystem&metric=alert_status&token=sqb_4fd736b1dca04cda6252313b25beafd7fb501a90)](https://sonar.1cdevelopers.ru/dashboard?id=integration_subsystem)
 
-Подсистема создана для оптимизации процесса разработки новых интеграций.
+> 📚 **[Документация](https://integration-subsystem-docs.1cdevelopers.ru)** — полное руководство по установке, настройке и использованию подсистемы.
 
-Основные задачи и возможности:
+Подсистема создана для оптимизации процесса разработки новых интеграций в 1С:Предприятие 8.3.
 
-- Берет на себя инфраструктурный слой по формированию, отправке и получению сообщений.
-- Контролирет входящие и исходящие потоки данных.
-  - Проверка соблюдения контрактов при приеме и формировании сообщений
-  - Мониторинг состаяния подсистемы при помощи Prometheus
-- Базовая многопоточность из коробки. Формирование и отправка сообщений в несколько потоков
-- Минимальное вмешательство в код основной конфигурации для внедрения
-- Произвольные обработчики
+## Возможности
+
+- 🔄 **Управление потоками данных** — контроль входящих и исходящих потоков с поддержкой множества подписчиков
+- ✅ **Валидация по контрактам** — проверка соблюдения контрактов (OpenAPI 3.0) при приёме и формировании сообщений
+- 📊 **Мониторинг Prometheus** — сбор метрик состояния подсистемы в реальном времени
+- ⚡ **Многопоточность** — формирование и отправка сообщений в несколько потоков из коробки
+- 🔌 **Множество протоколов** — HTTP, RabbitMQ, Kafka, JRPC 2.0
+- 🛠 **Произвольные обработчики** — гибкая настройка логики обработки сообщений
+- 📝 **Минимальное вмешательство** — простая интеграция в существующую конфигурацию
 
 Оглавление:
 
@@ -26,63 +28,90 @@
 
 ## Подписчики
 
-Каждый исходящий поток может обладать несколькими подписчиками. Подписчики - это системы которые получают сообщения из потока.
+Каждый исходящий поток может обладать несколькими подписчиками. Подписчики — это системы, которые получают сообщения из потока.
 
-Для каждого подписчика могуть быть заданы свои правила сериализации и валидации сообщений.
+Для каждого подписчика могут быть заданы свои правила сериализации и валидации сообщений.
 
-На данный момент реализованы следующие типы подписчиков:
+Реализованные типы подписчиков:
 
-- Произвольный http-подписчик.
-- Подсистема интеграции. Такая же подсистема интегрированная в другой информационной базе.
-- RabbitMQ. Подписчик, который отправляет сообщения в очередь RabbitMQ.
-- Jrpc 2.0. Подписчик, который отправляет сообщения по протоколу Jrpc 2.0.
+| Тип | Описание |
+|-----|----------|
+| **HTTP** | Произвольный HTTP-подписчик с настраиваемыми заголовками и методами |
+| **Подсистема интеграции** | Интеграция с другой информационной базой через эту же подсистему |
+| **RabbitMQ** | Отправка сообщений в очередь RabbitMQ (AMQP) |
+| **Kafka** | Публикация сообщений в топики Apache Kafka |
+| **JRPC 2.0** | Отправка сообщений по протоколу JSON-RPC 2.0 |
 
 ### Пост-Обработка ответов
 
   Для каждого подписчика можно задать обработчик ответов. Обработчик ответов - это произвольный обработчик, который будет вызван после отправки сообщения.
   В обработчик будет передан ответ от подписчика, а так же ссылка на исходные данные сообщения.
 
-## Валидаиция
+## Валидация
 
-В подсистеме реализован механизм валидации сообщений при приеме и отправке. Валидация происходит на основе контрактов, которые описывают структуру сообщения.
-Формат описания контрактов - OpenAPI 3.0.0
+В подсистеме реализован механизм валидации сообщений при приёме и отправке на основе контрактов **OpenAPI 3.0**.
 
-Для хранение данных схем реализован справочник `инт_Схемы`. В нем хранится информация о схеме, и сама схема в формате JSON.
-Так же реализовано кэширование схем размещенных в удаленных источниках.
+- **Справочник `инт_Схемы`** — хранение схем валидации в формате JSON
+- **Кэширование** — автоматическое кэширование схем из удалённых источников
+- **Валидация payload** — проверка структуры и типов данных сообщений
 
 ## Мониторинг
 
-Основные метрики собираются при помощи Prometheus. Для сбора метрик реализован сервис `http://example.com/integration_subsystem/hs/prometheus/polling`, который возвращает данные в формате prometheus.
+Подсистема предоставляет метрики в формате Prometheus через HTTP-сервис:
+
+```
+GET /integration_subsystem/hs/prometheus/polling
+```
+
+### Доступные метрики
 
-### Метрики
+| Метрика | Описание |
+|---------|----------|
+| `pde_queue_length` | Количество сообщений в очереди (по каждой очереди отдельно) |
+| `pde_messages_sent_total` | Общее количество отправленных сообщений |
+| `pde_messages_failed_total` | Количество сообщений с ошибками |
+| `pde_processing_duration_seconds` | Время обработки сообщений |
 
-- pde_queue_length - количество сообщений в очереди. Считается для каждой очереди в отдельности.
+## Быстрый старт
 
-## Примеры использования
+### Создание исходящего потока
 
-### Добавление нового потока
+1. Создайте предопределённый элемент справочника `инт_ПотокиДанных`
+2. Определите моменты триггера для отправки сообщений
+3. Добавьте регистрацию сообщения в очереди:
 
-#### Создание исходящего потока
+```bsl
+РегистрыСведений.инт_ОчередьИсходящихСообщений.ЗарегистрироватьСообщение(
+    ИсходныеДанные,  // Ссылка на объект или ФиксированнаяСтруктура
+    ПотокДанных      // СправочникСсылка.инт_ПотокиДанных
+);
+```
 
-1. Создайте новый предопределенный элемент справочника "инт_ПотокиДанных"
-1. Определите моменты триггера для отправки сообщений
-1. Добавьте в момент триггера событие регистрации сообщения в очереди отправки(см. функцию ЗарегистрироватьСообщение в [модуле менеджера очереди исходящих сообщений.](src/cf/InformationRegisters/инт_ОчередьИсходящихСообщений/Ext/ManagerModule.bsl))
-1. Заполните в режиме предприятия направление потока(Исходящий) и текст обработчика.
-1. Добавьте в ТЧ подписчики получателя ваших сообщений.
+4. В режиме предприятия заполните направление потока (Исходящий) и текст обработчика
+5. Добавьте подписчиков в табличную часть
 
-## Планы на будущее
+Подробнее в [документации](https://integration-subsystem-docs.1cdevelopers.ru/guide/create-flow).
 
-- [ ] Добавить возможность приема сообщений в несколько потоков
-- [ ] Добавить поддержку протокола JRPC
-- [ ] Добавить поддержку протокола AMQP и rabbitMQ
-- [ ] Добавить версионирование обработчиков потоков в GIT
-- [ ] Добавить поддержку asyncapi для описания контрактов и добавить валидацию не только пэйлоада, но и метаданных
-- [x] Добавить поддержку внешних систем мониторинга
-- [ ] Добавить динамические подписки на события по потокам
-- [ ] Добавить синтаксическую подсказку по полям требуемых объектов на основании схемы контракта
+## Roadmap
+
+- [x] ~~Поддержка внешних систем мониторинга (Prometheus)~~
+- [x] ~~Поддержка протокола JRPC 2.0~~
+- [x] ~~Поддержка RabbitMQ (AMQP)~~
+- [x] ~~Поддержка Apache Kafka~~
+- [ ] Приём сообщений в несколько потоков
+- [ ] Версионирование обработчиков потоков в Git
+- [ ] Поддержка AsyncAPI для описания контрактов
+- [ ] Динамические подписки на события по потокам
+- [ ] Синтаксическая подсказка по полям на основании схемы контракта
 
 ## Разработчикам
 
-Информация для разработчиков подсистемы доступна по ссылке [CONTRIBUTING.md](CONTRIBUTING.md)
+Информация для разработчиков подсистемы доступна в [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Ссылки
+
+- 📚 [Документация](https://integration-subsystem-docs.1cdevelopers.ru)
+- 📊 [SonarQube](https://sonar.1cdevelopers.ru/dashboard?id=integration_subsystem)
+- 🐛 [Issues](https://github.com/Segate-ekb/integration_subsystem/issues)
 
 ## Лицензия