Инфраструктурная основа всей публичной документации флота: единая точка входа и для разработчиков, и для пользователей сервисов, с автоматической синхронизацией схемы напрямую с кодом.
Портал — общая точка входа в публичную документацию сервисов флота, рассчитанная сразу на две разные аудитории: разработчиков, которым нужен точный контракт API, и пользователей сервисов, которым нужно понятное описание того, как сервисом пользоваться. Портал пережил технологический переход со старой платформы (MkDocs) на современную схему генерации документации — прямо из кода сервисов, а не вручную поддерживаемым текстом рядом с ним.
Схема каждого сервиса не пишется отдельно от кода — она собирается прямо из его исходников и автоматически синхронизируется при изменениях, поэтому не может незаметно разойтись с реальным поведением API так, как расходится документация, которую забывают обновить. Добавить новый сервис в портал — типовая, хорошо отработанная процедура, а не отдельный проект каждый раз.
Навигация, поиск и структура страниц спроектированы заново — не унаследованы механически от старой платформы вместе с её ограничениями.
Схема API описывается общепринятым индустриальным стандартом — портал совместим с инструментами, которые уже умеют такую схему читать, без специальной адаптации под TechCon.
Формулировки, структура разделов и уровень детализации описаний подчиняются общему своду правил — контент не расползается по стилю от страницы к странице.
Структурированная разметка отдаёт контент напрямую — агенту не нужно распознавать страницу как веб-скрейпер, чтобы понять контракт API.
Каждый новый сервис добавляет свою колонку по той же типовой процедуре — без переработки портала целиком.
Переход со старой платформы (MkDocs) на современную схему генерации документации — фундамент, на котором собран весь портал.
Поиск по документации работает на русском языке с этого момента, а не добавлен позже.
Схемы поиска по техпланам, дефектоскопии и распознавания речи собраны и опубликованы рядом с первой — по одной и той же типовой процедуре.
Портал подключён к живым исходникам сервисов — изменение API в коде само отражается в документации, без ручного шага «не забыть обновить».
Формулировки и структура разделов по всем четырём сервисам приведены к общему стандарту.
Структурированная разметка отдаёт контент напрямую агентам, без веб-скрейпинга страницы.
Следующий шаг — механизм, который сам замечает, когда сгенерированная схема разошлась с фактическим поведением сервиса. Параллельно — наполнение портала пользовательским контентом о том, как реально пользоваться сервисами флота, и сбор обратной связи от коллег-интеграторов, которые будут документацией пользоваться на практике.