हम प्रलेखन विकास की गुणवत्ता और प्रभावशीलता को कैसे मापते हैं। पृष्ठभूमि और मूल बातें। यैंडेक्स रिपोर्ट

स्वेतलाना Kayushina, प्रलेखन और स्थानीयकरण विभाग के प्रमुख कहते हैं।

हमारा प्रलेखन विभाग विकास के कई चरणों से गुजरा है। पहले एक तकनीकी लेखक था जो एक व्यक्तिगत ग्राहक के कार्यों को करता था। फिर तकनीकी लेखकों का एक समूह बनाया गया, जिसने सीमित कार्यों को हल किया। अब हमारे पास एक बड़ा उत्पादन विभाग है - यह पूरी तरह से प्रलेखन में कंपनी की जरूरतों को पूरा करता है।

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

पहले मेट्रिक्स

पहले तकनीकी लेखक को लगभग सभी डेवलपर्स द्वारा उपयोग की जाने वाली तकनीक का दस्तावेजीकरण करने के लिए यांडेक्स की आवश्यकता थी। इसके बारे में जानकारी मौखिक रूप से एक दूसरे को प्रेषित की गई थी, इसलिए इसका कुछ हिस्सा अनिवार्य रूप से खो गया था या विकृत हो गया था।

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

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

कार्यों का प्रवाह लगातार बढ़ रहा था, इसलिए गुणवत्ता के एक स्तर को बनाए रखने के साथ एक समस्या थी। विशेषज्ञ मूल्यांकन बल्कि व्यक्तिपरक है, लेकिन हम चाहते थे कि यह स्वतंत्र हो।

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

यह सब कुछ समस्याएं पैदा करता है, इसलिए हमें कार्यों को प्राथमिकता देने और प्रलेखन की गुणवत्ता का आकलन करने के लिए एक प्रणाली की आवश्यकता थी।

आंतरिक प्रलेखन मेट्रिक्स

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

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

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

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

बाहरी प्रलेखन के लिए एक मीट्रिक प्रणाली का विकास

व्यावसायिक उद्देश्य ज्यादा नहीं बदले, लेकिन एक नई शर्त सामने आई: हमें आधिकारिक रिलीज के लिए दस्तावेज तैयार करने का प्रबंध करना था। अब हमें समय सीमा को पूरा करने की जरूरत है।

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

तकनीकी लेखकों ने प्रलेखन की गुणवत्ता में सुधार के लिए अतिरिक्त डेटा का उपयोग किया:

• सेवा पर उपयोगकर्ता के व्यवहार का विश्लेषण,
• क्लिकों का हीटमैप,
• वेब दर्शक
• खोज प्रश्नों का आकलन, आदि।

फिर हम बड़े पैमाने पर उत्पादन के चरण में आगे बढ़े और प्रलेखन सेवाओं के प्रावधान के लिए एक सेवा बन गए।

प्रलेखन जन उत्पादन मेट्रिक्स

इस स्तर पर, ग्राहकों और प्रबंधन के पास प्रलेखन विभाग के लिए नई आवश्यकताएं हैं।

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

प्रबंधन लागत के औचित्य में रुचि रखता था। किसी व्यक्ति को विभाग में रखने के लिए, हमें यह तर्क देना था। उदाहरण के लिए, हम एक दस्तावेज़ का एक औसत दर्जे का लाभ दिखा सकते हैं यदि यह एक-दो उपयोगकर्ताओं की नहीं बल्कि कई हजार की समस्याओं को हल करता है और तकनीकी सहायता पर भार को कम करता है।

हमारे सांख्यिकीय मैट्रिक्स अब इन सवालों के जवाब देने के लिए पर्याप्त नहीं थे।

बड़े पैमाने पर उत्पादन के संदर्भ में, हमारे पास कई मुख्य कार्य हैं:

1. दस्तावेज़ प्रौद्योगिकी
2. रिलीज के साथ रहो,
3. उच्च स्तर की गुणवत्ता प्रदान करते हैं।

इसके लिए हमें जो कुछ भी करना है, उसके लिए एक एकीकृत दृष्टिकोण की आवश्यकता है।

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

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

हम मूल्यांकन के निम्नलिखित पहलुओं में रुचि रखते थे:

1. डिजाइन और व्यापार मीट्रिक सेवा की गुणवत्ता की प्रभावशीलता के एक पूरे के रूप में संकेतक हैं। उन्हें ग्राहकों की संतुष्टि बढ़ाने और सभी कार्यों को करने के लिए विभाग के संसाधनों की भविष्यवाणी करने की आवश्यकता है।
2. उपयोगकर्ता की संतुष्टि को बढ़ाने के लिए दस्तावेज़ गुणवत्ता मूल्यांकन मीट्रिक।

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

परिणामस्वरूप, हमने 136 मैट्रिक्स में से 20 का चयन किया, और फिर उन्हें चार समूहों में विभाजित किया। हम डैशबोर्ड पर मीट्रिक डेटा प्रदर्शित करते हैं जो कंपनी के किसी भी कर्मचारी के लिए उपलब्ध हैं।

लेख के अगले भाग में, हम प्रलेखन के विकास और समर्थन के लिए और अधिक विस्तार से वर्णन करेंगे कि हम उन्हें कैसे मानते हैं। नई टिप्पणियों के लिए साइन अप करें - हम आपको उनमें रिपोर्ट के अगले भाग की रिलीज़ के बारे में बताएंगे।