चांगला बग रिपोर्ट कसा लिहायचा (AI किंवा developer साठी)

चांगला बग रिपोर्ट एखाद्या दुसऱ्या व्यक्तीला — developer किंवा AI ला — तुम्ही पाहिलीच समस्या पाहू देतो, आणि तुम्हाला काहीही विचारण्याची गरज पडत नाही. त्याला एक ठोस शीर्षक, ती पुन्हा घडवण्याच्या नेमक्या पायऱ्या, तुम्हाला काय अपेक्षित होते, प्रत्यक्षात काय घडले, शब्दशः कॉपी केलेला कोणताही error संदेश, आणि ते कुठे घडले हे लागते: कोणते पान, browser, device आणि वापरकर्ता. एका रिपोर्टमध्ये एकच बग ठेवा, आणि मदत होत असल्यास स्क्रीनशॉट जोडा.

बहुतेक बग समजायला दुरुस्त करण्यापेक्षा जास्त वेळ लागतो. स्पष्ट रिपोर्ट समजण्याचा भाग काढून टाकतो. AI साधनांसह हे आणखी महत्त्वाचे आहे: "checkout विचित्र वाटतंय" म्हणजे तुम्हाला काय म्हणायचे होते हे AI नंतर विचारू शकत नाही, त्यामुळे ते अंदाज लावते — आणि चुकीचा अंदाज दुसरे काहीतरी तोडू शकतो.

टेम्पलेट

हे कॉपी करा आणि भरा:

शीर्षक: [काय चुकले आहे, कुठे] — उदा. "Booking form संध्याकाळी 6 नंतरच्या वेळा नाकारतो"

समस्या पुन्हा घडवण्याच्या पायऱ्या:
1. ...
2. ...
3. ...

अपेक्षित: [काय घडायला हवे होते]
प्रत्यक्ष: [त्याऐवजी काय घडले]

Error संदेश: [नेमका मजकूर, असल्यास]
कुठे: [पान/URL, browser, device, कोणत्या वापरकर्त्याच्या नावाने login]
किती वेळा: [प्रत्येक वेळी / कधीकधी / एकदाच]
स्क्रीनशॉट किंवा रेकॉर्डिंग: [जोडलेले]

उरलेले मार्गदर्शक प्रत्येक भाग समजावते.

पायरी 1: आधी पुन्हा घडवा

लिहिण्यापूर्वी बग पुन्हा घडवण्याचा प्रयत्न करा. कोणत्या पायऱ्या महत्त्वाच्या आहेत आणि ते प्रत्येक वेळी घडते का, ते तुम्हाला कळेल.

स्वच्छ स्थितीपासून सुरुवात करा: refresh करा, किंवा log out करून पुन्हा log in करा.
प्रत्येक क्लिक आणि तुम्ही टाइप केलेली प्रत्येक गोष्ट नोंदवा.
तो घडवणारा सर्वात लहान मार्ग शोधा.
दुसरा browser किंवा खाते वापरून पाहा. फक्त एका वापरकर्त्यासाठी घडत असेल, तर तो मोठा सुगावा आहे.

याबद्दल अधिक माहितीसाठी, AI ने बनवलेल्या ॲपमधील बग कसे शोधायचे पहा.

पायरी 2: ठोस शीर्षक लिहा

शीर्षकात काय चुकले आहे आणि कुठे ते सांगितले पाहिजे, म्हणजे यादी चाळणाऱ्याला कोणता बग आहे हे कळेल.

कमकुवत	ठोस
Checkout तुटले	Cart मध्ये discount code असताना Checkout बटण काहीच करत नाही
Mobile समस्या	400px पेक्षा कमी रुंदीच्या फोनवर pricing cards स्क्रीनबाहेर जातात
Save करताना error	नावात emoji असलेले profile save केल्यावर "500 Internal Server Error" दिसतो

पायरी 3: नेमक्या पायऱ्या यादीत लिहा

त्यांना क्रमांक द्या. शब्दशः रहा: कोणते पान, कोणते बटण, तुम्ही काय टाइप केले.

Customer म्हणून log in करा (चाचणी खाते: customer@example.com).
"Starter kit" cart मध्ये टाका.
Discount code WELCOME10 टाका आणि Apply क्लिक करा.
Checkout क्लिक करा.

"Code वापरून checkout करून पाहा" असे लिहिल्यास अनेकदा महत्त्वाचे तपशील गहाळ होतात: कोणता वापरकर्ता, कोणते उत्पादन, कोणता code, आणि तो आधी लागू झाला होता का.

