उदाहरणों के साथ बग रिपोर्ट कैसे लिखें

बग रिपोर्ट क्या है? आपको एक अच्छी बग रिपोर्ट की आवश्यकता क्यों है?

बग रिपोर्ट STLC में एक महत्वपूर्ण दस्तावेज़ है जो परीक्षण टीम को कई लाभ प्रदान करता है। यह सॉफ़्टवेयर परीक्षण के दौरान पाए गए सभी दोषों, कई बग, त्रुटियों और अन्य विसंगतियों का ट्रैक रखता है और उनकी रिपोर्ट करता है।

इस परीक्षण-पश्चात दस्तावेजीकरण का उद्देश्य संबंधित पेशेवरों की टीम को परीक्षण प्रक्रिया के दौरान सामने आई त्रुटियों के स्तर के बारे में जानकारी प्रदान करना है।

आपका सॉफ्टवेयर विकास इंजीनियर इस प्रकार की रिपोर्ट का उपयोग करके सॉफ़्टवेयर में मौजूद सभी दोषों और समस्याओं के बारे में जागरूक किया जा सकता है। यह आपको यह पता लगाने में भी मदद करता है कि बग में क्या गड़बड़ है, ताकि आप इसे ठीक करने के लिए सबसे अच्छी विधि का उपयोग कर सकें। यह बग और समस्याओं को पकड़ने में आपकी मदद करके आपका समय और पैसा बचाने में भी मदद करता है।

आपको अच्छे बग स्पष्टीकरण की परवाह क्यों करनी चाहिए?

एक अच्छी, विस्तृत सॉफ्टवेयर बग रिपोर्ट लिखने के लिए आपको निम्नलिखित बिंदुओं पर विचार करना होगा:

• यह भविष्य में इसी प्रकार के बग से बचने में सहायता करने के लिए एक मार्गदर्शक के रूप में कार्य करता है।
• संचार (ई-मेल, कॉल) के लिए समय बचाएं।
• Less डेवलपर्स के लिए काम करें (वे ठीक वही करेंगे जो आप चाहते हैं)।
• परियोजना में बाधाएं कम होंगी; त्रुटियों को तेजी से और अधिक कुशल तरीके से ठीक किया जा सकेगा।

बग रिपोर्ट कैसे लिखें (बग रिपोर्ट टेम्पलेट)

कोई सटीक बग रिपोर्ट टेम्प्लेट नहीं है, क्योंकि यह आपके बग-ट्रैकिंग सिस्टम पर निर्भर करता है। आपका टेम्प्लेट अलग हो सकता है।

हालाँकि, जब आप बग रिपोर्ट लिखना चाहते हैं तो निम्नलिखित सामान्य फ़ील्ड की हमेशा आवश्यकता होती है:

• बग आईडी/ शीर्षक.
• गंभीरता और प्राथमिकता.
• विवरण
• वातावरण
• प्रजनन के चरण।
• अपेक्षित परिणाम.
• वास्तविक परिणाम.
• अनुलग्नक (स्क्रीनशॉट, वीडियो, पाठ)

आइये इन सभी बग-टैकिंग घटकों को एक-एक करके देखें:

1) शीर्षक/बग आईडी:

हर बग को एक विशिष्ट पहचान संख्या दी जानी चाहिए। बग रिपोर्टिंग टूल में नए बग के लिए विशिष्ट संख्या होनी चाहिए ताकि हम बग को आसानी से पहचान सकें।

उदाहरण:

❌ खराब: "जब मैं दोबारा देखता हूं तो मैं उत्पाद नहीं देख पाता, शायद यह दिखाई ही नहीं देता।"

• अस्पष्ट
• आक्रामक
• बहुत शब्दाडंबरपूर्ण

समाधान लागू करने की मांग की गई।

✅ अच्छा: "कार्ट - कार्ट में जोड़े गए नए आइटम जो दिखाई नहीं देते हैं"।

• इस तरह का शीर्षक तुरंत मुद्दे का पता लगाता है (CART)
• यह वास्तविक तकनीकी समस्या पर केंद्रित है।

2) बग की गंभीरता:

बग रिपोर्ट में बग की गंभीरता एक बहुत ही महत्वपूर्ण कारक है। यह एप्लिकेशन के प्रदर्शन पर दोष के प्रभाव का वर्णन करता है।

