Jinsi ya Kuandika Ripoti Nzuri ya Hitilafu (Kwa AI au Msanidi Programu)

Ripoti nzuri ya hitilafu inamruhusu mtu mwingine — msanidi programu au AI — aone tatizo lile lile uliloliona, bila kukuuliza chochote. Inahitaji kichwa mahususi, hatua kamili za kulionyesha, ulichotarajia, kilichotokea kweli, ujumbe wowote wa hitilafu ulionakiliwa neno kwa neno, na mahali lilipotokea: ukurasa gani, kivinjari gani, kifaa gani na mtumiaji gani. Hitilafu moja kwa ripoti, na picha ya skrini ikisaidia.

Hitilafu nyingi huchukua muda mrefu kueleweka kuliko kurekebishwa. Ripoti iliyo wazi huondoa sehemu ya kuelewa. Hili ni muhimu zaidi kwa zana za AI: AI haiwezi kukuuliza swali la ziada kuhusu ulimaanisha nini kwa "checkout ina ajabu", kwa hiyo inabahatisha — na ubahatishaji usio sahihi unaweza kuvunja kitu kingine.

Kiolezo

Nakili hiki na ukijaze:

Kichwa: [Kilicho kibaya, wapi] — k.m. "Fomu ya booking inakataa nyakati baada ya saa 12 jioni"

Hatua za kuonyesha tatizo:
1. ...
2. ...
3. ...

Inatarajiwa: [kinachopaswa kutokea]
Halisi: [kilichotokea badala yake]

Ujumbe wa hitilafu: [maandishi halisi, ikiwa yapo]
Mahali: [ukurasa/URL, kivinjari, kifaa, umeingia kama mtumiaji yupi]
Mara ngapi: [kila mara / wakati mwingine / mara moja]
Picha ya skrini au rekodi: [imeambatishwa]

Sehemu zilizobaki za mwongozo huu zinaeleza kila sehemu.

Hatua ya 1: Lionyeshe tena kwanza

Kabla ya kuandika, jaribu kufanya hitilafu itokee tena. Utajifunza hatua zipi ni muhimu, na kama hutokea kila mara.

• Anza kwa hali safi: onyesha upya ukurasa, au toka na uingie tena.
• Andika kila kubofya na kila kitu unachoandika.
• Jaribu kutafuta njia fupi zaidi inayoleta hitilafu.
• Jaribu kivinjari cha pili au akaunti nyingine. Ikiwa inatokea kwa mtumiaji mmoja tu, hiyo ni dalili kubwa.

Kwa zaidi kuhusu hili, angalia jinsi ya kurekebisha hitilafu kwenye app iliyojengwa kwa AI.

Hatua ya 2: Andika kichwa mahususi

Kichwa kinapaswa kusema kilicho kibaya na wapi, ili mtu anayepitia orodha ajue ni hitilafu ipi.

Hatua ya 3: Orodhesha hatua kamili

Zihesabu. Kuwa wa moja kwa moja: ukurasa gani, kitufe gani, ulichoandika nini.

1. Ingia kama mteja (akaunti ya majaribio: customer@example.com).
2. Ongeza "Starter kit" kwenye kikapu.
3. Weka msimbo wa punguzo WELCOME10 kisha ubofye Apply.
4. Bofya Checkout.

"Jaribu kulipia kwa msimbo" hauonyeshi maelezo ambayo mara nyingi ni muhimu: mtumiaji gani, bidhaa gani, msimbo gani, na kama ulitumika kwanza.

Hatua ya 4: Inatarajiwa dhidi ya halisi

Huu ndio moyo wa ripoti. Sema vyote viwili, kwa sababu tofauti yake ndiyo hitilafu.

• Inatarajiwa: ukurasa wa checkout unafunguka ukiwa na punguzo la 10% likionyeshwa kwenye jumla.
• Halisi: kitufe kinaonyesha spinner kwa sekunde moja, kisha hakuna kinachotokea. Bila msimbo wa punguzo, checkout inafanya kazi.

Bila "inatarajiwa", msomaji anaweza kutojua kwamba tabia hiyo si sahihi. Bila "halisi", hajui cha kutafuta.

Hatua ya 5: Nakili hitilafu kama zilivyo

Ujumbe wa hitilafu ndiyo njia ya haraka zaidi ya kufika kwenye chanzo. Uinakili kama maandishi, neno kwa neno — usiyaeleze upya.

Zinapatikana wapi:

• Kwenye skrini: ujumbe wowote ambao app inaonyesha.
• Console ya kivinjari: fungua zana za msanidi (F12, au bofya kulia → Inspect) kisha angalia kichupo cha Console kwa mistari myekundu.
• Kichupo cha Network: kwenye zana za msanidi, tafuta ombi lililoshindwa na uandike URL yake na msimbo wa hali (kwa mfano POST /api/checkout → 500).
• Kumbukumbu za seva, ikiwa unazo ruhusa.

