Как писать промпты для генерации кода — практический взгляд
 

Как писать промпты для генерации кода — практический взгляд

В последнее время всё чаще слышу про генерацию кода с помощью нейросетей и языковых моделей — это реально крутой инструмент, который может сократить массу времени и помочь при разработке. Но чтобы получить из ИИ нормальный рабочий код, а не набор случайных строчек или шаблонных шаблонов, нужно уметь правильно писать промпты. В этой теме хочу поделиться своим опытом и наблюдениями, как формулировать запросы, чтобы ИИ выдавал полезный и понятный код, а не какой-то абстрактный набор символов.

Что такое промпт и зачем он нужен

Промпт — это просто текст, который вы вставляете в нейросеть, чтобы "спросить" её что-то. В нашем случае промпт — это задание, описание задачи, инструкции или вопросы, которые поясняют, что именно вы хотите получить в ответ. Формат и точность промпта сильно влияют на то, насколько полезным окажется ответ. Если промпт слишком общий или неопределённый, результат может быть либо слишком абстрактным, либо неправильным, либо большим объёмом информации, из которой сложно что-то взять.

Поэтому важно вкладывать в промпт максимум контекста и требований: описание задачи, предпочтительный язык программирования, ограничения по используемым библиотекам, требования к стилю кода, формат вывода и т. п. Тогда модель понимает, какую именно функцию написать, как её оформить, и это реально экономит время.

Куда это вообще впихнуть? Когда и где использовать

Генерацию кода я использую в самых разных сценариях:

- Автоматизация рутинных задач. Например, написать скрипт для сбора данных с сайта, парсинга, преобразования JSON, выгрузки информации в Excel. Вместо того чтобы самому колупаться в документации — просто дал промпт и получил готовый код.

- Быстрая проверка идеи. Хочу проверить, как работает алгоритм, или решить задачу — пишу запрос с конкретной задачей, вижу пример, а потом уже адаптирую под свой проект.

- Обучение новичков. Если спрашиваю, как сделать функцию, то можно сразу попросить объяснение кода, чтобы понять, что там и зачем происходит.

- Интеграция с IDE. Некоторые плагины и расширения позволяют писать промпты прямо в редакторе и подставлять код автоматически — экономит кучу времени, когда надо быстро дописать функцию.

- Генерация всяких вспомогательных вещей — тестов, комментариев к коду, документации. Можно попросить ИИ сгенерировать unit-тесты для функции или добавить классные докстринги, которых самому иногда лень писать.

Как делать промпт — начинаем с простого, идем к сложному

Приведу пару примеров, чтобы показать разницу.

Плохой промпт:
«Напиши функцию на Python»
Что получаем? Может быть что угодно, код без конкретики. Такое слишком общо, модель будет гадать, что от неё хотят.

Лучше:
«Напиши функцию на Python, которая принимает список чисел и возвращает сумму только положительных элементов»
Теперь алгоритм определён. Код будет именно для этой задачи. Но может не быть примеров использования, документации и дополнительных уточнений.

Ещё точнее:
«Напиши функцию на Python 3.8+, без использования сторонних библиотек, которая принимает список чисел и возвращает сумму положительных. Добавь пример использования функции и короткий комментарий к коду»
Здесь уже всё чётко и понятно: версия языка, никаких "лишних" библиотек, примеры и комментарии. Результат почти всегда будет именно тем, что нужно, и оформлен нормально.

Подробный чек-лист для составления промптов

Чтобы не забывать важные моменты, делюсь списком, на который ориентируюсь сам:

- Чётко опиши задачу или проблему, которую надо решить.
- Укажи язык программирования и если нужно — версию.
- Задай ограничения — что можно и чего нельзя использовать.
- Укажи формат вывода — функция, класс, скрипт.
- Попроси добавить примеры использования кода.
- Если нужно, попроси пояснения или комментарии прямо в коде.
- Уточни, нужен ли краткий, лаконичный или развернутый вариант решения.
- Добавь контекст, если задача связана с каким-то фреймворком или конкретной сферой.
- Если хочешь тесты — попроси и их. Не стесняйся быть прямым и подробным.

Типичные ошибки при написании промптов

- Слишком общий запрос. Модель не понимает, что именно делать — получаешь шаблон или ерунду.
- Отсутствие ограничений. Если не указать версию языка или лимиты, могут подтянуться библиотеки, которые вам не подходят.
- Сложные или витиеватые формулировки. Чем проще и понятнее, тем лучше (но без потери смысла).
- Просьба сделать несколько разных вещей одновременно. Лучше разбивать на несколько запросов.
- Не указывать, надо ли писать комментарии или тесты — часто ИИ их просто не добавляет, если не попросить.
- Не давать контекста, если задача «из коробки» не совсем ясна.

Практические примеры с улучшением промптов

1) Плохо:

«Сделай калькулятор»

Что выйдет — неясно, какой калькулятор, для чего, на каком языке. Иногда генерация просто выдает базовый пример без настроек.

2) Лучше:

«Напиши на Python консольный калькулятор, который умеет складывать, вычитать, умножать и делить два числа»

Уже понятнее, что от кода ждут.

3) Ещё лучше:

«Напиши на Python 3.9 простой консольный калькулятор без сторонних библиотек, который поддерживает операции +, -, *, / для двух чисел. Добавь обработку ошибок деления на ноль и пример запуска из командной строки»

Получается более детальный и практичный код, который можно сразу запускать.

Ещё пример — запрос про парсинг:

Плохо:

«Напиши код для парсинга»

Лучше:

«Напиши на Python функцию, которая загружает HTML-страницу по URL и извлекает все ссылки с неё»

И ещё лучше:

«Напиши на Python 3.8 функцию без использования Selenium, которая скачивает HTML по URL (используя requests) и возвращает список всех ссылок (атрибут href из тэгов <a>). Добавь пример вызова функции и обработку исключений»

FAQ — часто задаваемые вопросы

— Как проверить, что промпт написан правильно?
Можно просто запустить и посмотреть на ответ. Если код не работает или непонятен — попробуйте добавить уточнений, ограничений, попросите привести пример вызова и комментарии.

— Можно ли исправить плохой код, попросив дополнительно ИИ?
Да, можно! Зачастую достаточно спросить: «Исправь ошибки в функции», «Добавь обработку ошибок» или «Объясни, что здесь не так».

— Что делать, если ИИ даёт слишком длинный ответ?
Напишите, чтобы модель сократила код или выдала только функцию без лишних объяснений.

— Есть ли универсальный шаблон промпта?
Не совсем. Общая идея — максимально четко описать задачу, ограничения и формат. Остальное зависит от конкретной ситуации.

— Как быть с нестандартными задачами?
Пробуйте разбивать на части. Сначала генерация базового решения, потом — доработка, добавление функций, оптимизация.

— Можно ли попросить ИИ писать комментарии или тесты?
Да! Просто явно это указывайте в запросе.

В общем, суть такая: генерация кода — это мощный инструмент, но чтобы воспользоваться им на все 100%, стоит научиться формулировать запросы максимально подробно и понятно. Тогда искусственный интеллект перестанет гадать, что вы хотите, и начнет выдавать полезный, рабочий и понятный код, с минимальными усилиями с вашей стороны.

Буду рад, если у вас есть свои фишки, советы или примеры по составлению хороших промптов — делитесь, обсудим!