जैसा कि हम प्रलेखन के विकास और समर्थन के लिए मैट्रिक्स पर विचार करते हैं। यैंडेक्स रिपोर्ट

रिपोर्ट के पहले भाग में , हमने रेखांकित किया कि हम प्रलेखन की गुणवत्ता और इसके विकास की प्रभावशीलता को कैसे मापते हैं। अब मैट्रिक्स की गिनती के विवरण में गोता लगाएँ।

तकनीकी दस्तावेज विकास सेवा के प्रमुख यूरी निकुलिन कहते हैं।

आरंभ करने के लिए, आइए परिभाषित करें कि प्रदर्शन क्या है। शास्त्रीय अर्थों में, आउटपुट की एक इकाई या समय की प्रति यूनिट उत्पादित उत्पादन की मात्रा का उत्पादन करने के लिए लिया गया समय है ।

उदाहरण के लिए, यह प्रति माह उत्पादित फोन की संख्या है या हजारों फोन का उत्पादन करने में जितना समय लगता है। सवाल यह उठता है कि हमारे विभाग जिस बौद्धिक श्रम को माप रहे हैं, उसे कैसे मापें।

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

हमने मेट्रिक्स के चयन के लिए कई मापदंड निर्धारित किए हैं:

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

परिणामस्वरूप, हमने महसूस किया कि प्रदर्शन मीट्रिक की गणना के लिए आदर्श वस्तु ट्रैकर में कार्य है। यह उन सभी आवश्यकताओं को पूरा करता है जो हम मैट्रिक्स के लिए निर्धारित करते हैं।

हमारे लिए डेटा स्रोत Yandex.Tracker था। यह हमारे कार्यों के लिए काफी लचीला और आसानी से अनुकूलन योग्य है। इसमें पहले से ही सभी आवश्यक डेटा हैं, क्योंकि हम हर दिन इस उपकरण का उपयोग करते हैं। और ट्रैकर के पास एक एपीआई भी है, जिसका अर्थ है कि आप इस जानकारी का उपयोग कर सकते हैं और प्रक्रियाओं को स्वचालित कर सकते हैं।

तो हम कैसे आगे बढ़ने के लिए एक योजना थी।

कतारों और कार्यों को सेट करें

आपको कतारों, कार्यों के पदानुक्रम, उनके प्रकार और स्थितियों को चुनकर शुरू करना होगा।

यह "विवरण में उपयोगकर्ता प्रलेखन की तैयारी के लिए उपकरण " में कट्या कुनेंको द्वारा विस्तार से वर्णित किया गया था। हम संक्षेप में कतारबद्ध और कार्यों के बारे में बात करेंगे, जिसका उपयोग हम स्वयं करते हैं।

कतारों

हमारे पास तीन लाइनें हैं, जो संक्षेप में हमारे लक्षित दर्शकों को दर्शाती हैं।

टास्क पदानुक्रम

हमारे कार्यों में दो-स्तरीय संरचना है:

• शीर्ष स्तर पर, कार्य प्रकाशित दस्तावेजों के अनुरूप हैं,
• निचले स्तर पर, कार्य दस्तावेज़ पर काम के अनुरूप हैं।

प्रकार और कार्यों की स्थिति

कार्यों के प्रकार और स्थितियां न केवल हमें काम के प्रकार और उनकी वर्तमान स्थिति को वर्गीकृत करने की अनुमति देती हैं, बल्कि अनुभागों के साथ हमारे मैट्रिक्स पर भी विचार करती हैं।

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

हम एक ग्राफ के एक उदाहरण पर बताएंगे। उदाहरण के लिए, एक बग 1-5 दिनों के भीतर तय किया जाता है, और एक नया दस्तावेज़ लिखने में 30-40 का समय लगता है। उसी समय, हम पुराने लोगों के पूरक या सही त्रुटियों की तुलना में कम बार नए दस्तावेज़ लिखते हैं। इसलिए, किसी भी प्रकार (ग्रीन लाइन) के कार्य का औसत निष्पादन समय बग के लिए बहुत लंबा है और नए दस्तावेजों के लिए बहुत कम है। इसकी मदद से, हम समस्याओं को हल करने की गति का केवल एक औसत विचार प्राप्त करते हैं।

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

