Ինչպես գրել լավ սխալի հաղորդում (մշակողի կամ AI-ի համար)

Լավ սխալի հաղորդումը թույլ է տալիս մեկ ուրիշին՝ մշակողին կամ AI-ին, տեսնել նույն խնդիրը, որ դուք տեսաք, առանց ձեզ որևէ բան հարցնելու։ Այն պետք է ունենա կոնկրետ վերնագիր, վերարտադրելու ճշգրիտ քայլեր, ինչ սպասում էիք, ինչ տեղի ունեցավ, ցանկացած սխալի հաղորդագրություն բառ առ բառ և այն, թե որտեղ է տեղի ունեցել՝ որ էջում, բրաուզերում, սարքում և օգտատիրոջ հաշվով։ Մեկ սխալ մեկ հաղորդմամբ, սքրինշոթով, եթե օգնում է։

Ամենաշատ սխալներին ավելի երկար է պահանջվում հասկանալ, քան շտկել։ Լավ հաղորդումը հանում է հասկանալու մասը։ Սա առավել կարևոր է AI գործիքների հետ․ AI-ն չի կարող հետագա հարց տալ՝ թե ինչ էիք նկատի ունենում «դուրսը տարօրինակ է աշխատում», ուստի կռահում է, և սխալ կռահումը կարող է ինչ-որ բան այլ կոտրել։

Ձևանմուշ

Պատճենեք սա և լրացրեք․

Վերնագիր: [Ինչ է սխալը, և որտեղ՝ օր․ «Ամրագրման ձևը մերժում է 18:00-ից հետո ժամերը»]

Քայլեր վերարտադրելու համար:
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-ը, միջավայրը (նախադիտում, բեմադրում կամ արտադրություն)։
• Ով․ որ օգտատերը կամ դերը՝ ադմին, անդամ, մուտք չգործած։
• Սարք և բրաուզեր․ «Safari iPhone-ում» և «Chrome Windows-ում» կարող են տարբերություն ունենալ։
• Տվյալներ․ ցանկացած անսովոր բան գրառման մեջ՝ շատ երկար տեքստ, հատուկ նիշեր, մեծ քանակությամբ իրեր։
• Երբ սկսվեց․ «երեկվա փոփոխությունից հետո զեղչի կոդերի վրա» ոսկի է։
• Որքան հաճախ․ ամեն անգամ, կամ տասից մեկ փորձից։

Քայլ 7. Ցույց տվեք այն

Սքրինշոթը՝ խնդիրը շրջանակված, կամ կարճ էկրանի տեսագրությունը վերացնում է երկիմաստությունը, հատկապես դասավորության սխալների դեպքում։ Եթե ձեր AI գործիքը ընդունում է նկարներ, կցեք մեկը։ Կտրեք այն, ինչ գաղտնի է, ներառյալ բանալիները և ուրիշների տվյալները։

AI կառուցիչի համար սխալների հաղորդում գրելը

Նույն կառուցվածքը աշխատում է որպես հրահանգ։ Երկու ավելացում օգնում է․

• Ասեք, թե ինչ չպետք է փոխվի, որ շտկումը նոր խնդիր չստեղծի։
• Խնդրեք ստուգել շտկումը, ոչ միայն գրել այն։

Մուտք գործած որպես հաճախորդ, «Starter kit»-ը զամբյուղում և WELCOME10 կոդը կիրառված, Checkout սեղմելը ոչինչ չի անում։ Սպասվող՝ checkout էջը բացվում է 10% զեղչով ընդհանուր գումարից։ Իրական՝ կարճ պտտվող նշան, հետո ոչինչ։ Network ներդիրը ցույց է տալիս, որ POST /api/checkout-ը վերադարձրեց 500։ Checkout-ը առանց կոդի աշխատում է։ Գտիր պատճառը և շտկիր այն՝ առանց փոխելու գների հաշվարկը պատվերների համար, որոնք կոդ չունեն։ Ապա ստուգիր checkout-ը տոկոսային կոդով, ֆիքսված գումարի կոդով և առանց կոդի։

Եթե պատճառը անորոշ է, առաջինը խնդրեք ախտորոշում․

Առայժմ կոդ մի փոխիր։ Այս հաղորդման հիման վրա ո՞րն են հավանական պատճառները և ինչն կհաստատեր յուրաքանչյուրը։

Սովորական սխալներ

• «Կոտրված է»։ Քայլեր չկան, սպասվող արդյունք չկա, ոչինչ գործել չի կարելի։
• Մի հաղորդման մեջ մի քանի սխալ։ Some-ը շտկվում է, մյուսները կորչում են։
• Վերաձևակերպված սխալներ։ «Some undefined thing»-ը թաքցնում է օգտակար մասը։
• Օգտատիրոջ կամ դերի բացակայություն։ Շատ սխալներ ազդում են միայն ադմինների կամ միայն նոր օգտատերերի վրա։
• Միայն ցանկալի շտկումը նկարագրելը («ավելացրու null ստուգում»)՝ խնդրի փոխարեն։
• Գաղտնի տվյալների տեղադրումը սքրինշոթներում կամ տեղադրված գրառումներում։

Ստուգացանկ

• Վերարտադրել եմ սխալը և գտել ամենակարճ քայլերը։
• Վերնագիրը ասում է, թե ինչ է սխալ և որտեղ։
• Քայլերը համարակալված են և բառացի։
• Ասված են և սպասվողը, և իրականը։
• Սխալի հաղորդագրությունները պատճենված են ճշգրիտ, ներառյալ ձախողված հարցումը և կարգավիճակի կոդը։
• Ներառված են էջը, միջավայրը, օգտատերը, սարքը և բրաուզերը։
• Ասված է, թե որքան հաճախ է լինում և երբ սկսվեց։
• Կցված է սքրինշոթ կամ տեսագրություն՝ անձնական տվյալները հանած։
• Մեկ սխալ մեկ հաղորդմամբ։

Սխալների հաղորդում Mythex-ի agent-ին

Mythex նախագծում հաղորդումը հենց հրահանգն է։ Մի քանի հատկանիշ օգնում է․

• Կցեք սքրինշոթ նախադիտման կամ սխալի էկրանի՝ մինչև 5 ֆայլ մեկ հաղորդագրությամբ։
• /fix-ը ստիպում է agent-ին կենտրոնանալ սխալը շտկելու վրա, իսկ Plan ռեժիմը թույլ է տալիս նախ հետազոտել, ապա խմբագրել։
• /test-ը ստիպում է agent-ին վերարտադրել հոսքերը հենց նախադիտման մեջ և հաղորդել, ինչ է տեսնում։
• Revert to this point-ը չեղարկում է շտկումը, որ բաները վատացրեց։

Փաստաթղթերի սխալների վրիպազերծում հրահանգներով էջը օգտագործում է նույն քայլեր / սպասվող / իրական կառուցվածքը։ Շտկել-և-ստուգել հանգույցի համար, որ սրա շուրջն է, տե՛ս ինչպես կրկնել աշխատանքը AI-ով ստեղծված հավելվածի վրա։

Հարցեր