आम्ही दस्तऐवजीकरणाच्या गुणवत्तेचे मूल्यांकन कसे केले

हॅलो, हॅब्र! माझे नाव लेशा आहे, मी अल्फा-बँकच्या उत्पादन संघांपैकी एक प्रणाली विश्लेषक आहे. आता मी कायदेशीर संस्था आणि वैयक्तिक उद्योजकांसाठी एक नवीन ऑनलाइन बँक विकसित करत आहे.

आणि जेव्हा तुम्ही विश्लेषक असता, विशेषत: अशा चॅनेलमध्ये, तुम्ही दस्तऐवजीकरणाशिवाय कोठेही पोहोचू शकत नाही आणि त्यासह काम बंद करू शकता. आणि दस्तऐवजीकरण ही अशी गोष्ट आहे जी नेहमी अनेक प्रश्न निर्माण करते. वेब ऍप्लिकेशनचे वर्णन का केले जात नाही? सेवा कशी कार्य करावी हे तपशील का सूचित करते, परंतु ते तसे कार्य करत नाही? असे का आहे की केवळ दोन लोक, ज्यापैकी एकाने ते लिहिले आहे, ते तपशील समजू शकतात?

तथापि, स्पष्ट कारणास्तव कागदपत्रांकडे दुर्लक्ष केले जाऊ शकत नाही. आणि आमचे जीवन सोपे करण्यासाठी, आम्ही दस्तऐवजीकरणाच्या गुणवत्तेचे मूल्यांकन करण्याचे ठरविले. आम्ही हे नेमके कसे केले आणि आम्ही कोणते निष्कर्ष काढले ते कट खाली आहे.

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

मजकूरात "नवीन इंटरनेट बँक" अनेक डझन वेळा पुनरावृत्ती होऊ नये म्हणून, मी एनआयबी लिहीन. आता आमच्याकडे उद्योजक आणि कायदेशीर संस्थांसाठी NIB च्या विकासावर काम करणाऱ्या डझनहून अधिक संघ आहेत. शिवाय, त्यापैकी प्रत्येक एकतर नवीन सेवेसाठी किंवा वेब ऍप्लिकेशनसाठी सुरवातीपासून स्वतःचे दस्तऐवज तयार करतो किंवा वर्तमानमध्ये बदल करतो. या दृष्टिकोनासह, तत्त्वतः दस्तऐवजीकरण उच्च दर्जाचे असू शकते?

आणि दस्तऐवजीकरणाची गुणवत्ता निश्चित करण्यासाठी, आम्ही तीन मुख्य वैशिष्ट्ये ओळखली आहेत.

1. ते पूर्ण असले पाहिजे. हे कर्णधारासारखे वाटते, परंतु हे लक्षात घेणे महत्त्वाचे आहे. अंमलात आणलेल्या सोल्यूशनच्या सर्व घटकांचे तपशीलवार वर्णन केले पाहिजे.
2. ते संबंधित असले पाहिजे. म्हणजेच, सोल्यूशनच्या स्वतःच्या सध्याच्या अंमलबजावणीशी संबंधित आहे.
3. ते समजण्यासारखे असावे. जेणेकरून ते वापरणाऱ्या व्यक्तीला उपाय नेमका कसा अंमलात आणला जातो हे समजेल.

सारांश देण्यासाठी - पूर्ण, अद्ययावत आणि समजण्यायोग्य दस्तऐवज.

सर्वेक्षण

दस्तऐवजीकरणाच्या गुणवत्तेचे मूल्यांकन करण्यासाठी, आम्ही त्यांच्याशी थेट काम करणार्‍यांची मुलाखत घेण्याचे ठरविले: NIB विश्लेषक. प्रतिसादकर्त्यांना "10 ते 1 च्या प्रमाणात (पूर्णपणे असहमत - पूर्णपणे सहमत)" या योजनेनुसार 5 विधानांचे मूल्यमापन करण्यास सांगितले होते.

