Стартап нанял нового разработчика. Код написан без документации и комментариев. Новичок 2 недели разбирался как всё работает, тормозил релизы. Потеряли месяц на онбординг.
Решение
Начали использовать ChatGPT для документирования кода: вставляют функцию, ИИ пишет что она делает, какие параметры, что возвращает, примеры использования. Онбординг новых разработчиков сократился с 2 недель до 3 дней.
2. ПАРАМЕТРЫ - Название: тип, что значит - [для каждого параметра]
3. ВОЗВРАЩАЕТ Тип данных, что содержит
4. ПРИМЕР ИСПОЛЬЗОВАНИЯ Реальный код-пример
5. EDGE CASES / ОГРАНИЧЕНИЯ Когда может не работать, что учесть
6. СВЯЗАННЫЕ ФУНКЦИИ Какие ещё функции используются вместе
ФОРМАТ: Markdown для README или комментарии для кода. ```
Результат
Новый разработчик разбирается в проекте за 3 дня вместо 2 недель. Меньше вопросов к команде, быстрее выход на продуктивность. Code review проще — понятно что делает каждый блок.
Как повторить
1. Выберите критичные функции/классы 2. Скопируйте код в ChatGPT 3. Получите документацию 4. Вставьте как комментарии или в README 5. Обновляйте при изменении кода 6. Сделайте правилом: новый код = документация сразу
Лайфхак
Используйте GitHub Copilot — он генерирует документацию прямо в редакторе кода. Пишете функцию, он сразу предлагает описание.
Ограничения
ИИ не всегда понимает бизнес-логику. Проверяйте что описание соответствует задумке, особенно для сложных алгоритмов.