સારો bug report કેવી રીતે લખવો (AI અથવા developer માટે)

સારો bug report કોઈ બીજાને — developer કે AI ને — તમે જોયેલી જ સમસ્યા જોવા દે છે, તમને કંઈ પૂછ્યા વિના. તેને ચોક્કસ શીર્ષક, તેને ફરી ઉભી કરવાના બરાબર પગલાં, તમે શું અપેક્ષા રાખી હતી, ખરેખર શું થયું, શબ્દશઃ કૉપી કરેલો કોઈ પણ ભૂલ સંદેશ, અને ક્યાં થયું તે જોઈએ: કયું પેજ, બ્રાઉઝર, ઉપકરણ અને user. દરેક report માં એક bug, મદદરૂપ હોય તો સ્ક્રીનશૉટ સાથે.

મોટાભાગના bugs ઠીક કરવા કરતાં સમજવામાં વધુ સમય લે છે. સ્પષ્ટ report સમજવાનો ભાગ દૂર કરે છે. AI સાધનો સાથે આ વધુ મહત્વનું છે: "checkout અજીબ છે" થી તમારો શું મતલબ હતો તે AI પૂછી શકતું નથી, તેથી તે અટકળ કરે છે — અને ખોટી અટકળ બીજું કંઈક તોડી શકે છે.

ટેમ્પ્લેટ

આની નકલ કરીને ભરો:

શીર્ષક: [શું ખોટું છે, ક્યાં] — દા.ત. "Booking form સાંજે 6 પછીના સમયને નકારે છે"

ફરી ઉભી કરવાના પગલાં:
1. ...
2. ...
3. ...

અપેક્ષિત: [શું થવું જોઈએ]
વાસ્તવિક: [તેને બદલે શું થયું]

ભૂલ સંદેશ: [બરાબર લખાણ, જો હોય તો]
ક્યાં: [પેજ/URL, બ્રાઉઝર, ઉપકરણ, કયા user તરીકે લૉગિન]
કેટલી વાર: [દરેક વખતે / ક્યારેક / એક વાર]
સ્ક્રીનશૉટ કે રેકોર્ડિંગ: [જોડેલું]

બાકીની guide દરેક ભાગ સમજાવે છે.

પગલું 1: પહેલાં તેને ફરી ઉભો કરો

લખતા પહેલાં, bug ફરીથી થાય તે પ્રયાસ કરો. તમને ખબર પડશે કયા પગલાં મહત્વના છે, અને તે દરેક વખતે થાય છે કે નહીં.

• સ્વચ્છ સ્થિતિથી શરૂ કરો: refresh કરો, અથવા લૉગ આઉટ અને ફરી લૉગ ઇન કરો.
• દરેક ક્લિક અને તમે લખેલી દરેક વસ્તુ નોંધો.
• તે ટ્રિગર કરે તે સૌથી ટૂંકો માર્ગ શોધો.
• બીજું બ્રાઉઝર કે account અજમાવો. જો તે ફક્ત એક user માટે થાય, તો તે મોટો સંકેત છે.

આ વિશે વધુ માટે, AI વડે બનેલી એપને કેવી રીતે debug કરવી જુઓ.

પગલું 2: ચોક્કસ શીર્ષક લખો

શીર્ષકે શું ખોટું છે અને ક્યાં તે કહેવું જોઈએ, જેથી યાદી સ્કેન કરનાર જાણે કે તે કયો bug છે.

પગલું 3: ચોક્કસ પગલાં યાદી કરો

તેમને ક્રમાંક આપો. શબ્દશઃ રહો: કયું પેજ, કયું બટન, તમે શું લખ્યું.

1. Customer તરીકે લૉગ ઇન કરો (test account: customer@example.com).
2. "Starter kit" ને cart માં ઉમેરો.
3. discount code WELCOME10 લખો અને Apply પર ક્લિક કરો.
4. Checkout પર ક્લિક કરો.

