Hogyan írj le egy hibát egy AI asszisztensnek, hogy azt pontosan diagnosztizálni tudja?

Question

Accepted Answer

Az AI-nak küldött jó hibajelentés ugyanaz, mint az embernek küldött jó hibajelentés: adj **elég kontextust ahhoz, hogy az AI a fejében reprodukálni tudja a problémát**, és vágd le a zajt. Az AI csak arról tud okoskodni, amit beillesztesz — a homályos leírások homályos sejtéseket eredményeznek.

## Mit kell szerepeltetni

- **A pontos hibaüzenet és a teljes stack trace** — másold be szó szerint, ne parafrázissel. A trace-ben szereplő fájl és sor az egyetlen leghasznosabb nyom.
- **A releváns kód** — az a függvény, amely a hibát dobja, valamint az ahhoz közvetlenül kapcsolódó hívók, nem az egész repo.
- **Várt vs. tényleges viselkedés** — az "X-et várok, de Y-t kapok" bármely hibajelentés magja.
- **Reprodukálási lépések** — a pontos bemenet vagy sorrend, amely kiváltja azt.
- **Környezet/verziók** — a nyelv, framework és könyvtár verzió (a hiba verzió-specifikus lehet).
- **Adatbázis séma vagy minta adatok** — amikor a hiba egy lekérdezésre vagy adatstruktúrára vonatkozik.

## Mit hagj el

Nem kapcsolódó fájlok, a teljes konfiguráció, titkok/API kulcsok, és "szerintem lehet, hogy X" elméletek, amelyek elfogultsá teszik a diagnosztikát. Adj meg tényeket, nem sejtéseket.

## Gyenge vs. erős jelentés

```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.
```

Az erős verzióval az AI egyenesen az `undefined` ellenőrzés hiányára mutathat rá és javasolhat egy védelmet, mivel minden szükséges tény az oldalon van.

## Miért fontos

An AI asszisztensnek **nincs hozzáférése a futó rendszeredhez** — csak abból tud okoskodni, amit megadsz. Egy gyenge jelentés arra kényszeríti az AI-t, hogy egyidejűleg találgathasson a hibáról, a kódról és a környezetről, és egy rossz találgatás egy körös időpocsékolást jelent. Egy erős jelentés (pontos trace + releváns kód + várt/tényleges + reprodukálási lépések + verziók) a diagnosztikát fókuszált feladattá alakítja, és általában az első próbálkozásra helyes javítást ad. A szoros hibajelentések írásának megtanulása azt is jelenti, hogy jobb debugger leszel, mert arra kényszerít, hogy a kérdés felvetése előtt izoláld a tényeket.