Как эффективно объяснить проблемы в коде опытному программисту: подробный промпт для нейро ассистента

Введение

Когда вы сталкиваетесь с проблемами в коде и нуждаетесь в помощи от опытного программиста, ключевым моментом является способность четко и подробно объяснить ситуацию. Это поможет ускорить процесс анализа и решения проблемы. В данной статье мы предоставим подробный промпт, который можно использовать для общения с нейроассистентом или программистом.

Промпт для объяснения проблем в коде

Промпт

1. Обзор: Опишите цель и функциональность кода, включая используемый язык программирования.

2. Описание проблемы: Укажите часть кода, которая вызывает проблемы и охарактеризуйте непредвиденное поведение или ошибки.

3. Контекст: Предоставьте любые связанные разделы кода и поделитесь недавними изменениями или дополнениями.

4. Желаемый результат: Объясните ожидаемый результат или функциональность после устранения проблемы.

5. Примеры: Включите примеры как некорректного, так и желаемого выхода.

6. Предыдущие попытки решения: Поделитесь методами или исправлениями, которые уже пробовали, и их результатами.

Пожалуйста, проанализируйте информацию и предложите пошаговое решение для устранения проблемы.

Пример использования промпта

Пример 1: Проблема с производительностью SQL-запроса

Обзор: Код написан на Python и использует библиотеку SQLAlchemy для взаимодействия с базой данных PostgreSQL.

Описание проблемы: Запрос выполняется очень медленно, особенно с увеличением количества пользователей.

Контекст:

Связанные таблицы: users, orders, order_details.
Недавно добавлена сортировка по дате заказа.

Желаемый результат: Запрос должен возвращать список пользователей и их заказов за приемлемое время (< 1 секунды).

Примеры:

Некорректный вывод: время выполнения запроса 30 секунд.
Желаемый вывод: время выполнения менее 1 секунды.

Предыдущие попытки решения: Пробовал добавить индексы на столбцы даты, но улучшения незначительны.

Анализ и решение: На основе предоставленной информации постарайтесь оптимизировать запрос, возможно, путем использования материальных представлений или изменения структуры запроса для уменьшения количества операций JOIN.

Итоги

Этот промпт и примеры должны помочь вам более эффективно объяснять проблемы в коде, предоставляя необходимый контекст и информацию для их быстрого решения опытными программистами или нейроассистентами.

Заключение

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

Представь себя опытным разработчиком алгоритмов. Мне нужна твоя помощь в отладке конкретного куска кода. Пожалуйста, следуй этим шагам:
    1. **Обзор**: Опиши цель и функциональность кода, включая используемый язык программирования.
    2. **Описание проблемы**:
       - Укажи часть кода, которая вызывает проблемы.
       - Охарактеризуй непредвиденное поведение или ошибки.
    3. **Контекст**:
       - Предоставь любые связанные разделы кода.
       - Поделись недавними изменениями или дополнениями, которые могли повлиять на функциональность.
    4. **Желаемый результат**: Объясни ожидаемый результат или функциональность после устранения проблемы.
    5. **Примеры**: Если возможно, включи примеры как некорректного, так и желаемого выхода.
    6. **Предыдущие попытки решения**: Поделись методами или исправлениями, которые уже пробовал, и их результатами.
    
    Пожалуйста, проанализируй информацию и предложи пошаговое решение для устранения проблемы.