Hvernig þú skrifar góða villutilkynningu (fyrir gervigreind eða forritara)

Góð villutilkynning gerir einhverjum öðrum, forritara eða gervigreind, kleift að sjá sama vandamál og þú sást, án þess að þurfa að spyrja þig neins. Hún þarf nákvæma fyrirsögn, nákvæm skref til að endurskapa villuna, hvað þú bjóst við, hvað gerðist í raun, villuboð afrituð orðrétt, og hvar það gerðist: á hvaða síðu, í hvaða vafra, á hvaða tæki og hjá hvaða notanda. Ein villa í hverri tilkynningu, með skjáskoti ef það hjálpar.

Flestar villur taka lengri tíma að skilja en að laga. Skýr tilkynning fjarlægir skilningshlutann. Þetta skiptir enn meira máli með gervigreindarverkfærum: gervigreindin getur ekki spurt eftirfylgjandi spurningar um hvað þú áttir við með „útskráin er undarleg“, svo hún giskar, og röng ágiskun getur brotið eitthvað annað.

Sniðmátið

Afritaðu þetta og fylltu það út:

Fyrirsögn: [Hvað er að og hvar] — t.d. „Bókunarform hafnar tímum eftir kl. 18“

Skref til að endurskapa:
1. ...
2. ...
3. ...

Vænt niðurstaða: [hvað ætti að gerast]
Raunveruleg niðurstaða: [hvað gerðist í staðinn]

Villuboð: [nákvæmur texti, ef einhver]
Hvar: [síða/vefslóð, vafri, tæki, innskráð/ur sem hvaða notandi]
Hversu oft: [alltaf / stundum / einu sinni]
Skjáskot eða upptaka: [fylgir með]

Restin af þessari leiðbeiningu útskýrir hvern hluta.

Skref 1: Endurskapaðu það fyrst

Áður en þú skrifar skaltu reyna að láta villuna gerast aftur. Þá lærirðu hvaða skref skipta máli og hvort hún gerist í hvert skipti.

• Byrjaðu úr hreinu ástandi: endurhlaða síðuna, eða skrá þig út og inn.
• Skrifaðu niður hvern smell og allt sem þú slærð inn.
• Reyndu að finna stystu leiðina sem kallar fram villuna.
• Prófaðu annan vafra eða annan reikning. Ef hún gerist aðeins hjá einum notanda er það stór vísbending.

Fyrir meira um þetta sjá hvernig þú villuleitar forriti sem gervigreind smíðaði.

Skref 2: Skrifaðu nákvæma fyrirsögn

Fyrirsögnin á að segja hvað er að og hvar, svo sá sem skimar listann viti hvaða villu er um að ræða.

Skref 3: Skráðu nákvæm skref

Númeraðu þau. Vertu bókstaflegur: hvaða síða, hvaða hnappur, hvað þú sleginn inn.

1. Skráðu þig inn sem viðskiptavinur (prófunarreikningur: customer@example.com).
2. Bættu „Byrjendasettinu“ í körfuna.
3. Sláðu inn afsláttarkóðann WELCOME10 og smelltu á Apply.
4. Smelltu á Checkout.

„Prófaðu að ganga frá kaupum með kóða“ sleppir þeim smáatriðum sem oft skipta máli: hvaða notandi, hvaða vara, hvaða kóði og hvort hann var settur inn fyrst.

Skref 4: Væntanlegt á móti raunverulegu

Þetta er kjarni tilkynningarinnar. Segðu bæði, því munurinn er villan.

• Væntanlegt: Greiðslusíðan opnast með 10% afslættinum sýndum í heildarupphæðinni.
• Raunverulegt: Hnappurinn sýnir snúning í eina sekúndu, og síðan gerist ekkert. Án afsláttarkóða virkar greiðslan.

Án „væntanlegs“ veit lesandinn kannski ekki að hegðunin sé röng. Án „raunverulegs“ veit hann ekki hverju hann á að leita að.

Skref 5: Afritaðu villur nákvæmlega

Villubolur eru fljótlegasta leiðin að orsökinni. Afritaðu þær sem texta, orð fyrir orð, án þess að umorða.

Hvar þú finnur þær:

• Á skjánum: hvaða skilaboð sem appið birtir.
• Vafraskjástýring (console): opnaðu þróunarverkfæri (F12, eða hægri smelltu → Inspect) og skoðaðu flipann Console fyrir rauðar línur.
• Netflipinn (Network): finndu bilaða beiðnina í þróunarverkfærunum og skrifaðu niður vefslóð hennar og stöðukóða (til dæmis POST /api/checkout → 500).
• Þjónsskrár, ef þú hefur aðgang að þeim.

