पहले या दस्तावेज़ पहले रिलीज़ करें?


23

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

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

मुद्दे पर। सुविधाएँ मेरे उपयोगकर्ताओं के लिए महत्वपूर्ण हैं, लेकिन प्रलेखन मेरे लिए महत्वपूर्ण है। जब तक मैं दस्तावेज को फिर से नहीं लिखता, तब तक क्या मुझे इंतजार करना चाहिए? मेरा वर्तमान उपयोगकर्ता आधार यह समझने के लिए पर्याप्त है कि नई सुविधाओं का उपयोग कैसे किया जाए, इसलिए मुझे इस बात की चिंता नहीं है। डॉक्स को खत्म करने में कुछ हफ़्ते लग सकते हैं, क्योंकि मेरे पास इस प्रोजेक्ट पर काम करने के लिए खाली समय है, लेकिन अगर मैं उन्हें किसी भी लंबे समय तक इंतजार करवाता हूं तो समुदाय मुझे थूक पर भून देगा।

क्या ग्राहक इस परिदृश्य में सही है? मौजूदा उपयोगकर्ताओं के लिए एक शानदार, सीधे-फॉरवर्ड फीचर को नए उपयोगकर्ताओं के लिए मजबूत प्रलेखन पर प्राथमिकता देनी चाहिए?


अद्यतन: वाह, इतने सारे महान, उच्च-गुणवत्ता वाली प्रतिक्रियाएं! आपने वास्तव में मुझे एक बेहतर समझ पाने में मदद की है कि मुझे कैसे परियोजना और इसके उपयोगकर्ताओं दोनों के साथ बातचीत और समर्थन करना चाहिए। बहुत - बहुत धन्यवाद!


14
हां, ग्राहक सही है। रिलीज़ को रोल आउट करें, फिर दो सप्ताह का समय बिताकर प्रलेखन प्राप्त करें। आपने हमें पहले ही बता दिया था कि उपयोगकर्ता आधार प्रलेखन की कमी से प्रतिकूल रूप से प्रभावित होने वाला नहीं है, और यह केवल दो और सप्ताह है। यदि यह एक वास्तविक टमटम था, तो आपका ग्राहक या संगठन आपको एक वास्तविक थूक पर बरस रहा होगा, क्योंकि बिना रिलीज के दो सप्ताह बाजार हिस्सेदारी बढ़ाने के लिए दो सप्ताह कम है।
रॉबर्ट हार्वे

3
परियोजना के आधार पर आप एक अलग शाखा में "बीटा" या "पूर्वावलोकन" के रूप में नया संस्करण जारी कर सकते हैं।
कोडइन्चोस

2
किस प्रकार के प्रलेखन - अंतिम उपयोगकर्ता प्रलेखन या स्रोत कोड प्रलेखन? या आपकी परियोजना किसी प्रकार की है जहाँ उन लोगों के बीच कोई अंतर नहीं है?
डॉक ब्राउन

5
यहाँ कोई संघर्ष प्रतीत नहीं होता है: अगर यह पैक किया गया है और जाने के लिए तैयार है तो आप इसे जारी क्यों नहीं कर सकते हैं और दस्तावेज़ पर अगले दो सप्ताह में केवल डॉक्स अपडेट के लिए काम कर सकते हैं ? क्या आप चिंतित हैं कि रिहा करने से बहुत सारे काम (रिपोर्ट किए गए बग और इतने पर) उत्पन्न होंगे जो आपको डॉक्स पर काम करने से रोकेंगे? कारण जो आप दोनों नहीं कर सकते, उसे उत्तर में ध्यान में रखा जाना चाहिए।
स्टीव जेसोप

@DocBrown इस मामले में, यह उपयोगकर्ता प्रलेखन है। स्रोत कोड प्रलेखन केवल मेरे लिए उपयोगी होगा।
साइबर

जवाबों:


45

सरल: एक बीटा संस्करण जारी करें! फिर जब प्रलेखन किया जाता है, तो नए संस्करण की अंतिम रिलीज करें।

यदि आपके पास उपयोगकर्ता नया सामान आज़माने के इच्छुक हैं, तो हर तरह से इसका लाभ उठाएँ। आपको बग रिपोर्ट मिल जाएगी, आपको शायद मुश्किल बिंदुओं के बारे में सामुदायिक प्रश्न मिलते हैं, ताकि आप जान सकें कि प्रलेखन पर ध्यान केंद्रित करने के लिए कहां है, आदि आप उपयोगकर्ता प्रतिक्रिया के आधार पर कुछ चीजों को भी मोड़ना चाह सकते हैं, जो प्रलेखन को प्रभावित कर सकती हैं।

असल में, हर कोई जीतता है।


