Как описать ошибку ассистенту ИИ, чтобы он смог её точно диагностировать?

Question

Accepted Answer

Хороший отчёт об ошибке для ИИ — это то же самое, что хороший отчёт об ошибке для человека: предоставьте **достаточно контекста, чтобы воспроизвести проблему в его голове**, и уберите лишний шум. ИИ может рассуждать только о том, что вы вставляете — нечёткие описания дают нечёткие предположения.

## Что включить

- **Точное сообщение об ошибке и полный stack trace** — скопируйте его дословно, а не перефразируйте. Файл и строка в трассировке — это самая полезная подсказка.
- **Релевантный код** — функция, которая выбрасывает исключение, плюс её непосредственные вызывающие функции, но не весь репозиторий.
- **Ожидаемое и фактическое поведение** — "Я ожидаю X, но получаю Y" — это суть любого отчёта об ошибке.
- **Шаги воспроизведения** — точный ввод или последовательность, которая её вызывает.
- **Окружение/версии** — версии языка, фреймворка и библиотек (ошибка может быть специфична для версии).
- **Схема БД или примеры данных** — когда ошибка касается запроса или структуры данных.

## Что оставить

Не включайте посторонние файлы, весь ваш конфиг, secrets/API ключи и теории вроде "Думаю, это может быть X", которые предвзято влияют на диагностику. Приводите факты, а не предположения.

## Слабый vs сильный отчёт

```text
❌ WEAK: "My login is broken, it throws an error. Why?"
   → no error text, no code, no repro → the AI can only guess

✅ STRONG:
   Error (verbatim):
     TypeError: Cannot read properties of undefined (reading 'id')
       at getUser (auth.js:42)
   Code (auth.js:40-43):
```

```js
function getUser(token) {
  const session = sessions.find(s => s.token === token); // returns undefined if not found
  return session.user.id; // line 42: crashes when session is undefined
}
```

```text
   Expected: return null for an unknown token.
   Actual:   throws TypeError above.
   Repro:    call getUser('expired-token').
   Env:      Node 20, no framework.
```

Если использовать сильную версию, ИИ сможет сразу указать на пропущенную проверку `undefined` и предложить защиту, потому что все необходимые факты находятся на одной странице.

## Почему это важно

Ассистент ИИ **не имеет доступа к вашей работающей системе** — он рассуждает только на основе того, что вы предоставляете. Слабый отчёт заставляет его гадать об ошибке, коде и окружении одновременно, а неправильное предположение тратит раунд обмена. Сильный отчёт (точная трассировка + релевантный код + ожидаемое/фактическое + шаги воспроизведения + версии) превращает диагностику в сфокусированную задачу и обычно даёт правильное решение с первой попытки. Обучение написанию чётких отчётов об ошибках также делает вас лучшим отладчиком, потому что это заставляет вас изолировать факты до того, как вы задаёте вопрос.