हम इस प्रकार के कार्यों का उपयोग करते हैं।

प्रकारों की तुलना में अधिक स्थितियां हैं, क्योंकि वर्कफ़्लो को इसकी आवश्यकता होती है।

प्रकार और स्थिति के साथ काम करना आसान है अगर वे असंदिग्ध हैं और उनमें से बहुत सारे नहीं हैं। अन्यथा, कलाकार भ्रमित हो सकते हैं।

प्रदर्शन मीट्रिक पर कैसे विचार करें

पिछले भाग में, हमने कहा कि हमने एक अध्ययन किया और 136 में से 20 दस्तावेज़ीकरण मैट्रिक्स का चयन किया। उनमें से छह प्रदर्शन मीट्रिक हैं।

मैट्रिक्स की गिनती करने के दो पहलू हैं।

• कटा हुआ मेट्रिक्स की गिनती। ऊपर, हमने बताया कि यह क्या है और हमारे लिए क्यों महत्वपूर्ण है।
• औसत मूल्यों की गिनती।

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

ऐसे मामलों में, प्रतिशतता बचाव के लिए आता है। यह अधिकतम मूल्य (हमारे मामले में, मैट्रिक्स) है, जो वस्तुओं के निर्दिष्ट प्रतिशत को फिट करता है। उदाहरण के लिए, 80 वाँ प्रतिशतक वह मान है जो नमूने में 80% वस्तुओं से अधिक नहीं होता है। हमारे मामले में, ऐसा मान 1 का मान होगा, क्योंकि 83% ऑब्जेक्ट इससे अधिक नहीं हैं।

यहां तीसरा विमान दिखाई देता है - वह समय जिसके लिए हम मैट्रिक्स की गणना करते हैं। हमारे सभी मैट्रिक्स लगभग 30 दिनों में गिने जाते हैं।

हम निम्नानुसार कटौती के साथ मैट्रिक्स पर विचार करते हैं:

• पहले सभी लाइनों को एक साथ,
• फिर हम बदल जाते हैं
• फिर हम विस्तार से: हम सभी प्रकार के कार्यों के लिए एक कट के साथ कतारों में कटौती करते हैं।

मीट्रिक का प्रत्येक बाद वाला भाग पिछले एक को परिष्कृत करता है। सभी कतारों, प्रकारों और कार्यों की स्थिति के लिए औसत मूल्य एक सामान्य विचार देता है। फिर हम तकनीकी, उपयोगकर्ता या आंतरिक प्रलेखन के साथ चीजों को समझने के लिए व्यक्तिगत कतारों के लिए मूल्य पर विचार करते हैं। अंतिम, सबसे विस्तृत स्तर पर, हम एक पंक्ति "कतार + प्रकार और स्थिति" पर काम कर रहे हैं।

आगे हम बताएंगे कि हम प्रदर्शन मीट्रिक पर कैसे विचार करते हैं।

बंद कार्यों की संख्या

जैसा कि हम विचार करते हैं: अंतराल में बंद किए गए कार्यों की संख्या के अनुसार [31 दिन पहले; कल]।

काम में लिए गए कार्यों की संख्या

जैसा कि हम विचार करते हैं: कार्यों की संख्या जिसके अनुसार काम की शुरुआत अंतराल में है [31 दिन पहले; कल]।

काम पर रखने से पहले दिनों की संख्या

जैसा कि हम मानते हैं:

1. प्रत्येक कार्य के लिए जो निर्दिष्ट समयावधि में काम करने के लिए लिया गया था (अंतराल में ट्रैकर में शुरू होने की तारीख [31 दिन पहले, कल]), हम कथन (क्षेत्र निर्माण की तारीख) और कार्य की शुरुआत (क्षेत्र प्रारंभ तिथि) के बीच पूरे दिन की संख्या पर विचार करते हैं। ।
2. हम पहले चरण में प्राप्त सभी मूल्यों को संक्षेप में प्रस्तुत करते हैं।
3. हम प्राप्त राशि को उन कार्यों की संख्या से विभाजित करते हैं जिनके लिए हमने पहला आइटम किया था।

