Kā uzrakstīt labu kļūdas ziņojumu (MI vai izstrādātājam)

Labs kļūdas ziņojums ļauj kādam citam — izstrādātājam vai MI — redzēt to pašu problēmu, ko redzējāt jūs, bez jautājumiem jums. Tam vajag konkrētu nosaukumu, precīzus soļus problēmas atkārtošanai, ko sagaidījāt, ko faktiski ieguvāt, jebkuru kļūdas ziņojumu, nokopētu vārds par vārdu, un to, kur tas notika: kura lapa, pārlūkprogramma, ierīce un lietotājs. Viena kļūda vienā ziņojumā, ar ekrānuzņēmumu, ja tas palīdz.

Vairums kļūdu prasa vairāk laika, lai tās saprastu, nekā lai tās labotu. Skaidrs ziņojums noņem sapratnes daļu. Tas ir vēl svarīgāk ar MI rīkiem: MI nevar uzdot papildu jautājumu par to, ko jūs domājāt ar „kases darbība ir dīvaina”, tāpēc tas mini — un nepareizs minējums var salauzt kaut ko citu.

Veidne

Kopējiet šo un aizpildiet:

Nosaukums: [Kas nav kārtībā, kur] — piem., „Rezervācijas forma noraida laikus pēc 18:00”

Soļi problēmas atkārtošanai:
1. ...
2. ...
3. ...

Sagaidīts: [kam vajadzēja notikt]
Faktiski: [kas notika tā vietā]

Kļūdas ziņojums: [precīzs teksts, ja ir]
Kur: [lapa/URL, pārlūkprogramma, ierīce, pieteikts kā kurš lietotājs]
Cik bieži: [katru reizi / dažreiz / vienreiz]
Ekrānuzņēmums vai ieraksts: [pievienots]

Pārējā ceļveža daļā paskaidrots katrs elements.

1. solis: vispirms atkārtojiet to

Pirms rakstīšanas mēģiniet izraisīt kļūdu vēlreiz. Jūs uzzināsiet, kuri soļi ir svarīgi un vai tā notiek katru reizi.

• Sāciet no tīra stāvokļa: atsvaidziniet lapu vai izrakstieties un pieteicieties vēlreiz.
• Pierakstiet katru klikšķi un katru ierakstīto lietu.
• Mēģiniet atrast īsāko ceļu, kas to izraisa.
• Izmēģiniet citu pārlūkprogrammu vai kontu. Ja tas notiek tikai vienam lietotājam, tas ir liels pavediens.

Par to vairāk skatiet kā labot MI veidotu lietotni.

2. solis: uzrakstiet konkrētu nosaukumu

Nosaukumam jāpasaka, kas nav kārtībā un kur, lai ikviens, kas pārlūko sarakstu, zinātu, par kuru kļūdu ir runa.

3. solis: uzskaitiet precīzus soļus

Numurējiet tos. Esiet burtisks: kura lapa, kura poga, ko ierakstījāt.

1. Pieteikties kā klientam (testa konts: customer@example.com).
2. Pievienot grozam „Sākuma komplekts”.
3. Ievadīt atlaides kodu WELCOME10 un noklikšķināt uz Apply.
4. Noklikšķināt uz Checkout.

„Mēģiniet noformēt pirkumu ar kodu” izlaiž detaļas, kas bieži ir svarīgas: kurš lietotājs, kurš produkts, kurš kods un vai tas tika piemērots pirms tam.

4. solis: sagaidītais pret faktisko

Tas ir ziņojuma kodols. Norādiet abus, jo atšķirība ir kļūda.

• Sagaidīts: kases lapa atveras ar 10% atlaidi, kas redzama kopsummā.
• Faktiski: poga sekundi rāda ritošu apli, un tad nekas nenotiek. Bez atlaides koda kase darbojas.

Bez „sagaidītā” lasītājs var nezināt, ka uzvedība ir nepareiza. Bez „faktiskā” viņš nezina, ko meklēt.

5. solis: nokopējiet kļūdas precīzi

Kļūdu ziņojumi ir ātrākais ceļš uz cēloni. Kopējiet tos kā tekstu, vārds par vārdu — neparafrāzējiet.

Kur tos atrast:

• Ekrānā: jebkurš ziņojums, ko lietotne rāda.
• Pārlūkprogrammas konsole: atveriet izstrādātāja rīkus (F12 vai ar peles labo pogu → Inspect) un skatiet cilni Console sarkanajām rindām.
• Tīkla cilne: izstrādātāja rīkos atrodiet neizdevušos pieprasījumu un pierakstiet tā URL un statusa kodu (piemēram, POST /api/checkout → 500).
• Servera žurnāli, ja jums ir piekļuve.

