Сгенерировать документацию по проекту
Получить README и описание архитектуры, которые не стыдно показать.
Документация, которую не стыдно показать, собирается за вечер. Агент знает код — остаётся попросить его внятно описать проект.
Шаги
- 1
Соберите карту проекта
Попросите агента составить список модулей и их назначение. Это скелет будущей документации.
- 2
Сгенерируйте README
Опишите запуск, структуру и основные команды так, чтобы новый человек завёл проект с нуля. README — лицо репозитория.
- 3
Опишите архитектуру словами
Попросите объяснить ключевые решения и потоки данных, добавьте простую диаграмму. Это спасёт будущего вас через полгода.
- 4
Проверьте воспроизводимость
Пройдите инструкции по шагам на чистой машине или попросите агента вычитать на противоречия. Док, который не воспроизводится, хуже его отсутствия.
Совет профи
Держите документацию рядом с кодом и обновляйте в том же PR. Отдельная вики устаревает в первый же месяц.
Частые ошибки
- Описываете «как хотелось», а не как есть в коде.
- README без шага запуска — новый человек застревает на старте.
- Пишете один раз и не обновляете — док быстро врёт.
Что в итоге
README и описание архитектуры, по которым новый человек заведёт проект сам — без расспросов.
Инструменты
Понравился разбор?
Полные версии, примеры и свежее каждый день — в Telegram-канале.
Подписаться @codautomat