विधाने गुणात्मक दस्तऐवजीकरणाची वैशिष्ट्ये आणि NIB दस्तऐवजांच्या संदर्भात सर्वेक्षण संकलकांचे मत प्रतिबिंबित करतात.

1. NIB अर्जांसाठी कागदपत्रे अद्ययावत आहेत आणि त्यांच्या अंमलबजावणीशी पूर्णपणे सुसंगत आहेत.
2. एनआयबी अर्जांची अंमलबजावणी पूर्णपणे दस्तऐवजीकरण केलेली आहे.
3. NIB अनुप्रयोगांसाठी दस्तऐवजीकरण केवळ कार्यात्मक समर्थनासाठी आवश्यक आहे.
4. NIB अनुप्रयोगांसाठी दस्तऐवज कार्यात्मक समर्थनासाठी सादर करताना वर्तमान आहे.
5. NIB ऍप्लिकेशन डेव्हलपर त्यांना काय अंमलात आणायचे आहे हे समजून घेण्यासाठी कागदपत्रांचा वापर करतात.
6. NIB अर्जांची अंमलबजावणी कशी केली जाते हे समजून घेण्यासाठी पुरेशी कागदपत्रे आहेत.
7. NIB प्रकल्पांना अंतिम स्वरूप दिल्यास (माझ्या टीमद्वारे) कागदपत्रे मी त्वरित अपडेट करतो.
8. NIB ऍप्लिकेशन डेव्हलपर दस्तऐवजांचे पुनरावलोकन करतात.
9. NIB प्रकल्पांसाठी कागदपत्रे कशी तयार करावीत याची मला स्पष्ट समज आहे.
10. NIB प्रकल्पांसाठी कागदपत्रे कधी लिहायची/अपडेट करायची हे मला समजते.

हे स्पष्ट आहे की फक्त "1 ते 5 पर्यंत" उत्तर देणे आवश्यक तपशील प्रकट करू शकत नाही, म्हणून एखादी व्यक्ती प्रत्येक आयटमवर टिप्पणी देऊ शकते.

आम्ही हे सर्व कॉर्पोरेट स्लॅकद्वारे केले - आम्ही फक्त एक सर्वेक्षण करण्यासाठी सिस्टम विश्लेषकांना आमंत्रण पाठवले. 15 विश्लेषक होते (मॉस्कोचे 9 आणि सेंट पीटर्सबर्गचे 6). सर्वेक्षण पूर्ण झाल्यानंतर, आम्ही प्रत्येक 10 विधानांसाठी सरासरी स्कोअर व्युत्पन्न केले, जे आम्ही नंतर प्रमाणित केले.

हा प्रकार घडला.

सर्वेक्षणात असे दिसून आले की जरी विश्लेषकांचा असा विश्वास आहे की NIB अनुप्रयोगांची अंमलबजावणी पूर्णपणे दस्तऐवजीकरण आहे, तरीही ते अस्पष्ट करार देत नाहीत (0.2). एक विशिष्ट उदाहरण म्हणून, त्यांनी निदर्शनास आणले की विद्यमान सोल्यूशन्समधील अनेक डेटाबेस आणि रांगा दस्तऐवजीकरणात समाविष्ट नाहीत. विकसक विश्लेषकाला सांगण्यास सक्षम आहे की सर्वकाही दस्तऐवजीकरण केलेले नाही. परंतु विकासकांनी दस्तऐवजीकरणाचे पुनरावलोकन करणार्‍या प्रबंधाला देखील स्पष्ट समर्थन मिळाले नाही (0.33). म्हणजेच, अंमलबजावणी केलेल्या उपायांचे अपूर्ण वर्णन होण्याचा धोका कायम आहे.