Lína eins og TypeError: Cannot read properties of undefined (reading 'percent') at checkout.ts:48 bendir oft beint á vandamálið.

Skref 6: Bættu við samhengi

• Hvar: slóð síðunnar, umhverfið (forskoðun, stöging eða í loftinu).
• Hver: hvaða notandi eða hlutverk: stjórnandi, meðlimur, útskráður.
• Tæki og vafri: „Safari á iPhone“ á móti „Chrome á Windows“ getur skipt máli.
• Gögn: allt óvenjulegt við færsluna: mjög langur texti, sérstafir, mikill fjöldi atriða.
• Hvenær þetta byrjaði: „eftir breytinguna á afsláttarkóðum í gær“ er gull.
• Hversu oft: alltaf, eða einu sinni af hverjum tíu tilraunum.

Skref 7: Sýndu það

Skjáskot með merktu vandamálinu, eða stutt skjámyndbandsupptaka, útrýmir óvissu, sérstaklega fyrir útlitsvillur. Ef gervigreindartólið þitt tekur við myndum skaltu hengja eina við. Klipptu út allt sem er einkamál, þar með talið lykla og gögn annarra.

Að skrifa villutilkynningar fyrir smíðatól með gervigreind

Sama uppbygging virkar sem prompt. Tvær viðbætur hjálpa:

• Segðu hvað má ekki breytast, svo lagfæringin skapi ekki nýtt vandamál.
• Biddu hana um að staðfesta lagfæringuna, ekki bara skrifa hana.

Þegar ég er innskráður/innskráð sem viðskiptavinur, með „Byrjendasettið“ í körfunni og kóðann WELCOME10 settan inn, gerist ekkert þegar ég smelli á Checkout. Væntanlegt: greiðslusíðan opnast með 10% afslætti af heildarupphæðinni. Raunverulegt: stuttur snúningur, og síðan ekkert. Netflipinn sýnir að POST /api/checkout skilaði 500. Greiðsla án kóða virkar. Finndu orsökina og lagfærðu hana án þess að breyta því hvernig verð eru reiknuð fyrir pantanir án kóða. Staðfestu síðan greiðsluna með prósentukóða, kóða með fastri upphæð og án kóða.

Ef þú ert ekki viss um orsökina skaltu biðja um greiningu fyrst:

Ekki breyta kóða enn. Hverjar eru líklegar orsakir miðað við þessa tilkynningu, og hvað myndi staðfesta hverja þeirra?

Algeng mistök

• „Þetta er bilað.“ Engin skref, engin væntanleg niðurstaða, ekkert sem hægt er að bregðast við.
• Nokkrar villur í einni tilkynningu. Sumar eru lagaðar, aðrar týnast.
• Umorðaðar villur. „Eitthvað undefined“ felur nytsamlega hlutann.
• Gleymt notandanum eða hlutverkinu. Margar villur hafa aðeins áhrif á stjórnendur, eða aðeins nýja notendur.
• Að lýsa aðeins lagfæringunni sem þú vilt („bættu við null-athugun“) í stað vandamálsins.
• Að deila leyndarmálum í skjáskotum eða afrituðum skrám.

Gátlisti

• Ég endurskapaði villuna og fann stystu skrefin.
• Fyrirsögnin segir hvað er að og hvar.
• Skrefin eru númeruð og bókstaflega rétt.
• Bæði væntanlegt og raunverulegt er tilgreint.
• Villuboð eru afrituð nákvæmlega, ásamt bilaðri beiðni og stöðukóða.
• Síða, umhverfi, notandi, tæki og vafri eru tilgreind.
• Ég sagði hversu oft þetta gerist og hvenær það byrjaði.
• Skjáskot eða upptaka fylgir með, með einkaupplýsingum fjarlægðum.
• Ein villa í hverri tilkynningu.

Að tilkynna villur til umboðsmanns Mythex

Í Mythex-verkefni er tilkynningin prompt. Nokkrir eiginleikar hjálpa:

• Hengdu skjáskot af forskoðuninni eða villuskjánum við — allt að 5 skrár í hverjum skilaboðum.
• /fix beinir umboðsmanninum að því að laga villu; Plan-hamur leyfir honum að rannsaka áður en hann breytir.
• /test lætur umboðsmanninn endurskapa flæði í forskoðuninni sjálfri og segja þér hvað hann sér.
• Revert to this point afturkallar lagfæringu sem gerði hlutina verri.

Síðan villuleit með prompt-um í skjölunum notar sömu skref, væntanlegt og raunverulegt. Fyrir lagfæringar- og prófunarlykkjuna í kringum þetta, sjá hvernig þú endurtekur vinnu á forriti sem gervigreind smíðaði.

Spurningar