हमने दस्तावेज़ीकरण की गुणवत्ता का मूल्यांकन कैसे किया

नमस्ते, हबर! मेरा नाम लेशा है, मैं अल्फ़ा-बैंक की उत्पाद टीमों में से एक के लिए सिस्टम विश्लेषक हूं। अब मैं कानूनी संस्थाओं और व्यक्तिगत उद्यमियों के लिए एक नया ऑनलाइन बैंक विकसित कर रहा हूं।

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

हालाँकि, स्पष्ट कारणों से दस्तावेज़ीकरण को नज़रअंदाज नहीं किया जा सकता है। और अपने जीवन को आसान बनाने के लिए, हमने दस्तावेज़ीकरण की गुणवत्ता का मूल्यांकन करने का निर्णय लिया। हमने वास्तव में यह कैसे किया और हम किस निष्कर्ष पर पहुंचे, यह कट के नीचे है।

दस्तावेज़ीकरण गुणवत्ता

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

और दस्तावेज़ीकरण की गुणवत्ता निर्धारित करने के लिए, हमने तीन मुख्य विशेषताओं की पहचान की है।

1. यह पूर्ण होना चाहिए. यह कप्तान जैसा लगता है, लेकिन इस पर ध्यान देना महत्वपूर्ण है। इसमें कार्यान्वित समाधान के सभी तत्वों का विस्तार से वर्णन होना चाहिए।
2. यह चालू होना चाहिए. अर्थात्, समाधान के वर्तमान कार्यान्वयन के अनुरूप ही।
3. यह समझने योग्य होना चाहिए. ताकि इसका उपयोग करने वाला व्यक्ति ठीक से समझ सके कि समाधान कैसे कार्यान्वित किया जाता है।

संक्षेप में कहें तो - पूर्ण, अद्यतन और समझने योग्य दस्तावेज़ीकरण।

Опрос

दस्तावेज़ीकरण की गुणवत्ता का आकलन करने के लिए, हमने उन लोगों का साक्षात्कार लेने का निर्णय लिया जो सीधे इसके साथ काम करते हैं: एनआईबी विश्लेषक। उत्तरदाताओं को "10 से 1 के पैमाने पर (पूरी तरह से असहमत - पूरी तरह से सहमत)" योजना के अनुसार 5 बयानों का मूल्यांकन करने के लिए कहा गया था।

बयान गुणात्मक दस्तावेज़ीकरण की विशेषताओं और एनआईबी दस्तावेज़ों के संबंध में सर्वेक्षण संकलनकर्ताओं की राय को दर्शाते हैं।

1. एनआईबी अनुप्रयोगों के लिए दस्तावेज़ीकरण अद्यतित है और उनके कार्यान्वयन के साथ पूरी तरह से सुसंगत है।
2. एनआईबी अनुप्रयोगों का कार्यान्वयन पूरी तरह से प्रलेखित है।
3. एनआईबी अनुप्रयोगों के लिए दस्तावेज़ीकरण केवल कार्यात्मक समर्थन के लिए आवश्यक है।
4. एनआईबी अनुप्रयोगों के लिए दस्तावेज़ीकरण कार्यात्मक समर्थन के लिए उनके प्रस्तुतीकरण के समय मौजूद है।
5. एनआईबी एप्लिकेशन डेवलपर्स यह समझने के लिए दस्तावेज़ीकरण का उपयोग करते हैं कि उन्हें क्या लागू करने की आवश्यकता है।
6. एनआईबी अनुप्रयोगों के लिए यह समझने के लिए पर्याप्त दस्तावेज़ हैं कि उन्हें कैसे कार्यान्वित किया जाता है।
7. यदि एनआईबी परियोजनाओं को (मेरी टीम द्वारा) अंतिम रूप दे दिया जाता है तो मैं तुरंत उनके दस्तावेज़ों को अद्यतन करता हूँ।
8. एनआईबी एप्लिकेशन डेवलपर्स दस्तावेज़ीकरण की समीक्षा करते हैं।
9. मुझे इस बात की स्पष्ट समझ है कि एनआईबी परियोजनाओं के लिए दस्तावेज़ीकरण कैसे तैयार किया जाए।
10. मैं समझता हूं कि एनआईबी परियोजनाओं के लिए दस्तावेज कब लिखना/अद्यतन करना है।