जल्दी रिलीज़ न करने का एक कारण यह है, अगर आपको लगता है कि आपके उपयोगकर्ता "बीटा संस्करण" के ग्रहणशील नहीं होंगे, तो आपको इसे करने के बारे में दो बार सोचना चाहिए, लेकिन जो आप लिखते हैं, उससे ऐसा लगता है कि वे इसके बारे में खुश होंगे।

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


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

इससे पहले कि मैं यहाँ पूछता मैं वास्तव में एक बीटा रिलीज़ पर विचार करता! इस विचार के साथ समस्या यह है कि जिन चैनलों का मैं उपयोग करता हूं, वे विभाजन रिलीज के लिए एक पूरी तरह से अलग ऐप लिखने के लिए मुझे मजबूर करते हैं। मैंने एक अलग बीटा की दिशा में काम करना शुरू किया, लेकिन इसका लॉजिस्टिक कठिन है और यह इस परियोजना के इस चरण में इसके लायक नहीं था।
15

इसके बजाय, जो मैंने फीचर के साथ चुना, वह इसे सामान्य रिलीज में ऑप्ट-इन बीटा बनाता है। यह सुनिश्चित करता है कि जो लोग स्थिर अनुभव चाहते हैं, वे इसे बनाए रखें, और जो लोग नई सुविधा चाहते हैं, वे इसका उपयोग इस ज्ञान के साथ कर सकते हैं कि यह कई बार टूट सकता है। फिर, भविष्य के रिलीज में, मैं ऑप्ट-इन से सुविधा को एकीकृत कर सकता हूं, बीटा पदनाम को हटा सकता हूं, और दुनिया में सब ठीक है।
साइबर

3
अपाचे "रिलीज़ कैंडिडेट्स" का उपयोग एक प्रोजेक्ट को चिह्नित करने के लिए करता है जो कार्यात्मक रूप से पूर्ण है, लेकिन केवल यह सत्यापित कर रहा है कि पैकेज में सभी संसाधन हैं और यह प्राइम टाइम के लिए वास्तव में तैयार है। ऐसा लगता है कि आप बीटा चरण से परे हैं (कार्यक्षमता परिपक्व है लेकिन फिर भी पूर्ण नहीं है)।
बेरिन लोरिट्श

@BerinLoritsch मैंने देखा है जो पहले इस्तेमाल किया था। वह लेबल वास्तव में इस मामले में अच्छी तरह से फिट बैठता है। मुझे लगता है कि सामान्य रिलीज़ में (मेरे मामले में) एक रिलीज़-इन उम्मीदवार की तरह एक ऑप्ट-इन सुविधा डाल रहा है। यह स्थिर है, यह काम करता है, लेकिन इसने अभी तक प्रकाश नहीं देखा है।
1

15

अगर मैंने आपको सही पाया, तो आप इस परियोजना को अपने खाली समय पर और बिना पैसे के कर रहे हैं । यदि यह मामला है, तो कृपया, वह करें जो आपको बेहतर महसूस कराता है (उपयोगकर्ता प्रतीक्षा करते हैं, आपके समय पर दस्तावेज़)। आपको अपने "उपयोगकर्ताओं" से दबाव महसूस नहीं करना चाहिए। कई लोगों ने इंटरनेट पर इसके बारे में लिखा (बड़े FLOSS लेखक और योगदानकर्ताओं ने दबाव महसूस किया)।

लेकिन, यदि आपको भुगतान किया जा रहा है, या आपको कुछ लाभ मिल रहा है, तो कृपया वही करें जो आपके उपयोगकर्ता चाहते हैं। इसका मतलब यह है कि आपके ग्राहकों या उपयोगकर्ताओं के लिए जो कुछ भी सबसे अच्छा है , उस स्थिति में, बस इसे जारी करें और अपने समय पर दस्तावेज़ करें। आपने कहा कि वे अपना रास्ता ढूंढ लेंगे, इसलिए यह कोई बड़ी बात नहीं होनी चाहिए।


तुमने सही समझा! यह एक अवैतनिक टमटम है। लेकिन मुझे कुछ लाभ मिलता है, क्योंकि मैं उन बिजली उपयोगकर्ताओं में से एक हूं जिनके बारे में मैंने बात की थी। : P आप जो कहते हैं वह समझ में आता है, हालांकि, और मैं आपके उत्तर की सराहना करता हूं!
साइबर

4

सामान्य तौर पर दो प्रकार के प्रलेखन होते हैं: वह तकनीकी जो आपके कोड (कक्षाएं, इकाइयाँ आदि) का दस्तावेजीकरण करती है और कैसे नई सुविधाएँ संचालित और कोड और उपयोगकर्ता प्रलेखन में कार्यान्वित की जा सकती हैं। IMO, तकनीकी दस्तावेज़ीकरण विशेष रूप से आवश्यक है यदि सॉफ़्टवेयर विकास आपका पूर्णकालिक कार्य नहीं है। मैं इस पर बहुत समय बिताता हूं क्योंकि मुझे जीवन की प्रतिबद्धताओं के कारण कोड लिखने के बड़े अंतराल हो सकते हैं।

