चुस्त दृष्टिकोण पर विचार करें। मेरा मतलब है, यदि आपके पास हर डिज़ाइन निर्णय को लिखने के लिए आपके पास समय संसाधन और उत्कृष्ट लेखन कौशल हैं, तो लोग अपने तर्क के साथ, बस सब कुछ दस्तावेज़ करें। वास्तविक रूप से, मैं मान रहा हूं कि आप ऐसी स्थिति में नहीं हैं। फुर्तीली दृष्टिकोण तर्कसंगतताओं के प्रलेखन के लिए एक महत्वपूर्ण चुनौती के साथ मदद कर सकता है: आप अक्सर नहीं जानते कि कौन से तर्क बाद में महत्वपूर्ण थे।
आइए समस्या को समग्र दृष्टिकोण से देखें। आप लोग अपने फैसले के लिए तर्कसंगत हैं। वे अभी टीम के दिमाग में स्क्विशीवेयर में फंसे हुए हैं। क्रेडिट प्रलेखन की राशि के बावजूद, sqishyware में तर्कसंगत भंडारण करना यह सब बुरा नहीं है। हम वास्तव में महत्वपूर्ण चीजों को याद करने में एक प्रजाति के रूप में अच्छे हैं। इसकी वजह से हर बड़े निगम के पास "आदिवासी ज्ञान" है, यहां तक कि जब उन निगमों ने उस सभी जनजातीय ज्ञान को दूर करने का प्रयास किया।
अब आपको एक समस्या है। आप पा रहे हैं कि sqiushyware तर्कसंगत पर्याप्त रूप से पर्याप्त नहीं है। आपके लिए अच्छा है कि वहाँ एक समस्या है, और पहचानने के लिए कि इसे हल करने की आवश्यकता है! यह हमेशा एक आसान कदम नहीं है! इसलिए हमें पूरा यकीन है कि समाधान में से कुछ औचित्य को दस्तावेज़ में लोड करना है। हालाँकि, यह पर्याप्त नहीं है। हम पहेली के दूसरे भाग को कभी नहीं भूल सकते हैं, जो आपको निर्णय लेने की आवश्यकता होने पर स्क्वैशवेयर में तर्क को फिर से लोड कर रहा है। मैंने बहुत सी टीमें देखी हैं जो सब कुछ पागलों की तरह दस्तावेज करती हैं, लेकिन सामग्री को वास्तव में अच्छे निर्णय लेने में मदद करने के लिए व्यवस्थित नहीं किया जाता है, इसलिए वे नीचे लिखे होने के बावजूद तर्कसंगत भूल करते हैं ।
इसलिए आपके पास दो चरण की प्रक्रिया है। आपको स्क्वैशवेयर से बाहर निकलकर प्रलेखन में आने की जरूरत है। फिर आपको यह सुनिश्चित करने की आवश्यकता है कि तर्कसंगतता को स्क्विशीवेयर में वापस लाने के लिए पर्याप्त रूप से व्यवस्थित किया जाता है जब आपको इसकी आवश्यकता होती है! अब मुझे लगता है कि हमारे पास समस्या बयान के लिए पर्याप्त है कि यह महसूस किया जाए कि चुनौतियाँ कहाँ पर होंगी। जब आप दस्तावेज़ दे रहे होते हैं, तो आप आमतौर पर यह नहीं जानते हैं कि बाद में कौन इसे देखने वाला है, या वे क्या देख रहे हैं। इसी तरह, जब आप दस्तावेज़ीकरण को देख रहे होते हैं, तो आप आमतौर पर नहीं जानते कि आप क्या देख रहे हैं (सबसे अच्छा आपको पता है कि कब हो सकता है)।
तो एक बड़ी कंपनी इसे दो बड़े ब्लॉकों में संभालने की कोशिश कर सकती है। पहले वे प्रलेखन पर शोध कर रहे लोगों के आधार पर आवश्यकताओं को विकसित कर सकते हैं। फिर वे उन आवश्यकताओं का उपयोग करते हुए कहा प्रलेखन विकसित करने के लिए एक प्रक्रिया का निर्माण करते हैं। और, अगर मैं ऐसा कहने की हिम्मत करता हूं, तो हर कोई शिकायत करता है क्योंकि लगभग किसी को भी नहीं पता है कि दस्तावेज को एक दिन कैसा दिखना चाहिए। प्रलेखन हमेशा अधूरा होता है, और डेवलपर्स हमेशा शिकायत कर रहे हैं कि प्रक्रिया बहुत बोझ है।
फुर्तीले होने का समय।
मेरी सलाह होगी कि अपनी दस्तावेज़ीकरण प्रक्रिया को बेहतर बनाने के लिए एक चुस्त प्रयास शुरू करें: स्क्वीवेयर से पूरे नौ गज की दूरी पर दस्तावेज़ और स्क्वैशवेयर पर वापस। सामने वाले को पहचानें कि आप कुछ जानकारी खो देंगे क्योंकि आपकी प्रक्रिया सही नहीं है, लेकिन यह ठीक है क्योंकि आप अभी भी इस प्रक्रिया का पता लगाने की कोशिश कर रहे हैं! यदि आप एक आकार बनाने की कोशिश करते हैं तो आप अधिक याद करेंगे सभी समाधान फिट बैठता है।
कुछ ख़ास ख़बरें जो मैं देखूँगा: * अनौपचारिक प्रलेखन का अन्वेषण करें। औपचारिक प्रलेखन महान है, लेकिन इसके समय का उपभोग होता है। प्रलेखन का एक उद्देश्य डेवलपर स्क्विशवेयर से जानकारी जारी करना और इसे कागज पर डालना है। अनौपचारिक प्रलेखन ऐसा करने की लागत न्यूनतम रखता है।
- अविश्वसनीय प्रलेखन प्रारूप स्वीकार करें। पहली बार में कुछ भी सही नहीं होगा। डेटा प्राप्त करना और यह पता लगाना बेहतर है कि बाद में इसे विश्वसनीय कैसे बनाया जाए। उदाहरण के लिए, आप अपने तर्कशास्त्र को एक <rationale> </ rationale> ब्लॉक या कुछ इसी तरह से दस्तावेज कर सकते हैं, जिससे बाद में उस डेटा को काटना आसान हो जाएगा। उपयोगकर्ता कहानी में युक्तियों को संग्रहीत करना, अभी के लिए, ठीक है!
- संगठन के मूल्य को कभी न भूलें। पता करें कि आप कैसे, एक टीम के रूप में, प्रलेखन में तर्कसंगतता की खोज करना चाहते हैं, और उस पर दस्तावेज़ करने का प्रयास करें। प्रत्येक टीम की एक अलग प्रक्रिया होगी। मेरी एक टीम पर, हमें वह टिकट कभी नहीं मिल सका, जिस पर अभी उसका औचित्य था। हम क्या कर सकते हैं कोड की एक लाइन मिल रही है जो मायने रखती है,
svn blame
यह पता लगाने के लिए कि यह कब और क्यों बदल गया है, फिर टिकटों पर जाएं। एक बार जब हम वहाँ थे, हम आम तौर पर टिकट पर हमें आवश्यक औचित्य डालते थे। बस हमारे लिए काम किया, पता करें कि आपके लिए क्या काम करता है।
- समय के साथ जैविक प्रलेखन बढ़ सकता है। डेवलपर्स के लिए यह जानना दुर्लभ है कि इसे लिखने के लिए कौन से तर्क सबसे महत्वपूर्ण हैं। हमें आमतौर पर पता चलता है कि बाद में कौन से महत्वपूर्ण थे। यदि आपके पास प्रलेखन के लिए एक संवारने की प्रक्रिया है जो डेवलपर्स को तर्कसंगत रूप से अपने स्वयं के छोटे बगीचे का प्रबंधन करने की अनुमति देती है, तो महत्वपूर्ण सतह पर बढ़ जाएंगे। इससे भी अधिक महत्वपूर्ण, तर्कसंगत परिवर्तन हो सकते हैं। आप महसूस कर सकते हैं कि दो अलग-अलग तर्कसंगतताओं के साथ दो अलग-अलग बदलाव, वास्तव में एक एकल तर्क द्वारा वर्णित हैं जो दोनों के लिए काम करता है। अब आपके और निर्णयों के बीच सामग्री कम है!