Утилита читает папку с исходным кодом проекта (микросервисы на Java/Spring) и собирает по нему понятную документацию в Markdown: какие есть микросервисы, их REST-методы с реальными путями, обращения к базам данных, очереди и топики, планировщики. Готовый набор файлов можно сразу положить в базу знаний по проекту и дальше дополнять вручную. Это «обратная постановка» — восстановление картины системы из кода, когда исходной документации нет. Работает прямо в браузере, код никуда не отправляется.
Как работает
- Где работает: Google Chrome или Microsoft Edge (нужен доступ к папке через браузер). При выборе папки браузер спросит разрешение на чтение — это нормально, доступ только на чтение.
- Что делать: укажи корневую папку репозитория — утилита просканирует её и предложит скачать архив с документацией (обзор, файлы по микросервисам и методам, карта репозитория, отчёт диагностики).
- Нюансы: что распознано однозначно — попадает в «факты»; что распознать не удалось — честно выносится в сыром виде и в отчёт диагностики, чтобы уточнить с разработчиком. Утилита ничего не додумывает за код.
Приватность
Данные хранятся только на вашем компьютере, в интернет ничего не уходит. Папка открывается только на чтение, файлы разбираются прямо в браузере и никуда не отправляются; внешних библиотек и шрифтов из сети утилита не подгружает. Результат — локально скачиваемый архив.