उपयोगकर्ता प्रलेखन अच्छा है, लेकिन जरूरी नहीं कि मेरा मानना ​​है। बेशक यह आवेदन की जटिलता पर निर्भर करता है, चर्चा में विषय क्षेत्र में कंप्यूटर और सिस्टम के उपयोग के साथ उपयोगकर्ता आधार की परिचितता - आपके मामले में ऐसा लगता है कि आपके ग्राहक यह समझ सकते हैं कि नई सुविधाएँ कैसे काम करती हैं। वहाँ सोचा था कि अच्छा उपयोगकर्ता अनुभव और अच्छा उपयोगकर्ता इंटरफ़ेस न्यूनतम उपयोगकर्ता प्रलेखन की आवश्यकता होती है कि बहस का एक स्कूल है।

इसके अलावा, यदि आपका समय सीमित है और आप वास्तव में प्रलेखन को विकसित करने के लिए दबाव महसूस करते हैं, जैसा कि आप सुझाव देते हैं, तो आप केवल नई सुविधाओं को पेश करते हुए कुछ छोटे वीडियो बना सकते हैं। यह आपको वास्तविक दस्तावेज लिखने के लिए कुछ समय खरीदेगा और फिर आप कम महत्वपूर्ण विवरण भर सकते हैं।

कुछ मार्केटिंग टिप्स आपको उपयोगकर्ता की उम्मीदों को संतुलित करने और अभी भी अपने ब्रांड को बढ़ावा देने की अनुमति दे सकते हैं। यह वास्तव में आवेदन के प्रकार और आपके द्वारा अब तक बनाए गए वर्कफ़्लो पर निर्भर करता है, लेकिन आपके नए संस्करण में आपका स्वागत स्क्रीन हो सकता है और एप्लिकेशन के भीतर आप लिंक प्रदान करके या ऐप के अंदर वीडियो चलाकर या तो वीडियो दिखा सकते हैं।


3

न केवल इस विशिष्ट उदाहरण के लिए बल्कि सामान्य वर्कफ़्लो के लिए कुछ जोड़ने के लिए:

दस्तावेज़ीकरण आपका हो सकता है definition of done, लेकिन प्रलेखन न्यूनतम व्यवहार्य उत्पाद (एमवीपी) से परे अधिकांश समय होता है ।

न केवल ग्राहक हमेशा सही होता है। यदि यह एक वाणिज्यिक उत्पाद है, तो जारी करना बहुत अधिक व्यावसायिक मूल्य हो सकता है और एक पूर्ण प्राथमिकता है।

स्वामी व्यवसाय मूल्य (जो कि आप मैं है) को परिभाषित करता है, इसलिए आपके ग्राहकों के लिए उत्पाद के रूप में अधिक मूल्यवान क्या है?

इसके अलावा कोई भी जोखिम बिना दस्तावेज के जारी है?

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

अपने आप से या उत्पाद के मालिक से ये सवाल पूछें और आपका जवाब स्पष्ट हो जाएगा।


2

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


2
अच्छा प्रलेखन केवल नए उपयोगकर्ताओं को आमंत्रित करता है यदि यह कुछ ऐसा दस्तावेज करता है जो वास्तव में मौजूद है।
रॉबर्ट हार्वे

@robertharvey वर्तमान उपयोगकर्ता आधार को इंगित किया गया था। इस प्रकार मुझे लगता है कि वे किसी न किसी तरह से किसी न किसी बीटा का उपयोग कर रहे हैं।
कैंडिड_ऑरेंज

एक मौजूदा रिलीज़ है, जो अंडर-डॉक्यूमेंटेड होने के बावजूद इसकी आवाज़ स्थिर है।
jpmc26

2

आपने अपने प्रश्न में स्पष्ट नहीं किया है और संभवत: अपने उपयोगकर्ताओं के लिए इन विकल्पों के परिणाम नहीं हैं। आप उपयोगकर्ता के समर्थन पर कितना समय बिता रहे हैं? क्या अतिरिक्त दस्तावेज़ीकरण आपके द्वारा समर्थन या बिक्री बढ़ाने पर खर्च किए जाने वाले समय को कम कर देगा? प्रलेखन करने के लिए आपको क्या फायदा है?

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

अगर मुझे निर्देश पढ़ने में कोई दिक्कत नहीं है, जब मुझे करना है तो आपको अपने प्रश्न के साथ एक ईमेल भेजना होगा, मैं कभी भी नई सुविधाओं पर प्रलेखन क्यों चाहूंगा?


-1

यदि पैकेज ग्राहक / ग्राहक को जारी करने और प्रलेखन पर काम शुरू करने के लिए तैयार है। यह क्लाइंट के लिए अच्छा संवाद है, जब आप प्रलेखन को साझा करेंगे जो उन्हें तैनात सुविधाओं को समझने में मदद करता है।

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.