Kuidas kirjutada head veateadet (AI-le või arendajale)

Hea veateade võimaldab kellelgi teisel — arendajal või AI-l — näha sama probleemi, mida sina nägid, ilma et ta peaks sinult midagi küsima. Vaja on konkreetset pealkirja, täpseid samme probleemi taasesitamiseks, mida oodasid, mis tegelikult juhtus, kõiki veateateid sõnasõnalt ning seda, kus see juhtus: millisel lehel, brauseris, seadmel ja kasutajana. Üks viga veateate kohta ning vajaduse korral ekraanipilt.

Leidmine ja mõistmine võtab enamasti rohkem aega kui parandamine. Selge veateade eemaldab mõistmise osa. See on AI-tööriistade puhul veelgi olulisem: AI ei saa esitada täpsustavat küsimust selle kohta, mida sa „kassa on imelik“ all mõtlesid, seega ta oletab — ja vale oletus võib midagi muud katkestada.

Mall

Kopeeri see ja täida:

Pealkiri: [Mis on valesti, kus] — nt „Broneerimisvorm lükkab tagasi kellaajad pärast kella 18“

Sammud probleemi taasesitamiseks:
1. ...
2. ...
3. ...

Oodatud: [mis peaks juhtuma]
Tegelik: [mis juhtus selle asemel]

Veateade: [täpne tekst, kui on]
Kus: [leht/URL, brauser, seade, sisse logitud kasutajana]
Kui sageli: [alati / vahel / üks kord]
Ekraanipilt või salvestus: [lisatud]

Juhendi ülejäänud osa selgitab iga osa.

Samm 1: taasesita see kõigepealt

Enne kirjutamist proovi viga uuesti esile kutsuda. Saad teada, millised sammud on olulised ja kas see juhtub igal korral.

• Alusta puhtast olekust: värskenda lehte või logi välja ja uuesti sisse.
• Märgi üles iga klõps ja iga kirjutatud asi.
• Proovi leida lühim tee, mis viga käivitab.
• Proovi teist brauserit või kontot. Kui see juhtub ainult ühele kasutajale, on see suur vihje.

Selle kohta rohkem vaata kuidas siluda AI-ga ehitatud rakendust.

Samm 2: kirjuta konkreetne pealkiri

Pealkiri peaks ütlema, mis on valesti ja kus, et nimekirja vaadates oleks näha, mis viga see on.

Samm 3: loetle täpsed sammud

Numberda need. Ole sõnasõnaline: milline leht, milline nupp, mida kirjutasid.

1. Logi sisse kliendina (testkonto: customer@example.com).
2. Lisa ostukorvi „Starter kit“.
3. Sisesta allahindluskood WELCOME10 ja klõpsa Apply.
4. Klõpsa Checkout.

„Proovi kassat koodiga“ jätab välja detailid, mis sageli on olulised: milline kasutaja, milline toode, milline kood ja kas see rakendati enne.

Samm 4: oodatud vs tegelik

See on veateate tuum. Ütle mõlemad, sest erinevus ongi viga.

• Oodatud: kassalehel avaneb kogusumma, kus on näidatud 10% allahindlus.
• Tegelik: nupp näitab sekundi jooksul laadimisringi ja siis ei juhtu midagi. Ilma allahindluskoodita kassa töötab.

Ilma „oodatud“ juhita ei pruugi lugeja teada, et käitumine on vale. Ilma „tegelikuta“ ei tea ta, mida otsida.

Samm 5: kopeeri veateated täpselt

Veateated on kiireim tee põhjuseni. Kopeeri need tekstina, sõnasõnaliselt — ära paraphrase'i.

Kust neid leida:

• Ekraanil: iga sõnum, mida rakendus näitab.
• Brauseri konsool: ava arendaja tööriistad (F12 või paremklõps → Inspect) ja vaata vahekaarti Console punaste ridade jaoks.
• Võrgu vahekaart: arendaja tööriistades leia nurjunud päring ja märgi üles selle URL ja olekukood (näiteks POST /api/checkout → 500).
• Serveri logid, kui sul on juurdepääs.