• अवरोधक: इस त्रुटि के कारण ऐप विफल हो जाता है।
• मेजर: एक गंभीर त्रुटि व्यवसाय तर्क में एक बड़े परिवर्तन का संकेत देती है।
• माइनर: एक समस्या जो अनुप्रयोग की कार्यक्षमता को प्रभावित नहीं करती है लेकिन अपेक्षित परिणामों को प्रभावित करती है।
• मामूली: इससे ऐप की कार्यक्षमता या संचालन पर कोई असर नहीं पड़ता। यह टाइपोग्राफिकल त्रुटि हो सकती है।

3) बग प्राथमिकता:

बग प्राथमिकता तय करने के लिए सामान्य क्रम निम्नलिखित है:

• उच्च: यह उन सभी चीजों को कवर करता है जो प्रवाह को प्रभावित करती हैं या ऐप के उपयोग को अवरुद्ध करती हैं।
• मध्यम: इससे उपयोगकर्ता के अनुभव पर प्रतिकूल प्रभाव पड़ता है।
• माइनर: अन्य सभी त्रुटियाँ जैसे (टाइपिंग त्रुटियाँ, आइकन गायब होना, लेआउट समस्याएँ, आदि).

4) पर्यावरण:

बग किसी खास माहौल में ही दिखाई दे सकता है, अन्य जगहों पर नहीं। उदाहरण के लिए, कभी-कभी वेबसाइट चलाते समय बग दिखाई देता है Firefox, या ऐप केवल तभी खराब होता है जब इसे किसी डिवाइस पर चलाया जाता है Android डिवाइस और iPhone पर ठीक काम कर रहा है।

इन बग रिपोर्ट को केवल क्रॉस-ब्राउज़र या क्रॉस-डिवाइस परीक्षण के साथ ही पहचाना जा सकता है। इसलिए, बग की रिपोर्ट करते समय, QAs को यह निर्दिष्ट करने में सक्षम होना चाहिए कि बग को एक या अधिक विशिष्ट वातावरण में देखा जाना चाहिए या नहीं।

5) सारांश:

हालाँकि, बग रिपोर्ट में सिर्फ़ शीर्षक जोड़ने से उद्देश्य पूरा नहीं होता। इसलिए, अगर आपका शीर्षक पर्याप्त नहीं है, तो आप एक संक्षिप्त रिपोर्ट सारांश जोड़ सकते हैं।

बग कब और कैसे हुआ, यह बताते हुए यथासंभव कम शब्दों में अपना सारांश लिखें। आपके शीर्षक और बग विवरण का भी खोजों में उपयोग किया जाना चाहिए, इसलिए आपको यह सुनिश्चित करना चाहिए कि आपने महत्वपूर्ण कीवर्ड शामिल किए हैं।

उदाहरण:

• खराब: "मैं परीक्षण में कुछ चीज़ें जोड़ने की कोशिश कर रहा था, और जब मैंने ऐसा किया या बटन पर क्लिक किया तो कुछ भी दिखाई नहीं दिया।"
• अच्छा है: "जब मैंने शॉपिंग कार्ट में [PRODUCT] जोड़ने की कोशिश की, लेकिन जब मैंने विशिष्ट उत्पाद अवलोकन वेबपेज पर 'जोड़ें' बटन पर क्लिक किया तो कुछ नहीं हुआ।"

6) पुनरुत्पादन के चरण:

बग की रिपोर्ट करते समय, इसे पुन: पेश करने के लिए चरणों को निर्दिष्ट करना महत्वपूर्ण है। आपको उन क्रियाओं को भी शामिल करना चाहिए जो बग का कारण बन सकती हैं। यहाँ, कोई सामान्य कथन न करें।

निम्नलिखित चरणों का स्पष्ट उल्लेख करें:

यहाँ, अच्छी तरह से लिखित प्रक्रिया का एक उदाहरण है:

चरण:

1. उत्पाद X1 का चयन करें.
2. कार्ट में जोड़ें पर क्लिक करें.
3. उत्पाद को कार्ट से हटाने के लिए हटाएँ पर क्लिक करें।

7) अपेक्षित परिणाम:

बग रिपोर्ट में, तकनीकी कार्य, परीक्षण मामले के परिणाम डिज़ाइन या परीक्षक की राय के अनुसार अपेक्षित परिणाम का वर्णन करना महत्वपूर्ण है। यह सब डेवलपर्स को आवश्यक जानकारी को जल्दी से खोजने पर ध्यान केंद्रित करने में मदद करता है।

उदाहरण के लिए:

"सबमिट" बटन पर क्लिक करने के बाद आवश्यक फ़ील्ड लाल रंग में हाइलाइट की जानी चाहिए।

8) वास्तविक परिणाम:

जैसा कि इसके नाम से पता चलता है, यह फ़ील्ड बग के वास्तविक प्रभाव का वर्णन करता है। वास्तविक परिणाम का स्पष्ट विवरण लिखना बहुत महत्वपूर्ण है।

उदाहरण के लिए:

“सबमिट” बटन पर क्लिक करने के बाद आवश्यक फ़ील्ड हरे रंग में हाइलाइट हो जाती हैं।

9) संलग्नक (स्क्रीनशॉट और वीडियो):

बग रिपोर्टों में, बग रिपोर्टों के साथ फ़ाइलें संलग्न करना सर्वोत्तम अभ्यास है, जिससे जानकारी को समझना आसान हो जाता है, जब आपको इसे दृश्य रूप से प्रदर्शित करने की आवश्यकता होती है:

उदाहरण के लिए:

• स्क्रीनशॉट: स्क्रीनशॉट से प्रोग्राम में गलतियों को आसानी से दर्शाया जा सकता है; यह सुविधाजनक होता है जब बग को किसी विशिष्ट एनोटेशन, वृत्त या तीर की छवि के साथ हाइलाइट किया जाता है)।
• वीडियो: कभी-कभी, शब्दों में बग का वर्णन करना कठिन होता है, इसलिए वीडियो बनाना बेहतर होता है ताकि डेवलपर प्रोग्राम में दोष को ठीक कर सके)।

10) प्रभावित संस्करण:

यह प्रभावित सॉफ्टवेयर संस्करण है जहां बग की रिपोर्ट की जाती है।

11) फिक्स संस्करण:

यह वह सॉफ़्टवेयर संस्करण है जिसमें बग का समाधान किया जाता है। इसलिए जब बग की रिपोर्ट करने वाला QA जाँचता है कि बग ठीक हो गया है या नहीं, तो वह सही सॉफ़्टवेयर संस्करण का उपयोग करता है।

12) Target संस्करण:

वह लक्ष्य संस्करण जहाँ बग को ठीक करने के लिए लक्षित किया जाना चाहिए। इसलिए, जब विकास टीम बग को ठीक करने पर काम करती है, तो वे ज्यादातर एक विशेष एप्लिकेशन संस्करण को लक्षित करते हैं।

13) बंद होने की तिथि:

यह वह तारीख है जब सॉफ़्टवेयर परीक्षण टीम द्वारा बग को बंद कर दिया जाता है। बग को बंद करना सॉफ़्टवेयर परीक्षण का एक महत्वपूर्ण और अभिन्न अंग है।

14) स्थिति:

जब कोई नया बग बनाया जाता है, तो उसकी स्थिति खुली होनी चाहिए। उसके बाद, यह प्रगति में, ठीक किया गया, चल रहा है, फिर से खोलें आदि जैसे चरणों से गुजरता है।

बग रिपोर्ट लिखने के लिए सुझाव

यहां कुछ महत्वपूर्ण सुझाव दिए गए हैं जिन्हें आपको प्रभावी बग रिपोर्ट लिखते समय याद रखना चाहिए:

• बग रिपोर्ट बनाते समय विशिष्ट रहें। सुनिश्चित करें कि आप कोई बेकार या अप्रासंगिक तथ्य शामिल न करें।
• जैसे ही बग का पता चले, आपको तुरंत इसकी रिपोर्ट करनी चाहिए।
• डेवलपर को समस्या को सुलझाने के लिए तथ्यों और जानकारी का उपयोग करने में सक्षम बनाने के लिए रिपोर्ट को विस्तार से तैयार करें।
• आपको सत्यापन के लिए उसी बग की घटना का परीक्षण अन्य समान मॉड्यूलों पर करना चाहिए।
• Revबग रिपोर्ट सबमिट करने से पहले उसे कम से कम एक बार अवश्य देखें।
• आपको यह सुनिश्चित करना चाहिए कि बग रिपोर्ट में केवल एक त्रुटि का विवरण हो।
• अंत में, यदि आपको किसी बात के बारे में अस्पष्टता महसूस हो तो आपको प्रोजेक्ट मैनेजर से मदद मांगने में डरना नहीं चाहिए।

बग रिपोर्टिंग उपकरण

बग रिपोर्टिंग प्रक्रिया, जो पहले मैन्युअल रूप से की जाती थी, अब बाजार में उपलब्ध विभिन्न बग रिपोर्टिंग टूल्स के साथ की जा रही है।