Mstari kama TypeError: Cannot read properties of undefined (reading 'percent') at checkout.ts:48 mara nyingi unaelekeza moja kwa moja kwenye tatizo.

Hatua ya 6: Ongeza muktadha

• Mahali: URL ya ukurasa, mazingira (preview, staging au live).
• Nani: mtumiaji au jukumu gani — admin, mwanachama, aliyetoka.
• Kifaa na kivinjari: "Safari kwenye iPhone" dhidi ya "Chrome kwenye Windows" vinaweza kuleta tofauti.
• Data: chochote kisicho cha kawaida kwenye rekodi — maandishi marefu sana, herufi maalum, idadi kubwa ya vipengele.
• Ilianza lini: "baada ya mabadiliko ya jana kwenye misimbo ya punguzo" ni dhahabu.
• Mara ngapi: kila mara, au mara moja kati ya majaribio kumi.

Hatua ya 7: Ionyeshe

Picha ya skrini yenye tatizo limezungushiwa mduara, au rekodi fupi ya skrini, huondoa utata — hasa kwa hitilafu za mpangilio. Ikiwa zana yako ya AI inakubali picha, ambatisha moja. Kata kila kitu cha faragha, ikiwemo funguo na data ya watu wengine.

Kuandika ripoti za hitilafu kwa mjenzi wa AI

Muundo uleule unafanya kazi kama prompt. Nyongeza mbili zinasaidia:

• Sema kile ambacho lazima kisibadilike, ili marekebisho yasilete tatizo jipya.
• Mwombe athibitishe marekebisho, si kuyaandika tu.

Nikiwa nimeingia kama mteja, na "Starter kit" kwenye kikapu na msimbo WELCOME10 umetumika, nikibofya Checkout hakuna kinachotokea. Inatarajiwa: ukurasa wa checkout ufunguke ukiwa na punguzo la 10% kwenye jumla. Halisi: spinner fupi, kisha hakuna. Kichupo cha network kinaonyesha POST /api/checkout kilirudisha 500. Checkout bila msimbo inafanya kazi. Tafuta chanzo na urekebishe bila kubadilisha jinsi bei zinavyohesabiwa kwa oda zisizo na msimbo. Kisha jaribu checkout kwa msimbo wa asilimia, msimbo wa kiasi kisichobadilika na bila msimbo.

Ikiwa hujui chanzo, omba uchunguzi kwanza:

Usibadilishe msimbo bado. Kwa kuzingatia ripoti hii, ni sababu zipi zinazowezekana, na nini kingethibitisha kila moja?

Makosa ya kawaida

• "Imeharibika." Hakuna hatua, hakuna matokeo yanayotarajiwa, hakuna cha kuchukulia hatua.
• Hitilafu kadhaa kwenye ripoti moja. Zingine zinarekebishwa, zingine zinapotea.
• Ujumbe wa hitilafu uliofafanuliwa upya. "Kitu fulani kisichofafanuliwa" kinaficha sehemu muhimu.
• Kukosa mtumiaji au jukumu. Hitilafu nyingi zinaathiri admin tu, au watumiaji wapya tu.
• Kueleza marekebisho unayotaka tu ("ongeza ukaguzi wa null") badala ya tatizo lenyewe.
• Kushiriki siri kwenye picha za skrini au kumbukumbu zilizobandikwa.

Orodha ya ukaguzi

• Nimelionyesha tena tatizo na kupata hatua fupi zaidi.
• Kichwa kinasema kilicho kibaya na wapi.
• Hatua zina nambari na ni za moja kwa moja.
• Kinachotarajiwa na kilichotokea vyote vimetajwa.
• Ujumbe wa hitilafu umenakiliwa kama ulivyo, pamoja na ombi lililoshindwa na msimbo wa hali.
• Ukurasa, mazingira, mtumiaji, kifaa na kivinjari vimejumuishwa.
• Nimesema mara ngapi hutokea na ilianza lini.
• Picha ya skrini au rekodi imeambatishwa, bila data binafsi.
• Hitilafu moja kwa ripoti.

Kuripoti hitilafu kwa agent wa Mythex

Katika mradi wa Mythex, ripoti ndiyo prompt. Vipengele vichache vinasaidia:

• Ambatisha picha ya skrini ya preview au skrini ya hitilafu — hadi faili 5 kwa ujumbe.
• /fix humlenga agent kwenye kurekebisha hitilafu; hali ya Plan inamruhusu kuchunguza kabla ya kuhariri.
• /test humwomba agent aonyeshe upya mitiririko kwenye preview yenyewe na kuripoti anachokiona.
• Revert to this point hutengua marekebisho yaliyoifanya mambo kuwa mabaya zaidi.

Ukurasa wa nyaraka wa kurekebisha hitilafu kwa prompts unatumia muundo huu huu wa hatua / inatarajiwa / halisi. Kwa mzunguko wa kurekebisha na kuangalia unaozunguka hili, angalia jinsi ya kurudia marekebisho kwenye app iliyojengwa kwa AI.

Maswali