प्रासंगिकता सोपे आहे - जरी पुन्हा कोणताही स्पष्ट करार (0,13) नसला तरी, विश्लेषक अद्याप दस्तऐवजीकरण संबंधित विचारात घेण्यास इच्छुक आहेत. टिप्पण्यांमुळे आम्हाला हे समजण्यास अनुमती मिळाली की प्रासंगिकतेसह समस्या मध्यभागी पेक्षा अधिक वेळा समोर असतात. तथापि, त्यांनी आम्हाला पाठिंबा देण्याबद्दल काहीही लिहिले नाही.

दस्तऐवज लिहिणे आणि अद्यतनित करणे आवश्यक असताना विश्लेषक स्वतःला समजतात की नाही, करार त्याच्या डिझाइनसह (1,33) अधिक एकसमान (1.07) होता. येथे एक गैरसोय म्हणून लक्षात घेतलेली गोष्ट म्हणजे कागदपत्रे ठेवण्यासाठी एकसमान नियमांचा अभाव. म्हणून, “कोण जंगलात जाते, कोणाला सरपण मिळते” मोड चालू न करण्यासाठी, त्यांना विद्यमान कागदपत्रांच्या उदाहरणांवर आधारित कार्य करावे लागेल. म्हणून, दस्तऐवज व्यवस्थापनासाठी एक मानक तयार करणे आणि त्यांच्या भागांसाठी टेम्पलेट विकसित करणे ही एक उपयुक्त इच्छा आहे.

फंक्शनल सपोर्ट (0.73) सबमिशनच्या वेळी NIB ऍप्लिकेशन्ससाठी दस्तऐवजीकरण चालू आहे. हे समजण्यासारखे आहे, कारण कार्यात्मक समर्थनासाठी प्रकल्प सबमिट करण्याच्या निकषांपैकी एक अद्ययावत दस्तऐवजीकरण आहे. अंमलबजावणी (0.67) समजून घेणे देखील पुरेसे आहे, जरी काहीवेळा प्रश्न राहतात.

परंतु प्रतिसादकर्त्यांनी (एकमताने) जे मान्य केले नाही ते म्हणजे NIB अनुप्रयोगांसाठी दस्तऐवजीकरण, तत्त्वतः, केवळ कार्यात्मक समर्थनासाठी आवश्यक आहे (-1.53). विश्लेषकांचा उल्लेख बहुतेकदा दस्तऐवजाचे ग्राहक म्हणून केला जातो. बाकी टीम मेंबर्स (डेव्हलपर) असे करण्याची शक्यता खूपच कमी आहे. शिवाय, विश्लेषकांचा असा विश्वास आहे की विकासक एकमताने (-0.06) नसले तरी, त्यांना काय अंमलबजावणी करणे आवश्यक आहे हे समजून घेण्यासाठी दस्तऐवजीकरण वापरत नाहीत. तसे, कोड डेव्हलपमेंट आणि दस्तऐवजीकरण लेखन समांतरपणे पुढे जात असलेल्या परिस्थितीत देखील हे अपेक्षित आहे.

तळ ओळ काय आहे आणि आम्हाला या संख्यांची आवश्यकता का आहे?

दस्तऐवजांची गुणवत्ता सुधारण्यासाठी, आम्ही पुढील गोष्टी करण्याचे ठरविले:

1. विकसकाला लिखित कागदपत्रांचे पुनरावलोकन करण्यास सांगा.
2. शक्य असल्यास, कागदपत्रे वेळेवर अपडेट करा, प्रथम समोर.
3. NIB प्रकल्पांचे दस्तऐवजीकरण करण्यासाठी एक मानक तयार करा आणि अवलंब करा जेणेकरून प्रत्येकाला त्वरीत समजेल की कोणते सिस्टम घटक आणि नेमके कसे वर्णन करावे. बरं, योग्य टेम्पलेट्स विकसित करा.

हे सर्व कागदपत्रांची गुणवत्ता नवीन स्तरावर वाढविण्यात मदत करेल.

निदान मला तरी तशी आशा आहे.

स्त्रोत: www.habr.com