Хватит врать себе и заказчикам: почему 90% IT-проектов на самом деле не знают, как работает их собственный код

Хватит врать себе и заказчикам: почему 90% IT-проектов на самом деле не знают, как работает их собственный код

В индустрии разработки есть нарыв, о котором не принято говорить вслух: мы научились генерировать код в десятки раз быстрее, чем фиксировать знания о нем. Пока разработчики штампуют фичи, документация превращается в «кладбище текстов», которое никто не читает и которому никто не верит.

Результат? Неконтролируемая энтропия, рост стоимости каждой правки и деградация процессов. Как Lead Technical Writer, я вижу здесь не «плохие тексты», а сбой в инженерной системе.

Документация – это не описание продукта. Это его критический компонент, напрямую влияющий на Time-to-Market.

Документация как инженерная дисциплина. Методология ODS

  • Docs-as-Code как стандарт среды. Мы используем AsciiDoc и Antora, чтобы превратить знания в модульный код. Документация теперь живет в SDLC, проходит через Git и ревью наравне с основным продуктом.

  • Системная связность и контроль актуальности. Мы рассматриваем документацию не как статичный архив, а как систему с петлями обратной связи. В обычном проекте эти петли разомкнуты: код меняется, а знания о нем нет. Это создает «информационный долг». В ODS мы замыкаем эти циклы: любое изменение в архитектуре или БД автоматически инициирует обновление соответствующих слоев документации. Система сама сигнализирует о рассинхроне.

  • Automation как гарант качества. Автоматизация в ODS – это способ исключить человеческий фактор в рутинных операциях. Мы убрали человеческий фактор там, где он вредит. Списки, схемы БД, OpenAPI – всё это генерируется из «источников правды» автоматически.

Интерфейс системы ODS: навигация, полнотекстовый поиск и модульная структура. Так выглядит документация, когда она становится частью инженерного конвейера, а не просто набором файлов
Интерфейс системы ODS: навигация, полнотекстовый поиск и модульная структура. Так выглядит документация, когда она становится частью инженерного конвейера, а не просто набором файлов

Роль ИИ в системе

Интеграция ИИ (AI Integration) в ODS лишена рыночного пафоса. Для нас это контролируемый инструмент семантической обработки данных. Мы применяем локальные LLM-модели для решения узких задач: нормализации терминологии, пакетной обработки метаданных и лингвистического контроля.

ИИ не заменяет архитектора знаний, но усиливает его, беря на себя когнитивную нагрузку по трансформации данных. Это позволяет специалисту фокусироваться на проектировании структуры и логики, а не на механическом наполнении форм.

Инспекция реализации

Методология без кода – это просто слова. Мы предлагаем вам провести технический аудит нашей реализации. В репозитории ODS вы найдете не примеры файлов, а готовый конвейер производства знаний.

Я приглашаю архитекторов и CTO оценить наш подход. Давайте обсудим, как превратить документацию из статьи расходов в ваш главный стратегический актив.

Изучить артефакты ODS:

В открытом доступе находятся репозиторий и сайт проекта.

Технические подробности реализации ODS, примеры кода и настройки автоматизации доступны в статье Владимира:

1
Начать дискуссию