सभी उपयोग के उदाहरण

सपोर्ट सवालों से Docs को ऑटो-अपडेट करें

जब वही सपोर्ट सवाल तीन बार आता है, तो Zero एक docs अपडेट ड्राफ़्ट करता है और एक PR फ़ाइल करता है ताकि अगला व्यक्ति पूछने से पहले ही जवाब पा ले।

Zero जुड़ता है:SlackGitHubNotion

Zero क्या डिलीवर करता है

समस्या क्या है

हर सपोर्ट चैनल में पाँच या छह सवाल होते हैं जो कभी नहीं मरते, इसलिए नहीं कि प्रोडक्ट भ्रमित करने वाला है, बल्कि इसलिए कि docs उनका ज़िक्र नहीं करते। उन थ्रेड को मैन्युअल रूप से ट्रैक करना, अपडेट ड्राफ़्ट करना, और PR पुश करना वह काम है जो हमेशा फिसल जाता है। Docs Auto-Update आपके सपोर्ट चैनलों पर नज़र रखता है, आवर्ती सवालों की गिनती करता है, और जैसे ही कोई सवाल अलग-अलग लोगों द्वारा तीन या अधिक बार पूछा जाता है, यह एक docs अपडेट ड्राफ़्ट करता है और एक PR फ़ाइल करता है। एक रिव्यूअर अप्रूव करने में दो मिनट लगाता है। अगला व्यक्ति जिसका यही सवाल हो वह पूछने के बजाय जवाब पा लेता है।

Zero इसे कैसे ठीक करता है

चरण 1: अपने tools कनेक्ट करें

Slack
Slack
ज़रूरी
Slack। Zero आवर्ती सवालों का पता लगाने के लिए आपके सपोर्ट चैनल पढ़ता है। जिन चैनलों का आप नाम लेते हैं उन तक रीड एक्सेस ज़रूरी है।
जोड़ें
GitHub
GitHub
ज़रूरी
GitHub। Zero आपके वेबसाइट repo के विरुद्ध docs अपडेट को PR के रूप में ड्राफ़्ट करता है। Repo राइट एक्सेस ज़रूरी ताकि Zero ब्रांच बना सके और PR खोल सके।
जोड़ें
Notion
Notion
वैकल्पिक
Notion। वैकल्पिक। उपयोगी है अगर आपके आंतरिक docs Notion में रहते हैं और आप चाहते हैं कि Zero उन्हें भी अपडेट करे।
जोड़ें

चरण 2: Zero से पूछें

@Zero हर हफ़्ते, #support और #community को ऐसे सवालों के लिए स्कैन करो जो पिछले 14 दिनों में 3+ अलग-अलग लोगों द्वारा पूछे गए। हर एक के लिए, एक docs अपडेट ड्राफ़्ट करो और वेबसाइट repo के विरुद्ध उस बदलाव के साथ एक PR खोलो।
Zero आवर्ती सवालों के लिए आपके सपोर्ट चैनलों पर नज़र रखता है
Zero आने वाले सपोर्ट थ्रेड पढ़ता है, समान सवालों को सिमेंटिक रूप से क्लस्टर करता है, और यूनीक पूछने वालों की गिनती करता है। एक रोलिंग विंडो में 3+ अलग यूज़र के सवालों को डॉक्यूमेंटेशन गैप के रूप में फ़्लैग किया जाता है।
Zero हल किए गए जवाबों के आधार पर एक docs अपडेट ड्राफ़्ट करता है
हर फ़्लैग किए गए सवाल के लिए, Zero थ्रेड का समाधान पढ़ता है, सही docs स्थान (मौजूदा सेक्शन या नई गाइड) की पहचान करता है, और ठोस उदाहरणों के साथ आपकी साइट के markdown फ़ॉर्मेट में अपडेट ड्राफ़्ट करता है।
Zero रिव्यू के लिए एक PR फ़ाइल करता है
हर ड्राफ़्ट आपके वेबसाइट repo में एक PR के रूप में आता है, जिसमें विवरण में ट्रिगर करने वाले सवाल थ्रेड लिंक होते हैं। docs टीम का एक रिव्यूअर अप्रूव करता है; आप शुरू से नहीं लिखते।

चरण 3: इसे और आगे ले जाएँ

सही रिव्यूअर पर रूट करें
एक जेनेरिक रिव्यूअर के बजाय PR को कंपोनेंट ओनर को असाइन करें।
@Zero जब किसी billing सवाल के लिए docs ड्राफ़्ट करो, तो PR पर @docs-team के बजाय @billing-team को टैग करो।
कम-जोखिम अपडेट ऑटो-पब्लिश करें
टाइपो फ़िक्स और छोटे स्पष्टीकरण को मानवीय रिव्यू के बिना शिप होने दें।
@Zero 50 लाइन से कम वाले उन docs PR के लिए जो केवल मौजूदा सेक्शन को छूते हैं, CI पास होते ही ऑटो-मर्ज सक्षम करो।
कवरेज बढ़ाएँ
सिग्नल के लिए नए सोर्स चैनल जोड़ें।
@Zero आवर्ती सवालों के लिए केवल Slack ही नहीं, बल्कि सपोर्ट Gmail इनबॉक्स भी स्कैन करो।

बेहतर परिणामों के लिए सुझाव

'आवर्ती' थ्रेशोल्ड को 14 दिनों में 3 यूनीक पूछने वालों पर सेट करें, 1 पर नहीं। 1 पर आप बस हर दिन docs फिर से लिख रहे हैं; 3 पर आप असली गैप पकड़ रहे हैं।
PR विवरण में हमेशा सोर्स थ्रेड शामिल करें। रिव्यूअर मूल सवाल देख सकते हैं और आँक सकते हैं कि ड्राफ़्ट वास्तव में उनका जवाब देता है या नहीं।
KB Capture के साथ जोड़ें ताकि हल किए गए थ्रेड समानांतर रूप से आपके आंतरिक नॉलेज बेस में प्रवाहित हों।