Техническая документация¶
К кому обращена эта часть¶
Техническая документация предназначена для разработчиков и инженеров, которые сопровождают, дорабатывают или развёртывают систему «СВЯЗКА» --- систему распознавания и сопоставления документов, разработанную для компании «Альфа ИнфоТех». Предполагается, что читатель знаком с основами веб-разработки, работой с контейнерами Docker и командной строкой.
Если вы --- пользователь программы и хотите научиться с ней работать, перейдите в руководство пользователя.
Что здесь описано¶
Документация разбита на несколько разделов:
- Архитектура --- общая схема системы, путь документа от загрузки до результата сверки, используемые продукты и протоколы.
- Серверная часть --- устройство каталогов, конфигурация, подключения к хранилищам, описание всех серверных маршрутов и сервисов.
- Пользовательский интерфейс --- структура каталогов, маршрутизация, управление состоянием, прослойка обращений к серверу.
- Внутренние механизмы --- подробное описание ключевых алгоритмов: сравнение неоднозначных дат, многоиндексный поиск, система баллов, правила сопоставления, извлечение месторождений, пакетная обработка.
- Развёртывание и эксплуатация --- состав контейнеров, переменные окружения, веб-проксирование, резервное копирование, наблюдение за работой и устранение неисправностей.
Как пользоваться этим разделом¶
- Для быстрого знакомства начните с обзора архитектуры --- там показана общая схема и связи между компонентами.
- Если нужно понять, как устроен конкретный серверный маршрут или сервис, перейдите в соответствующий подраздел серверной части.
- Если требуется разобраться в логике сопоставления или группировки, загляните в раздел «Внутренние механизмы».
- Для развёртывания на новом сервере или восстановления после сбоя --- раздел «Развёртывание и эксплуатация».
Если вы встретили незнакомый термин, обратитесь к словарю понятий.