बग रिपोर्ट कैसे संकलित करें

विषय का जवाब "बग रिपोर्ट की तैयारी में सामान्य त्रुटियां । "

बग ट्रैकर में प्रविष्टियां दर्ज करने के लिए प्रत्येक कंपनी के अपने नियम हैं - यह कंपनी की नीति, विकास प्रौद्योगिकी, प्रयुक्त बग ट्रैकर, परियोजना के प्रकार और बहुत कुछ पर निर्भर करता है। लेकिन किसी भी मामले में, एक अच्छी बग रिपोर्ट में कुछ विशेषताएं हैं।

संक्षेप में, एक अच्छी बग रिपोर्ट आपको निम्नलिखित की अनुमति देती है:
1. समस्या को पुन: उत्पन्न करें (यह हमेशा संभव नहीं है, लेकिन हमें प्रयास करना चाहिए)।
2. समस्या और उसके महत्व को समझें।

एक अच्छी बग रिपोर्ट कैसे लिखें?
पहले आपको तैयार करने की आवश्यकता है। यदि आप एक बग ढूंढते हैं, तो तुरंत बग ट्रैकर में न जाएं और "कुछ भी नहीं काम करता है!" लिखें। त्रुटि को पुन: उत्पन्न करें। पुनर्त्पादित? बहुत बढ़िया। खेलने योग्य नहीं है? मतलब, आपने कुछ नहीं माना। याद कीजिए आपने क्या किया था।

फिर से खेला? हुर्रे! अब खेलने के लिए चरणों की संख्या कम से कम करें, सुनिश्चित करें कि कुछ भी नहीं है।
यदि कोई इनपुट डेटा का उपयोग किया जाता है, तो सुनिश्चित करें कि इसमें बहुत अधिक नहीं है (क्या यह पूरी तरह से पाठ का एक टुकड़ा है, जो वास्तव में संपादक को छोड़ रहा है, और इसमें से केवल एक चरित्र नहीं है?)।
जब आप समझते हैं कि किस प्रकार के डेटा और आपके कार्यों से समस्या पैदा होती है, तो संक्षेप में इसका सार बताएं - बग रिपोर्ट शीर्षक के साथ आए। समस्या को उतनी ही विस्तार से और संक्षिप्त रूप से बताएं जितना कि शीर्षक अनुमति देता है, अपनी लंबाई से दूर किए बिना :)
खराब शीर्षक उदाहरण: "क्लिपबोर्ड से टेक्स्ट पेस्ट करने पर सब कुछ लटक जाता है"
"बेहतर" शीर्षक का एक उदाहरण: "संपादक Ctrl + A का उपयोग करके क्लिपबोर्ड से वर्ण N युक्त पाठ को चिपकाते समय" जमा करता है "
सहयोगी : आप अभी भी “क्या” के सिद्धांत का उल्लेख कर सकते हैं? कहाँ? कब? ” ज्यादातर मामलों में, यह एक अच्छा शीर्षक / विस्तृत विवरण लिखने में मदद करता है, उदाहरण के लिए,
क्या: गलत डेटा गणना
कहां: NNN पेज पर
कब: एक में प्रवेश करने के बाद, वाई क्षेत्र एक नकारात्मक मूल्य है।

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

अब बग ट्रैकर खोलें, बग रिपोर्ट फ़ॉर्म भरना शुरू करें।
शीर्षक रिकॉर्ड करें।

कुछ बग ट्रैकर्स में, फ़ील्ड "विस्तृत विवरण" और "प्लेबैक के लिए चरण" अलग हैं, कुछ में वे नहीं हैं।

यदि कोई " विस्तृत विवरण " फ़ील्ड है, तो समस्या का अधिक विस्तार से वर्णन करें - उन विवरणों को निर्दिष्ट करें जिन्हें आपको शीर्षक में छोड़ना था। यदि आप समझते हैं कि समस्या का कारण क्या है (गणना के लिए एक पुराना सूत्र का उपयोग किया जाता है, तो कुछ मूल्य को ध्यान में नहीं रखा जाता है, आदि) - यहां भी सब कुछ लिखें। यदि आप नहीं जानते हैं, तो बेहतर अनुमान नहीं है।
यदि त्रुटि रिकॉर्ड फ़ॉर्म में एक अलग फ़ील्ड प्रभावित संस्करण (उत्पाद का संस्करण जिसमें समस्या दिखाई देती है) नहीं है, तो यहां संस्करण निर्दिष्ट करें।

" खेलने के लिए चरण " - बग रिपोर्ट में भरने के लिए मुख्य क्षेत्र।
उन चरणों को लिखिए जिन्हें आपने पहचाना है। जैसा कि पहले ही उल्लेख किया गया है, समस्या को पुन: उत्पन्न करने के लिए कदम आवश्यक और पर्याप्त होना चाहिए। ज्यादा न लिखें। आवश्यक याद नहीं है :)
चरणों का वर्णन करने के बाद, परिणाम लिखना सुनिश्चित करें - क्या हुआ।
अगला, यहाँ भी अपेक्षित परिणाम का वर्णन करें, यदि आवश्यक हो। बेशक, आपको लिखना नहीं चाहिए "संपादक दुर्घटना नहीं करता है", लेकिन अगर, उदाहरण के लिए, गणना परिणाम अपेक्षित लोगों से नहीं मिलते हैं, तो यह संकेत दिया जाना चाहिए।
इस प्रकार, प्लेबैक के लिए चरणों का वर्णन कुछ इस तरह दिखना चाहिए:

