रिलीज नोट्स लिखने का अच्छा अभ्यास


12

सॉफ्टवेयर के हर संस्करण की डिलीवरी पर हमें एक रिलीज नोट लिखना होगा। उदाहरण के लिए, यहां कुछ शर्तें दी गई हैं जब मैं एक रिलीज नोट लिखता हूं:

  • रिलीज़ की तारीख
  • बग हल किया

क्या यह पर्याप्त है, या कुछ और है?



1
जोड़ा सुविधाओं को मत भूलना
शाफ़्ट फ्रीक

जवाबों:


21

मुझे लगता है कि अनुगमन अच्छी प्रथाओं को एक रास्ता देगा

// तिथि संबंधित

  • रिलीज़ की तारीख

// फीचर संबंधी

  • सुविधाएँ जोड़ा गया
  • फीचर्ड निकाला गया
  • सुविधाएँ बदली गईं

// बग संबंधी

  • हल के कीड़े
  • अनसुलझी कीड़े

// निर्भरता से संबंधित

  • निर्भरता की सूची

// परीक्षण संबंधी

  • यूनिट टेस्ट के परिणाम
  • स्वीकृति परीक्षण के परिणाम

// संस्करण संबंधित नियंत्रण

  • टैग नोट
  • पुनरीक्षण अंक

इसके अलावा कुछ बार चीजों को उजागर करने के लायक है जो अंतिम उपयोगकर्ता अपने कॉन्फ़िगरेशन या वर्कफ़्लो में बदलना चाहते हैं।

अधिकांश अंतिम उपयोगकर्ता परीक्षा परिणाम की परवाह नहीं करते हैं। उन्हें उम्मीद है कि उच्च गुणवत्ता के लिए कोई फर्क नहीं पड़ता कि रिलीज नोट क्या कहता है।

जारी नोटों के बारे में सबसे महत्वपूर्ण बात यह है कि प्रत्येक अतिरिक्त वाक्य पाठकों का 10% खो देता है। इसलिए आपको सख्ती से प्राथमिकता देनी चाहिए कि आपके वर्तमान उपयोगकर्ताओं को रिलीज़ के बारे में क्या जानना चाहिए।


1
यह भी कुछ समय के लिए चीजों को उजागर करने के लायक है जो अंतिम उपयोगकर्ता अपने कॉन्फ़िगरेशन या वर्कफ़्लो में बदलना चाहते हैं
jk।

@jk। हाँ आप सही है। मैंने आपके उत्तर को आपकी अच्छी टिप्पणी के रूप में संपादित किया है।
एमडी महबूबुर्रहमान

अधिकांश अंतिम उपयोगकर्ता परीक्षा परिणाम की परवाह नहीं करते हैं। उन्हें उम्मीद है कि उच्च गुणवत्ता के लिए कोई फर्क नहीं पड़ता कि रिलीज नोट क्या कहता है।
हेनरिक

@ हेनरिक रिलीज़ नोट अंतिम उपयोगकर्ताओं के अलावा अन्य लोगों के लिए उपयोगी हो सकते हैं
jk।

5

जारी नोटों के बारे में सबसे महत्वपूर्ण बात यह है कि प्रत्येक अतिरिक्त वाक्य पाठकों का 10% खो देता है। इसलिए आपको सख्ती से प्राथमिकता देनी चाहिए कि आपके वर्तमान उपयोगकर्ताओं को रिलीज़ के बारे में क्या जानना चाहिए।


4
प्रत्येक पंक्ति में 10% आकस्मिक, निर्बाध (या आलसी) पाठक खो सकते हैं। वे पाठक वे हैं जिनके लिए आपके जारी किए गए नोट्स नहीं लिखे गए हैं। जो आपने किया है उसकी परवाह करते हैं और उन सभी को पढ़ेंगे और प्रत्येक प्रासंगिक पंक्ति के लिए धन्यवाद देंगे - आपको केवल इस बात की सावधानी बरतनी चाहिए कि वास्तव में प्रलेखन में जाने की क्या आवश्यकता है।
gbjbaanb
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.