Мы предлагаем автодокументацию на базе Кольца Автотестов.
Жанр — быль.
Да.
И было можно задолго до ИИ.
«Сделай пользовательскую документацию для этой программы и поддерживай её в актуальном состоянии».
Желание исполнено дословно: текст пишется заново на каждый коммит и правда всегда свежий.
Свежий — не значит верный. А проверить нечем.
Окно моделей — десятки тысяч строк. Биллинг или ERP — сотни тысяч, иногда миллионы.
Дело даже не в окне. Не собирается сквозная картина: сценарий идёт через модули, асинхронные стыки и настройку, и этой связности в коде нет.
Логи покажут, какими путями ходят чаще. Ранжировать помогут, проверить правильность — нет.
Человек проходит сценарий, снимает копии экрана, вставляет в документ.
Потом система меняется, а документ — нет.
Неверная документация не роняет ни сборку, ни прод, не гасит лампочку, никого не будит ночью.
А пользователь звонит в поддержку — не автору руководства.
До автора сигнал не доходит вовсе.
Такая штука давно есть и называется автотест.
Этого нет ни в коде, ни в логах: это решение, а не вычисление.
Разработчик, изменяя код, знает, как меняется сценарий. Записать его в автотест в эту минуту стоит почти ничего.
Сценарии пишут те же, кто пишет программу. Это и есть Кольцо Автотестов.
Для человека — да: сценарий у него в голове ровно сейчас, передавать дорого.
Для агентов — нет: один пишет тесты, другой код, и они спорят, пока не сойдутся.
Цены поменялись местами. У людей дорога передача знания. У агентов она даром, зато нужнее независимость: кто пишет и код, и тест, напишет тест под свою реализацию.
Не делится одно — право сказать, что считается правильным.
Сценарий действий, а не у каждого своё в голове.
Система растёт, сценарии продолжают работать.
Из того же прогона, с копиями экрана.
Те же сценарии на объёмах.
По расписанию на проде или его копии.
Столько по нашей практике добавляет написание кода вместе с автотестами — а значит, и вместе с автодокументацией.
Платится один раз, на написании.
Насколько сожмёт ИИ эти тридцать процентов — вопрос открытый и самый интересный.
Из логирования прохождения автотеста в читаемый текст. Именно он делал затею менее выгодной. Теперь не требует.
И пишет уже пользовательским языком: по нескольким доступным примерам модель сама составляет себе ubiquitous language организации.
А из того же прогона получается и видеодокументация — теми же словами, только вслух.
Если по-матричному: не надо поручать людям машинную работу. Отсюда и «авто» в автодокументации. Человеческое — знать, что значит «правильно».
Guardrails мы переводим как «направляющие». И по смыслу это рельсы и есть: они не столько не дают съехать, сколько задают путь.
А первый кричал: «Куда хотим, туда едем И можем, если надо, свернуть» Второй отвечал, что поезд проедет Лишь там, где проложен путь
Кольцо и есть проложенный путь.
Так сделаем мы эту сказку былью — или не в этот раз?