Беглый обзор сервиса. Вкратце - ИИ в состоянии полностью автономно задокументировать ваш проект и выступить качественным справочным центром.
Контекст
Разработчики публикуют проекты. Разработчики разные, проекты разные, языки разные, а стили написания кода и ведения проекта - ещё более разные.
Из этого проистекает проблема того, что разобраться в репозитории “с наскоку” получается далеко не всегда.
И тут нашёлся сервис deepwiki.com, который эту проблему решает на очень хорошем уровне.
Что за DeepWiki такой
Сервис выступает как площадка с автоматически сгенерированной документацией для вашего GitHub-проекта.
Возможность разобрать приватные репы поддерживается в родительском сервисе (devin.ai) 💰
Базово, сервис принимает ваш репозиторий на обработку, изучает его, и выплёвывет подробное описание, красивые диаграммы, и возможность задавать ко всему этому вопросы.
Использование
Достаточно просто заменить https://github.com/ на https://deepwiki.com/ и вы получите ссылки на доку:
Документация будет представлять из себя буквально онлайн-книжку, подобную тому, что вы получили бы, если бы ваша команда вела записи в каком-нибудь GitBook.
Интересно, что заметный размер документации можно вытянуть даже из весьма скромных проектов. Например, вот выкладка на 4 раздела для 5mdt/shellmodoro.
Встроенный ИИ-консультант
Тут я буду задавать вопросы к своему pet-проекту Pagetron.
Это простой Status Page, который собран на основе Prometheus и blackbox exporter, и подготовлен для развертывания в Kubernetes.
ИИ очень быстро и хорошо ориентируется в коде и выдаёт не только разумные ответы, но и подсвечивает разные дополнительные детали.
Задам ему несколько вопросов для демонстрации:
Кратко резюмируй качество проекта и кода
Приятная похвала:
Как мне подключить снятие метрик с внешних экспортеров и отключить снятие метрик внутри инстанса самого pagetron?
Абсолютно верный ответ:
И важное уточнение, что нельзя просто так взять и направить бекенд на пустую TSDB, внутри ожидается наличие некоторых временных рядов:
Как мне улучшить README в этом репозитории, сделав упор на читаемость и простоту погружения?
В ответ получается отличный план (и он далее наполнен конкретными примерами) по рефакторингу README:
Самые пытливые могут также спросить про свой pet-проект что-то в духе “какие изменения стоит внести в проект для повышения его привлекательности” - и получить реально полезный roadmap, который будет или совпадать с вашим, или превосходить его 😸
Подытожим
- ИИ развивается семимильными шагами
- Погружаться в чужую кодовую базу ещё никогда не было так удобно
- Лучше добавить ИИ-инструменты в свой арсенал, чем не добавлять