यह स्पष्ट है कि केवल "1 से 5 तक" का उत्तर देने से आवश्यक विवरण सामने नहीं आ सकते हैं, इसलिए एक व्यक्ति प्रत्येक आइटम पर एक टिप्पणी छोड़ सकता है।

हमने यह सब कॉर्पोरेट स्लैक के माध्यम से किया - हमने बस सिस्टम विश्लेषकों को एक सर्वेक्षण में भाग लेने के लिए निमंत्रण भेजा। वहाँ 15 विश्लेषक थे (9 मास्को से और 6 सेंट पीटर्सबर्ग से)। सर्वेक्षण पूरा होने के बाद, हमने 10 बयानों में से प्रत्येक के लिए एक औसत स्कोर तैयार किया, जिसे हमने तब मानकीकृत किया।

यह पता चला कि क्या है।

सर्वेक्षण से पता चला कि हालांकि विश्लेषकों का मानना ​​है कि एनआईबी अनुप्रयोगों का कार्यान्वयन पूरी तरह से प्रलेखित है, वे स्पष्ट सहमति (0.2) नहीं देते हैं। एक विशिष्ट उदाहरण के रूप में, उन्होंने बताया कि मौजूदा समाधानों से कई डेटाबेस और कतारें दस्तावेज़ीकरण में शामिल नहीं थीं। डेवलपर विश्लेषक को यह बताने में सक्षम है कि सब कुछ प्रलेखित नहीं है। लेकिन थीसिस कि डेवलपर्स दस्तावेज़ीकरण की समीक्षा करते हैं, उसे भी स्पष्ट समर्थन नहीं मिला (0.33)। यानी कार्यान्वित समाधानों के अधूरे विवरण का जोखिम बना रहता है।

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

जहां तक ​​यह बात है कि क्या विश्लेषक स्वयं समझते हैं कि दस्तावेज़ लिखना और अद्यतन करना कब आवश्यक है, तो समझौता बहुत अधिक समान था (1,33), जिसमें इसका डिज़ाइन (1.07) भी शामिल था। यहां एक असुविधा के रूप में जो बात नोट की गई वह दस्तावेज़ीकरण बनाए रखने के लिए समान नियमों की कमी थी। इसलिए, "कौन जंगल में जाता है, किसे जलाऊ लकड़ी मिलती है" मोड को चालू न करने के लिए, उन्हें मौजूदा दस्तावेज़ीकरण के उदाहरणों के आधार पर काम करना होगा। इसलिए, दस्तावेज़ प्रबंधन के लिए एक मानक बनाना और उनके भागों के लिए टेम्पलेट विकसित करना एक उपयोगी इच्छा है।

कार्यात्मक समर्थन (0.73) के लिए जमा करने के समय एनआईबी अनुप्रयोगों के लिए दस्तावेज़ीकरण चालू है। यह समझ में आता है, क्योंकि कार्यात्मक समर्थन के लिए प्रोजेक्ट सबमिट करने का एक मानदंड अद्यतन दस्तावेज़ीकरण है। यह कार्यान्वयन (0.67) को समझने के लिए भी पर्याप्त है, हालांकि कभी-कभी प्रश्न बने रहते हैं।

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

मूल बात क्या है और हमें इन नंबरों की आवश्यकता क्यों है?

दस्तावेज़ों की गुणवत्ता में सुधार के लिए, हमने निम्नलिखित कार्य करने का निर्णय लिया:

1. डेवलपर से लिखित दस्तावेज़ों की समीक्षा करने के लिए कहें।
2. यदि संभव हो, तो दस्तावेज़ीकरण को समय पर अद्यतन करें, सबसे पहले।
3. एनआईबी परियोजनाओं के दस्तावेजीकरण के लिए एक मानक बनाएं और अपनाएं ताकि हर कोई जल्दी से समझ सके कि कौन से सिस्टम तत्वों का और वास्तव में कैसे वर्णन किया जाना चाहिए। खैर, उपयुक्त टेम्पलेट विकसित करें।

यह सब दस्तावेज़ों की गुणवत्ता को एक नए स्तर तक बढ़ाने में मदद करेगा।

कम से कम मुझे ऐसी आशा है।

स्रोत: www.habr.com