"કોડ સાથે checkout કરીને જુઓ" એવું લખવાથી તે વિગતો છૂટી જાય છે જે ઘણી વાર મહત્વની હોય છે: કયો user, કયું ઉત્પાદન, કયો કોડ, અને કોડ પહેલાં લાગુ થયો કે નહીં.

પગલું 4: અપેક્ષિત વિરુદ્ધ વાસ્તવિક

આ report નો મુખ્ય ભાગ છે. બંને કહો, કારણ કે તફાવત જ bug છે.

• અપેક્ષિત: Checkout પેજ ખૂલે, કુલ રકમમાં 10% છૂટ બતાવતું.
• વાસ્તવિક: બટન એક સેકન્ડ માટે spinner બતાવે, પછી કંઈ થતું નથી. Discount code વગર checkout કામ કરે છે.

"અપેક્ષિત" વગર વાંચનારને ખબર ન પડે કે વર્તન ખોટું છે. "વાસ્તવિક" વગર તેમને ખબર ન પડે કે શું જોવું.

પગલું 5: ભૂલો બરાબર કૉપી કરો

ભૂલ સંદેશો કારણ સુધી પહોંચવાનો સૌથી ઝડપી રસ્તો છે. તેમને લખાણ તરીકે, શબ્દશઃ કૉપી કરો — પેરાફ્રેઝ ન કરો.

તેમને ક્યાંથી શોધવા:

• સ્ક્રીન પર: એપ બતાવે તે કોઈ પણ સંદેશ.
• બ્રાઉઝર console: developer tools ખોલો (F12, અથવા જમણું-ક્લિક → Inspect) અને લાલ લીટીઓ માટે Console ટૅબ જુઓ.
• Network tab: developer tools માં, નિષ્ફળ થયેલી વિનંતી શોધો અને તેનું URL અને status code નોંધો (દાખલા તરીકે POST /api/checkout → 500).
• સર્વર logs, જો તમારી પાસે access હોય.

TypeError: Cannot read properties of undefined (reading 'percent') at checkout.ts:48 જેવી લીટી ઘણી વાર સીધી સમસ્યા તરફ ઇશારો કરે છે.

પગલું 6: સંદર્ભ ઉમેરો

• ક્યાં: પેજનું URL, વાતાવરણ (preview, staging કે live).
• કોણ: કયો user કે ભૂમિકા — admin, member, લૉગ આઉટ.
• ઉપકરણ અને બ્રાઉઝર: "iPhone પર Safari" વિરુદ્ધ "Windows પર Chrome" મહત્વનું હોઈ શકે.
• ડેટા: રેકોર્ડ વિશે કોઈ અસામાન્ય બાબત — ખૂબ લાંબો text, ખાસ અક્ષરો, મોટી સંખ્યામાં વસ્તુઓ.
• ક્યારે શરૂ થયું: "discount codes માં ગઈ કાલના ફેરફાર પછી" સોનું છે.
• કેટલી વાર: દરેક વખતે, કે દસમાંથી એક વાર.

પગલું 7: બતાવો

સમસ્યા ગોળ કરેલો સ્ક્રીનશૉટ, અથવા ટૂંકું સ્ક્રીન રેકોર્ડિંગ, અસ્પષ્ટતા દૂર કરે છે — ખાસ કરીને layout bugs માટે. જો તમારું AI સાધન છબીઓ સ્વીકારે, તો એક જોડો. ખાનગી બાબત કાપી કાઢો, keys અને બીજા લોકોના ડેટા સહિત.

AI builder માટે bug reports લખવા

આ જ રચના prompt તરીકે કામ કરે છે. બે ઉમેરણો મદદ કરે છે:

• કહો કે શું બદલાવું ન જોઈએ, જેથી ફિક્સ નવી સમસ્યા ન બનાવે.
• ફિક્સ લખવાને બદલે તેને ચકાસવા કહો.