• जिरा
• ज़ोहो बग ट्रैकर
• बगजिला

आप हमारी विस्तृत समीक्षा देख सकते हैं सर्वोत्तम बग रिपोर्टिंग टूल.

बग रिपोर्ट लिखते समय आम समस्या और समाधान:

बग रिपोर्ट लिखते समय कुछ सामान्य समस्याएं और उनके समाधान यहां दिए गए हैं:

बग रिपोर्ट उदाहरण	मुसीबत
2 को 3 से गुणा करने पर उत्तर सकारात्मक होगा।	पैटर्न की रिपोर्ट करें, उदाहरण की नहीं।
इससे बचने के लिए नया आइटम जोड़ते समय सूची को वर्णानुक्रम में व्यवस्थित किया जाएगा।	केवल यह मत बताइए कि क्या गलत है
उदाहरण के लिए: शुरू करने के लिए, आपको अपना ब्राउज़र खोलना होगा और साइट का URL टाइप करना होगा। आपको पहला फ़ील्ड, 'यूजरनेम', गलत वर्तनी वाला मिलेगा।	हमेशा सीधे मुद्दे पर आएं (कभी भी कहानी न सुनाएं!)
रिपोर्ट में क्लाइंट का नाम गलत लिखा गया है। प्राथमिकता: उच्च, गंभीरता: उच्च	प्राथमिकता और गंभीरता को कभी भी मिश्रित न करें।
कर गणना सूत्र गलत है!!??	CAPS, लाल अक्षर, लाल वृत्त, '!' का प्रयोग न करें,
मुझे नहीं लगता कि होम पेज का डिज़ाइन अच्छा है।	अपने विवेक का प्रयोग मत करो.
अस्पष्ट विवरण का उदाहरण: आज की हमारी चर्चा के बारे में, कृपया इस पृष्ठ के लिए आवश्यक कार्रवाई करें।	अपना विवरण सभी के लिए समझने योग्य बनाएं।
पृष्ठ की पृष्ठभूमि नीली, नारंगी या हरी होनी चाहिए, या आप इसे काला या सफेद भी बना सकते हैं। यह अच्छा नहीं है क्योंकि यह स्पष्ट नहीं है कि वेब विकास और डिजाइन टीम से क्या अपेक्षित है	विकल्पों को न्यूनतम करें
कर गणना सूत्र कभी-कभी अपेक्षानुसार काम नहीं करता।	सुनहरा नियम: 'कभी-कभी' शब्द का प्रयोग न करें।

बग रिपोर्ट का उदाहरण

बग रिपोर्ट का एक छोटा सा उदाहरण यहां दिया गया है:

[मेरा खाता] अपडेट बटन पर माउस ले जाने पर रेखांकन प्रदर्शित होता है।

Descriptआयन: हमें मेरा खाता अनुभाग में अपडेट बटन पर माउस ले जाते समय रेखांकन को हटाना होगा।

लिंक: http://test.com/mv-account/

ब्राउज़र/ओएस: क्रोम 25. OSX योसेमाइट 10.10.2

प्रजनन के चरण:

1. www.test.com पर जाएं

2. लॉगिन क्रेडेंशियल के माध्यम से लॉगिन करें

3. मेरा खाता पर जाएँ

4. अपडेट बटन पर माउसओवर करें

वास्तविक परिणाम: वहाँ एक रेखांकन है.

अपेक्षित परिणाम: कोई रेखांकन नहीं.

लॉग इन डेटा: test@test.com / mysecretpass12

बग रिपोर्ट लिखते समय गलतियों से बचना चाहिए

बग रिपोर्ट लिखते समय आपको कुछ महत्वपूर्ण गलतियों से बचना चाहिए:

• अपने असंतोष के बारे में न लिखें और अपनी व्यक्तिगत भावनाओं को कभी भी शामिल न करें।
• जब आप अपनी पोस्ट में बहुत सारे इमोटिकॉन्स डाल देते हैं तो इससे उन लोगों को परेशानी होती है जो अपने काम पर ध्यान केंद्रित करना चाहते हैं।
• अपनी पोस्ट को कभी भी विस्मयादिबोधक चिह्नों से अधिक न भरें; इससे काम में तेजी नहीं आती।
• कोई भी व्यक्ति नाराज़ नहीं होना चाहता। इससे प्रेरणा नष्ट हो जाती है और समस्या का एहसास धीमा हो जाता है।