पायरी 4: अपेक्षित विरुद्ध प्रत्यक्ष

हा रिपोर्टचा गाभा आहे. दोन्ही सांगा, कारण फरकच बग आहे.

अपेक्षित: Checkout पान एकूण रकमेवर दाखवलेल्या 10% सवलतीसह उघडते.
प्रत्यक्ष: बटणावर एक सेकंद spinner फिरतो, आणि मग काहीच होत नाही. Discount code नसताना checkout व्यवस्थित चालते.

"अपेक्षित" नसल्यास वाचकाला वर्तन चुकीचे आहे हे कदाचित कळणार नाही. "प्रत्यक्ष" नसल्यास काय शोधायचे हे कळणार नाही.

पायरी 5: Error जसेच्या तसे कॉपी करा

Error संदेश कारणापर्यंत पोहोचण्याचा सर्वात जलद मार्ग आहे. ते मजकूर म्हणून, शब्दशः कॉपी करा — शब्द बदलू नका.

ते कुठे मिळतील:

स्क्रीनवर: ॲप दाखवणारा कोणताही संदेश.
Browser console: developer tools उघडा (F12, किंवा उजवे-क्लिक → Inspect) आणि लाल ओळींसाठी Console टॅब पाहा.
Network टॅब: developer tools मध्ये अयशस्वी झालेली विनंती शोधा आणि तिचा URL आणि status code नोंदवा (उदाहरणार्थ POST /api/checkout → 500).
Server logs, तुमच्याकडे प्रवेश असल्यास.

TypeError: Cannot read properties of undefined (reading 'percent') at checkout.ts:48 सारखी ओळ अनेकदा थेट समस्येकडे निर्देश करते.

पायरी 6: संदर्भ जोडा

कुठे: पानाचा URL, वातावरण (preview, staging किंवा live).
कोण: कोणता वापरकर्ता किंवा भूमिका — admin, सदस्य, log out केलेला.
Device आणि browser: "iPhone वरील Safari" विरुद्ध "Windows वरील Chrome" महत्त्वाचे असू शकते.
डेटा: रेकॉर्डबद्दल काहीही असामान्य — खूप लांब मजकूर, विशेष अक्षरे, मोठ्या संख्येने आयटम्स.
ते कधी सुरू झाले: "कालच्या discount codes मधील बदलानंतर" हे सोन्यासारखे आहे.
किती वेळा: प्रत्येक वेळी, किंवा दहापैकी एकदा.

पायरी 7: ते दाखवा

समस्या वर्तुळ केलेला स्क्रीनशॉट, किंवा छोटे screen recording, संदिग्धता काढून टाकते — विशेषतः layout बग्जसाठी. तुमची AI साधने प्रतिमा स्वीकारत असतील तर एक जोडा. गुपिते आणि इतर लोकांचा डेटा यासह खाजगी असलेले सर्व काही कापून टाका.

AI बिल्डरसाठी बग रिपोर्ट लिहिणे

तीच रचना prompt म्हणूनही काम करते. दोन भर उपयोगी आहेत:

काय बदलता कामा नये ते सांगा, म्हणजे दुरुस्तीमुळे नवी समस्या निर्माण होणार नाही.
फक्त लिहिण्याऐवजी दुरुस्ती तपासण्यास सांगा.

वापरकर्ता म्हणून log in असताना, cart मध्ये "Starter kit" आहे आणि WELCOME10 code लागू केला आहे, Checkout क्लिक केल्यावर काहीच होत नाही. अपेक्षित: एकूण रकमेवर 10% सवलतीसह checkout पान उघडते. प्रत्यक्ष: एक क्षणिक spinner, आणि मग काहीच नाही. Network टॅबमध्ये POST /api/checkout ने 500 परत दिले. Code नसताना checkout व्यवस्थित चालते. कारण शोधा आणि दुरुस्त करा, पण code नसलेल्या ऑर्डरसाठी किंमती कशा मोजल्या जातात ते बदलू नका. मग टक्केवारीचा code, ठराविक रकमेचा code आणि code नसताना checkout तपासा.

कारण अनिश्चित असेल तर आधी निदान मागा:

आत्ताच code बदलू नका. या रिपोर्टनुसार, संभाव्य कारणे कोणती आहेत, आणि प्रत्येकाची पुष्टी काय करेल?

सामान्य चुका