Customer તરીકે લૉગ ઇન, "Starter kit" cart માં અને WELCOME10 કોડ લાગુ, Checkout પર ક્લિક કરવાથી કંઈ થતું નથી. અપેક્ષિત: કુલ રકમમાં 10% છૂટ સાથે checkout પેજ ખૂલે. વાસ્તવિક: ટૂંકો spinner, પછી કંઈ નહીં. Network tab માં POST /api/checkout 500 પરત આપે છે. કોડ વગર checkout કામ કરે છે. કારણ શોધો અને ઠીક કરો, કોડ વગરના ઓર્ડર માટે કિંમતો કેવી રીતે ગણાય છે તે બદલ્યા વિના. પછી ટકાવારીવાળો કોડ, નિશ્ચિત રકમવાળો કોડ અને કોડ વગર checkout ચકાસો.

જો તમને કારણ વિશે ખાતરી ન હોય, તો પહેલાં નિદાન માંગો:

અત્યારે code બદલશો નહીં. આ report ના આધારે, સંભવિત કારણો કયા છે, અને દરેકની પુષ્ટિ શું કરશે?

સામાન્ય ભૂલો

• "તે તૂટેલું છે." પગલાં નહીં, અપેક્ષિત પરિણામ નહીં, કાર્ય કરવા માટે કંઈ નહીં.
• એક report માં ઘણા bugs. કેટલાક ઠીક થાય, બીજા ખોવાઈ જાય.
• પેરાફ્રેઝ કરેલી ભૂલો. "કોઈ undefined વસ્તુ" ઉપયોગી ભાગ છુપાવે છે.
• user કે ભૂમિકા ચૂકી જવી. ઘણા bugs ફક્ત admins પર, અથવા ફક્ત નવા users પર અસર કરે છે.
• સમસ્યાને બદલે ફક્ત તમે ઇચ્છો તે ફિક્સનું વર્ણન ("null check ઉમેરો").
• સ્ક્રીનશૉટ કે પેસ્ટ કરેલા logs માં secrets શેર કરવા.

Checklist

• મેં bug ફરી ઉભો કર્યો અને સૌથી ટૂંકા પગલાં શોધ્યા.
• શીર્ષક કહે છે કે શું ખોટું છે અને ક્યાં.
• પગલાં ક્રમાંકિત અને શબ્દશઃ છે.
• અપેક્ષિત અને વાસ્તવિક બંને કહેલાં છે.
• ભૂલ સંદેશા બરાબર કૉપી કર્યા છે, નિષ્ફળ વિનંતી અને status code સહિત.
• પેજ, વાતાવરણ, user, ઉપકરણ અને બ્રાઉઝર શામેલ છે.
• મેં કહ્યું કે તે કેટલી વાર થાય છે અને ક્યારે શરૂ થયું.
• સ્ક્રીનશૉટ કે રેકોર્ડિંગ જોડેલું છે, ખાનગી ડેટા દૂર કરીને.
• દરેક report માં એક bug.

Mythex ના agent ને bugs ની જાણ

Mythex પ્રોજેક્ટમાં, report જ prompt છે. કેટલીક સુવિધાઓ મદદ કરે છે:

• Preview અથવા ભૂલ સ્ક્રીનનો સ્ક્રીનશૉટ જોડો — દરેક સંદેશમાં 5 ફાઇલ સુધી.
• /fix agent ને bug ઠીક કરવા પર કેન્દ્રિત કરે છે; Plan મોડ તેને સંપાદન પહેલાં તપાસ કરવા દે છે.
• /test agent ને preview માં જ flows ફરી ઉભા કરાવે છે અને તે શું જુએ છે તે જણાવે છે.
• આ બિંદુ પર પાછા જાઓ એ ફિક્સને ઉલટાવે છે જેણે વસ્તુઓ વધુ ખરાબ કરી.

Docs નું prompts વડે debugging પેજ એ જ પગલાં / અપેક્ષિત / વાસ્તવિક રચના વાપરે છે. તેની આસપાસના ફિક્સ-અને-ચકાસણી લૂપ માટે, AI વડે બનેલી એપ પર કેવી રીતે iterate કરવું જુઓ.

પ્રશ્નો