Rinda kā TypeError: Cannot read properties of undefined (reading 'percent') at checkout.ts:48 bieži tieši norāda uz problēmu.

6. solis: pievienojiet kontekstu

• Kur: lapas URL, vide (priekšskatījums, pārbaudes vai tiešraide).
• Kas: kurš lietotājs vai loma — administrators, dalībnieks, neierakstījies.
• Ierīce un pārlūkprogramma: „Safari iPhone” un „Chrome Windows” var atšķirties.
• Dati: kas neparasts ierakstā — ļoti gars teksts, īpašas rakstzīmes, liels vienumu skaits.
• Kad tas sākās: „pēc vakardienas izmaiņām atlaides kodos” ir zelta vērts.
• Cik bieži: katru reizi vai vienu reizi desmit mēģinājumos.

7. solis: parādiet to

Ekrānuzņēmums ar apvilktu problēmu vai īss ekrāna ieraksts novērš neskaidrības — īpaši izkārtojuma kļūdām. Ja jūsu MI rīks pieņem attēlus, pievienojiet vienu. Nogrieziet visu privāto, ieskaitot atslēgas un citu cilvēku datus.

Kļūdu ziņojumi MI lietotņu veidotājam

Tā pati struktūra darbojas kā uzvedne. Divi papildinājumi palīdz:

• Pasakiet, kas nedrīkst mainīties, lai labojums neizraisītu jaunu problēmu.
• Lūdziet pārbaudīt labojumu, ne tikai to uzrakstīt.

Pieteicies kā klients, grozā ir „Sākuma komplekts” un piemērots kods WELCOME10, un nospiežot Checkout, nekas nenotiek. Sagaidīts: kases lapa atveras ar 10% atlaidi no kopsummas. Faktiski: īss ritošs aplis, un tad nekas. Tīkla cilnē POST /api/checkout atgrieza 500. Kase bez koda darbojas. Atrodi cēloni un salabo to, nemainot cenu aprēķinu pasūtījumiem bez koda. Pēc tam pārbaudi kasi ar procentuālu kodu, fiksētas summas kodu un bez koda.

Ja neesat pārliecināts par cēloni, vispirms lūdziet diagnozi:

Vēl nemaini kodu. Balstoties uz šo ziņojumu, kādi ir iespējamie cēloņi un ko katrs no tiem apstiprinātu?

Biežākās kļūdas

• „Tas ir salūzis.” Nav soļu, nav sagaidītā rezultāta, nav, pēc kā rīkoties.
• Vairākas kļūdas vienā ziņojumā. Dažas tiek novērstas, citas pazūd.
• Parafrazēti kļūdu ziņojumi. „Kāda nedefinēta lieta” slēpj noderīgo daļu.
• Nav norādīts lietotājs vai loma. Daudzas kļūdas skar tikai administratorus vai tikai jaunus lietotājus.
• Aprakstīts tikai vēlamais labojums („pievieno null pārbaudi”), nevis problēma.
• Noslēpumu dalīšana ekrānuzņēmumos vai ielīmētos žurnālos.

Kontrolsaraksts

• Esmu atkārtojis kļūdu un atradis īsākos soļus.
• Nosaukumā ir norādīts, kas nav kārtībā un kur.
• Soļi ir numurēti un burtiski.
• Norādīti gan sagaidītais, gan faktiskais rezultāts.
• Kļūdu ziņojumi nokopēti precīzi, ar neizdevušos pieprasījumu un statusa kodu.
• Iekļauta lapa, vide, lietotājs, ierīce un pārlūkprogramma.
• Norādīts, cik bieži tas notiek un kad tas sākās.
• Pievienots ekrānuzņēmums vai ieraksts, privātie dati noņemti.
• Viena kļūda vienā ziņojumā.

Kļūdu ziņošana Mythex aģentam

Mythex projektā ziņojums ir uzvedne. Dažas funkcijas palīdz:

• Pievienojiet ekrānuzņēmumu no priekšskatījuma vai kļūdas ekrāna — līdz 5 failiem vienā ziņojumā.
• /fix pievērš aģentu kļūdas labošanai; Plāns režīms ļauj tam izpētīt pirms rediģēšanas.
• /test liek aģentam pašam atkārtot plūsmas priekšskatījumā un ziņot, ko tas redz.
• Atgriezties šajā punktā atceļ labojumu, kas pasliktināja lietas.

Dokumentācijas lapā kļūdu labošana ar uzvednēm izmantota tā pati soļu / sagaidītā / faktiskā struktūra. Par labošanas un pārbaudes cilpu ap to skatiet kā iterēt MI veidotu lietotni.

Jautājumi