खेलने के लिए कदम:
1. खोलें ...
2. क्लिक करें
3. फ़ील्ड में मान N1 दर्ज करें ...
4. क्षेत्र में मान N2 दर्ज करें ...
4. गणना बटन पर क्लिक करें।

परिणाम:
परिणाम फ़ील्ड V1 प्रदर्शित करता है।

अपेक्षित परिणाम:
परिणाम फ़ील्ड V2 प्रदर्शित करता है।

यदि आपको स्रोत फ़ाइलों, डेटा, डंप, आदि की आवश्यकता है, तो उन्हें तुरंत संलग्न करें। बेशक, फ़ाइलों में केवल त्रुटि को पुन: उत्पन्न करने के लिए आवश्यक जानकारी होनी चाहिए। सभी अनावश्यक को साफ करें।
यदि दृश्य प्रदर्शन में कोई समस्या है, तो एक स्क्रीनशॉट की आवश्यकता है - आप चरणों को पुन: प्रस्तुत किए बिना त्रुटि को समझ सकते हैं। Khizhnyak : स्क्रीनशॉट में, एक त्रुटि के साथ जगह को इंगित करना बेहतर है। एक तीर या सिर्फ विपरीत रंग की एक पट्टी। महान स्क्रीनशॉट के "पढ़ने" को तेज करता है।

लेकिन प्रत्येक बग रिपोर्ट में स्क्रीनशॉट सम्मिलित करना बिल्कुल आवश्यक नहीं है: कृपया, अनावश्यक संस्थाओं का उत्पादन न करें। यदि यह समस्या को पुन: उत्पन्न करने में मदद नहीं करता है, तो इसे बनाने में समय बर्बाद न करें।

वैसे, वीडियो प्लेबैक त्रुटियों के बारे में: यह केवल यह पुष्टि करने में मदद कर सकता है कि समस्या वास्तव में है, बस इसे पुन: प्रस्तुत करना मुश्किल है। लेकिन आप कितनी बार स्क्रीन को पहले से रिकॉर्ड करते हैं? :)

बाकी खेतों के लिए।
गंभीरता, प्राथमिकता।
इन क्षेत्रों की उपस्थिति और इन क्षेत्रों के मान बग ट्रैकर से बग ट्रैकर तक भिन्न होते हैं।
परीक्षक की दृष्टि से गंभीरता बग की महत्वपूर्णता है: एक विशेषता, पाठ में एक टाइपो, एक छोटी सी समस्या, एक महत्वपूर्ण समस्या, एक उत्पाद दुर्घटना, एक अवरुद्ध समस्या, आदि।
प्राथमिकता - जिस समस्या के साथ प्राथमिकता तय की जानी चाहिए।
यदि दोनों क्षेत्र हैं, तो परीक्षक, एक नियम के रूप में, केवल गंभीरता को उजागर करता है, और प्राथमिकता - वरिष्ठ परीक्षक / वरिष्ठ प्रोग्रामर / प्रबंधक या इस मामले के लिए जिम्मेदार किसी अन्य व्यक्ति।
यदि केवल एक क्षेत्र है, तो इसे सेट करें।
"बग लगाने की प्राथमिकता क्या है?" इस सवाल का कोई एक जवाब नहीं है, यह सब प्रत्येक विशिष्ट मामले पर निर्भर करता है। लेकिन कोशिश न करें कि सभी कीड़े को एक पंक्ति में उच्च या महत्वपूर्ण प्राथमिकता में न डालें, वास्तव में परियोजना के लिए उनकी आलोचनात्मकता का मूल्यांकन करें।

पर्यावरण - सभी बग ट्रैकर्स में है। यह हार्डवेयर और सॉफ्टवेयर वातावरण है जिसमें समस्या स्वयं प्रकट होती है।
ऑपरेटिंग सिस्टम के संस्करण को इंगित करें, सर्विस पैक की उपस्थिति, थोड़ी गहराई।
यदि आपकी परियोजना कुछ घटकों पर निर्भर करती है - उनकी उपलब्धता और संस्करण आवश्यक हैं! .NET, JRE / JDK और अन्य एसडीके।
व्याख्या की गई भाषा? दुभाषिया संस्करण - आवश्यक!
वेब प्रोजेक्ट्स के लिए - एक ब्राउज़र, इंस्टॉल किए गए प्लगइन्स, अगर यह प्रोजेक्ट को प्रभावित करता है। यदि एक ब्राउज़र में कुछ काम नहीं करता है, तो जांचें कि क्या यह बाकी हिस्सों में काम करता है।

किस संस्करण में ठीक करना है, किसको असाइन करना है - कंपनी के भीतर पॉलिसी पर निर्भर करता है। पता नहीं क्या रखा? किसी सहकर्मी से पूछें।

लेख टिप्पणियों से सही टिप्पणी के साथ पूरक है।