Како да напишете добар извештај за грешка (за AI или developer)

Добриот извештај за грешка овозможува некој друг — developer или AI — да ја види истата грешка што ја видовте вие, без да ве прашува ништо. Му треба конкретен наслов, точни чекори за повторување, што очекувавте, што се случи наместо тоа, порака за грешка копирана збор по збор и каде се појавила: на која страница, во кој прелистувач, на кој уред и за кој корисник. По една грешка во секој извештај, со снимка од екранот ако помага.

Повеќето грешки подолго се разбираат отколку што се поправаат. Јасен извештај го отстранува делот на разбирање. Ова е уште поважно со AI алатки: AI не може да постави дополнително прашање за тоа што мислевте со „плаќањето е некако чудно“, па погодува — а погрешното погодување може да расипе нешто друго.

Шаблонот

Копирајте го и пополнете го:

Наслов: [Што е лошо, каде] — на пр. „Формата за резервации ги отфрла термините после 18ч“

Чекори за повторување:
1. ...
2. ...
3. ...

Очекувано: [што требаше да се случи]
Вистинско: [што се случи наместо тоа]

Порака за грешка: [точен текст, ако има]
Каде: [страница/URL, прелистувач, уред, најавен како кој корисник]
Колку често: [секогаш / понекогаш / еднаш]
Снимка од екранот или запис: [приложено]

Остатокот од овој водич ги објаснува деловите.

Чекор 1: Прво повторете ја грешката

Пред да пишувате, обидете се повторно да ја предизвикате грешката. Ќе дознаете кои чекори се важни и дали се случува секогаш.

• Почнете од чиста состојба: освежете или одјавете се и најавете се повторно.
• Запишете секој клик и секое нешто што го впишавте.
• Обидете се да најдете најкраткиот пат што ја предизвикува.
• Пробајте втор прелистувач или сметка. Ако се случува само за еден корисник, тоа е голем траг.

За повеќе за ова, видете како да дебагирате апликација направена со AI.

Чекор 2: Напишете конкретен наслов

Насловот треба да каже што не е во ред и каде, за некој што ја прегледува листата да знае за која грешка станува збор.

Чекор 3: Наведете точни чекори

Нумерирајте ги. Бидете буквални: која страница, кое копче, што впишавте.

1. Најавете се како клиент (тест-сметка: customer@example.com).
2. Додајте го „Starter kit“ во кошничката.
3. Внесете го кодот за попуст WELCOME10 и кликнете Apply.
4. Кликнете Checkout.

Порака „пробај checkout со код“ ги испушта деталите што често се важни: која корисничка сметка, кој производ, кој код, дали прво бил применет.

Чекор 4: Очекувано наспроти вистинско

Ова е јадрото на извештајот. Кажете ги и двете, бидејќи разликата е самата грешка.

• Очекувано: страницата за checkout се отвора со прикажан попуст од 10% во вкупниот износ.
• Вистинско: копчето прикажува вртлив индикатор една секунда, а потоа ништо. Без код за попуст, checkout работи.

Без „очекувано“, читателот можеби не знае дека однесувањето е погрешно. Без „вистинско“, не знае што да бара.

Чекор 5: Копирајте ги грешките точно

Порачките за грешка се најбрз пат до причината. Копирајте ги како текст, збор по збор — не ги парафразирајте.

Каде да ги најдете:

• На екранот: секоја порака што ја прикажува апликацијата.
• Конзола на прелистувачот: отворете developer tools (F12, или десен клик → Inspect) и погледнете го табот Console за црвени редови.
• Network табот: во developer tools најдете го неуспешното барање и запишете ја неговата URL адреса и статус кодот (на пример POST /api/checkout → 500).
• Серверски логови, ако имате пристап.

Ред како TypeError: Cannot read properties of undefined (reading 'percent') at checkout.ts:48 често директно упатува на проблемот.

Чекор 6: Додајте контекст

• Каде: URL адресата на страницата, околината (преглед, staging или живо).
• Кој: кој корисник или улога — админ, член, одјавен.
• Уред и прелистувач: „Safari на iPhone“ наспроти „Chrome на Windows“ може да е важно.
• Податоци: сè необично за записот — многу долг текст, специјални знаци, голем број ставки.
• Кога започна: „после вчерашната промена во кодовите за попуст“ е златен податок.
• Колку често: секогаш, или еднаш на десет обиди.

Чекор 7: Покажете го

Снимка од екранот со заокружен проблем, или краток запис од екранот, ја отстранува нејасноста — особено кај грешки во распоредот. Ако вашата AI алатка прифаќа слики, приложете една. Исечете ги приватните делови, вклучително клучевите и туѓите податоци.

Пишување извештаи за грешки за AI градител

Истата структура работи и како prompt. Две додавања помагаат:

• Кажете што не смее да се менува, за поправката да не предизвика нов проблем.
• Замолете да ја провери поправката, не само да ја напише.

Најавен како клиент, со „Starter kit“ во кошничката и применет код WELCOME10, кликнувањето на Checkout не прави ништо. Очекувано: страницата за checkout се отвора со 10% попуст на вкупниот износ. Вистинско: краток вртлив индикатор, а потоа ништо. Табот за мрежа покажува дека POST /api/checkout вратил 500. Checkout без код работи. Најди ја причината и поправи ја, без да ја менуваш пресметката на цени за нарачки без код. Потоа провери го checkout со процентуален код, код со фиксен износ и без код.

Ако не сте сигурни за причината, побарајте прво дијагноза:

Не менувај код уште. Според овој извештај, кои се можните причини и што би го потврдило секоја од нив?

Чести грешки

• „Се расипало.“ Нема чекори, нема очекуван резултат, нема на што да се дејствува.
• Неколку грешки во еден извештај. Некои се поправаат, други се губат.
• Парафразирани грешки. „Некој undefined нешто“ ја крие корисната информација.
• Испуштена корисничка или улога. Многу грешки погодуваат само админи или само нови корисници.
• Опишување само на поправката што ја сакате („додај проверка за null“), наместо на проблемот.
• Споделување тајни податоци во снимки од екранот или залепени логови.

Листа за проверка

• Ја повторив грешката и ги најдов најкратките чекори.
• Насловот кажува што е лошо и каде.
• Чекорите се нумерирани и буквални.
• Наведени се и очекуваното и вистинското.
• Порачките за грешки се копирани точно, со неуспешното барање и статус кодот.
• Вклучени се страница, околина, корисник, уред и прелистувач.
• Кажав колку често се случува и кога започна.
• Приложена е снимка или запис, со отстранети приватни податоци.
• Една грешка по извештај.

Пријавување грешки до агентот на Mythex

Во проект на Mythex, извештајот е prompt-от. Неколку функции помагаат:

• Приложете снимка од екранот на прегледот или на екранот со грешка — до 5 датотеки по порака.
• /fix го фокусира агентот на поправка на грешка, а режимот Plan му овозможува да истражи пред да уредува.
• /test го натера агентот самиот во прегледот да ги повтори токовите и да ви каже што гледа.
• Revert to this point поништува поправка што ја влошила состојбата.

Страницата debugging with prompts во документацијата ја користи истата структура чекори / очекувано / вистинско. За циклусот на поправка и проверка околу неа, видете како да итерирате на апликација направена со AI.

Прашања