Rida nagu TypeError: Cannot read properties of undefined (reading 'percent') at checkout.ts:48 viitab sageli otse probleemile.

Samm 6: lisa kontekst

• Kus: lehe URL, keskkond (eelvaade, lavastus või tootmine).
• Kes: milline kasutaja või roll — admin, liige, väljalogitud.
• Seade ja brauser: „Safari iPhone’is“ vs „Chrome Windowsis“ võib olla oluline.
• Andmed: kõik ebatavaline kirje kohta — väga pikk tekst, erimärgid, suur hulk esemeid.
• Millal see algas: „pärast eilset muudatust allahindluskoodidesse“ on kuldne.
• Kui sageli: igal korral või üks kord kümnest.

Samm 7: näita seda

Ekraanipilt, kus probleem on ümber joonistatud, või lühike ekraanisalvestus eemaldab ebaselguse — eriti paigutuse vigade puhul. Kui sinu AI-tööriist võtab pilte vastu, lisa üks. Lõika välja kõik privaatne, sealhulgas võtmed ja teiste inimeste andmed.

Veateated AI-koostajale

Sama struktuur töötab ka promptina. Kaks lisa aitavad:

• Ütle, mis ei tohi muutuda, et parandus ei tekitaks uut probleemi.
• Palu parandus kontrollida, mitte ainult kirjutada.

Sisse logitud kliendina, kui „Starter kit“ on ostukorvis ja kood WELCOME10 on rakendatud, ei tee nupule Checkout klõpsamine midagi. Oodatud: kassalehel avaneb 10% allahindlus kogusummast. Tegelik: lühike laadimisring ja siis ei juhtu midagi. Võrgu vahekaart näitab, et POST /api/checkout tagastas 500. Kassa ilma koodita töötab. Leia põhjus ja paranda see, ilma et muudaksid tellimuste hinnaarvutust ilma koodita. Seejärel kontrolli kassat protsendikoodiga, fikseeritud summaga koodiga ja ilma koodita.

Kui pole kindel põhjuses, palu esmalt diagnoos:

Ära veel koodi muuda. Selle veateate põhjal, mis on tõenäolised põhjused ja mis kinnitaks iga neist?

Levinud vead

• „See on katki.“ Ei ole samme, ei ole oodatud tulemust, pole millega tegutseda.
• Mitu viga ühes veateates. Osa parandatakse, osa kaob.
• Parafraseeritud veateated. „Mingi undefined asi“ peidab kasuliku osa.
• Kasutaja või rolli puudumine. Paljud vead mõjutavad ainult admin'e või ainult uusi kasutajaid.
• Ainult soovitud parandamise kirjeldamine („lisa null-kontroll“) probleemi asemel.
• Saladuste jagamine ekraanipiltides või kleebitud logides.

Kontrollnimekiri

• Taasesitasin vea ja leidsin lühimad sammud.
• Pealkiri ütleb, mis on valesti ja kus.
• Sammud on nummerdatud ja sõnasõnalised.
• Nii oodatud kui ka tegelik tulemus on kirjas.
• Veateated on kopeeritud täpselt, koos nurjunud päringu ja olekukoodiga.
• Leht, keskkond, kasutaja, seade ja brauser on lisatud.
• Ütlesin, kui sageli see juhtub ja millal see algas.
• Ekraanipilt või salvestus on lisatud, privaatne teave eemaldatud.
• Üks viga veateate kohta.

Veateadete esitamine Mythexi agendile

Mythexi projektis ongi veateade ise prompt. Mõned funktsioonid aitavad:

• Lisa ekraanipilt eelvaatest või veateatest — kuni 5 faili sõnumi kohta.
• /fix suunab agendi viga parandama; Plan-režiim laseb tal enne muutmist uurida.
• /test laseb agendil taasesitada voogusid eelvaates endas ja teatada, mida ta näeb.
• Revert to this point võtab tagasi paranduse, mis asjad halvemaks tegi.

Dokumentatsiooni lehel silumine promptidega kasutatakse sama sammud / oodatud / tegelik struktuuri. Parandus-ja-kontrolli tsükli kohta vaata kuidas korrata AI-ga ehitatud rakenduse muutmist.

Küsimused