"हे तुटले आहे." पायऱ्या नाहीत, अपेक्षित निकाल नाही, कारवाई करण्यासारखे काहीच नाही.
एका रिपोर्टमध्ये अनेक बग. काही दुरुस्त होतात, इतर हरवतात.
Error चे पुनर्लेखन. "काही undefined गोष्ट" उपयुक्त भाग लपवते.
वापरकर्ता किंवा भूमिका नमूद न करणे. अनेक बग फक्त admins किंवा नवीन वापरकर्त्यांवर परिणाम करतात.
समस्येऐवजी तुम्हाला हवी असलेली दुरुस्तीच वर्णन करणे ("null check जोडा").
Screenshots किंवा पेस्ट केलेल्या logs मध्ये गुपिते शेअर करणे.

चेकलिस्ट

मी बग पुन्हा घडवला आणि सर्वात लहान पायऱ्या शोधल्या.
शीर्षक सांगते की काय चुकले आणि कुठे.
पायऱ्या क्रमांकित आणि शब्दशः आहेत.
अपेक्षित आणि प्रत्यक्ष दोन्ही लिहिले आहेत.
Error संदेश नेमके कॉपी केले आहेत, अयशस्वी विनंती आणि status code सह.
पान, वातावरण, वापरकर्ता, device आणि browser समाविष्ट आहेत.
ते किती वेळा घडते आणि ते कधी सुरू झाले ते लिहिले आहे.
स्क्रीनशॉट किंवा रेकॉर्डिंग जोडले आहे, खाजगी डेटा काढून टाकून.
प्रत्येक रिपोर्टमध्ये एकच बग.

Mythex च्या agent ला बग नोंदवणे

Mythex प्रोजेक्टमध्ये, रिपोर्टच prompt आहे. काही वैशिष्ट्ये मदत करतात:

Preview किंवा error स्क्रीनचा स्क्रीनशॉट जोडा — प्रति संदेश 5 फाइल्सपर्यंत.
/fix agent ला बग दुरुस्त करण्यावर केंद्रित करते; Plan मोड संपादन करण्यापूर्वी तपास करू देतो.
/test agent ला preview मध्येच प्रवाह पुन्हा घडवायला लावते आणि त्याला काय दिसते ते नोंदवते.
Revert to this point परिस्थिती बिघडवणारी दुरुस्ती मागे घेते.

Docs मधील prompts सह debugging पानही त्याच पायऱ्या / अपेक्षित / प्रत्यक्ष रचना वापरते. त्याभोवतीच्या दुरुस्ती-आणि-तपासणी चक्रासाठी, AI ने बनवलेल्या ॲपवर पुनरावृत्ती कशी करायची पहा.

प्रश्न

बग रिपोर्टमध्ये काय असावे?

एक ठोस शीर्षक, समस्या पुन्हा घडवण्याच्या नेमक्या पायऱ्या, तुम्हाला काय अपेक्षित होते, प्रत्यक्षात काय घडले, कोणताही error संदेश जसाच्या तसा, ते कुठे घडले (पान, browser, device, वापरकर्ता), आणि मदत होत असल्यास स्क्रीनशॉट किंवा रेकॉर्डिंग.

AI ॲप बिल्डरसाठी बग रिपोर्ट कसा लिहायचा?

Developer साठी वापरता तीच रचना वापरा: पायऱ्या, अपेक्षित, प्रत्यक्ष आणि नेमका error. काय बदलता कामा नये ते जोडा, आणि दुरुस्ती करून ती तपासण्यास सांगा. "हे तुटले आहे" सारखे अस्पष्ट prompts अंदाजांकडे नेतात.

बग पुन्हा घडवता येत नसेल तर काय?

तरीही नोंदवा, पण तसे स्पष्ट लिहा. तुम्ही काय करत होता, ते केव्हा घडले, वापरकर्ता खाते, आणि तुम्हाला दिसलेला कोणताही error लिहा. ते किती वेळा घडते ते नोंदवा, उदा. दहापैकी एकदा, कारण अधूनमधून येणारे बग अनेकदा वेळेच्या किंवा डेटाच्या समस्येकडे निर्देश करतात.

एका रिपोर्टमध्ये अनेक बग टाकावेत का?

नाही. प्रत्येक रिपोर्टमध्ये एकच बग, म्हणजे प्रत्येकाला स्वतंत्रपणे दुरुस्त, तपासता आणि बंद करता येईल. दोन समस्या संबंधित आहेत असे वाटत असेल, तर प्रत्येक रिपोर्टमध्ये तसे लिहा.