Новый README после переделки архитектуры с Devin
Автор статьи на Medium поручил Devin переписать README после крупной переделки архитектуры. Шаги установки и описание API вышли точными, а объяснить замысел проекта и архитектурные решения агент не смог.
Что сделали
После крупной переделки архитектуры автор дал Devin репозиторий и пошаговый промпт. Devin просмотрел код, прочитал старый README и предложил план заголовков. Дальше он ждал команды «CONFIRMED, PROCEED». Затем его попросили забыть репозиторий, пройти собственную инструкцию по установке как новый разработчик и сообщить о пробелах. В конце Devin открыл PR из ветки, созданной от develop.
Что получилось
В README оказались точные шаги установки, понятные описания эндпоинтов API и примеры, которые агент вывел из кода. Хуже вышло с объяснением архитектурных решений и общего назначения проекта, потому что в коде этого нет.
На что обратить внимание
Сроков автор не называет. Он предполагает, что внутренняя документация или схемы архитектуры рядом с кодом могли бы закрыть пробел с замыслом и назначением проекта.
Кому пригодится
Разработчикам, у которых документация отстала от кода после большого рефакторинга.
Попробуйте сами с Devin
Мой проект в [путь к репозиторию] недавно переделали архитектурно. Просмотри код и перепиши README с точными шагами установки, настройкой и описанием API, сверяя каждую команду с реальным кодом. Для архитектурных решений и назначения проекта оставь заметные заглушки, их я заполню сам. Сделай изменения в новой ветке и покажи мне diff до открытия PR.
Нужна помощь с запуском? Вступайте в сообщество AI Pack ↗
Источник: medium.com ·