प्रतिशताइल के लिए, आइटम 3 को छोड़ दिया जाता है, मानों को बढ़ते क्रम में क्रमबद्ध किया जाता है, और दिए गए प्रतिशत के अनुरूप मूल्य का चयन किया जाता है।

पूरा करने के लिए दिनों की संख्या

जैसा कि हम विचार करते हैं।

1. प्रत्येक कार्य के लिए जो निर्दिष्ट समय अवधि (अंतराल में ट्रैकर में अंतिम तिथि [31 दिन पहले, कल]) में पूरा हो गया था, हम काम की शुरुआत (क्षेत्र की शुरुआत की तारीख) और कार्य (फील्ड की तारीख) के बीच पूरे दिन की संख्या पर विचार करते हैं।
2. हम पहले चरण में प्राप्त सभी मूल्यों को संक्षेप में प्रस्तुत करते हैं।
3. हम प्राप्त राशि को उन कार्यों की संख्या से विभाजित करते हैं जिनके लिए हमने पहला आइटम किया था।

प्रतिशताइल के लिए, आइटम 3 को छोड़ दिया जाता है, मानों को आरोही क्रम में क्रमबद्ध किया जाता है, और दिए गए प्रतिशत के अनुरूप मूल्य का चयन किया जाता है।

14 दिनों से अधिक प्रतिक्रिया के बिना कार्यों की संख्या

जैसा कि हम मानते हैं: कार्यों की संख्या जिसमें 14 दिनों से अधिक कुछ भी नहीं हुआ। यह ट्रैकर में अद्यतन फ़ील्ड द्वारा निर्धारित किया जाता है: फ़ील्ड मान "कल - 14 दिन" से कम होना चाहिए।

तकनीकी ऋण

जैसा कि हम विचार करते हैं: ट्रैकर में बैकलॉग स्थिति निर्धारित करने के लिए कार्यों की संख्या से।

प्रदर्शन मेट्रिक्स गणना की तकनीकी कार्यान्वयन

शीर्ष स्तर पर, मीट्रिक गिनती प्रणाली में निम्नलिखित घटक और सूचना लिंक होते हैं।

अनुसूचित मीट्रिक गिनती कार्यक्रम

हम एक सार्वभौमिक कंप्यूटिंग प्लेटफॉर्म निर्वाण का उपयोग करते हैं। यह औपचारिक रूप से उस क्रम का वर्णन करता है जिसमें प्रक्रियाएं शुरू की जाती हैं। आंतरिक अनुसूचक (अनुसूचक) के साथ निर्वाण हमें बैश स्क्रिप्ट और क्रोन के एक सेट के साथ बदल देता है।

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

टास्क सेटिंग सिस्टम

हमारे मामले में मैट्रिक्स की गणना के लिए डेटा Yandex.Tracker में संग्रहीत किया जाता है। डेटा के इंटरफ़ेस के रूप में, हम Yandex.Tracker Python API का उपयोग करते हैं - यह HTTP API पर एक आवरण है, जो आगे की प्रक्रिया के लिए उपयुक्त डेटा संरचनाओं में जानकारी प्राप्त करने के लिए तेज़ और आसान अनुमति देता है।

आप उपयुक्त एपीआई के साथ एक सुविधाजनक प्रणाली चुन सकते हैं, उदाहरण के लिए, जीरा।

चार्ट तैयारी प्रणाली

Yandex.Tracker के डेटा के आधार पर मीट्रिक की गणना करने के बाद, हमारा प्रोग्राम JSON फाइलें बनाता है और उन्हें ग्राफ खींचने के लिए Yandex.Statistics आंतरिक सेवा में स्थानांतरित करता है।

आप कुछ प्रकार के जेएस लाइब्रेरी का उपयोग कर सकते हैं जो ग्राफ़ का निर्माण कर सकते हैं। कुछ इसी तरह के समाधान का एक अवलोकन है:

15 सर्वश्रेष्ठ जावास्क्रिप्ट पुस्तकालय

अगले भाग में, हम वर्णन करेंगे कि हम उपयोगकर्ता प्रलेखन के गुणवत्ता मीट्रिक पर कैसे विचार करते हैं।