इस पेज में एक तकनीकी लेखन प्रोजेक्ट की जानकारी है, जिसे दस्तावेज़ के Google सीज़न के लिए स्वीकार किया जाता है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Mautic
- टेक्निकल राइटर:
- स्वाति थैकर
- प्रोजेक्ट का नाम:
- Mautic के लिए, असली उपयोगकर्ता के दस्तावेज़ की समीक्षा करना और उन्हें अपडेट करना
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
मौजूदा दस्तावेज़ों को पढ़ने के बाद, मुझे ये बातें अच्छी लगीं:
फ़िलहाल, दस्तावेज़ लंबा है, कई जगहों पर ग़ैर-ज़रूरी है, अधूरा है, और गलत है. इस वजह से, लोगों को वह जानकारी खोजने में मुश्किल हो सकती है जिसे वे ढूंढ रहे हैं.
पहली बार इस्तेमाल करने वाले के तौर पर, मुझे यह समझ नहीं आया कि Mautic के अलग-अलग एलिमेंट, जैसे कि कैंपेन, ऐसेट, मैसेज, कैटगरी वगैरह, कारोबार की ज़रूरत को पूरा करने के लिए एक साथ कैसे काम करते हैं. मेरा सुझाव है कि ऐसे हाई-लेवल कॉन्सेप्चुअल विषय होना चाहिए जिसमें हर मॉटिक एलिमेंट के बारे में दो-तीन लाइनों में जानकारी दी गई हो. यह विषय, इनमें से हर एलिमेंट के लिए, टास्क के अलग-अलग विषयों से लिंक किया जा सकता है.
योगदान देने के बारे में जानकारी देने वाली गाइड में ज़्यादा जानकारी शामिल की जा सकती है. जैसे, कोई समस्या कैसे दर्ज करें, नया कॉन्टेंट/आइडिया कैसे सुझाएं, गड़बड़ियों/समस्याओं/सुरक्षा से जुड़ी कमजोरियों की शिकायत कैसे करें वगैरह. इसके लिए, फ़ोरम, स्लैक चैनलों, और Git रिपॉज़िटरी के लिंक दिए जा सकते हैं. साथ ही, स्टाइल गाइड को बड़ा करके, स्टैंडर्ड टाइपोग्राफ़ी के नियम, इमेज, टेबल वगैरह के लिए दिशा-निर्देश जोड़ने होंगे.
इसके अलावा, ईमेल, कैंपेन, और पुरानी/आउटडेटेड जानकारी में काफ़ी जानकारी अधूरी है. इसे अपडेट करना ज़रूरी है.
मुझे इस क्षेत्र में योगदान देना है:
Slack के चैनलों पर बातचीत के दौरान, मुझे एहसास हुआ कि Slack और लोग, Mautic पर मौजूद कम्यूनिटी से सीधे तौर पर बातचीत करते हैं. इस दौरान, मुझे एहसास हुआ कि कैंपेन और ईमेल, Mautic के लिए बेहद अहम हैं. मैंने वर्शन 3 के लिए Mautibox का इस्तेमाल करके, कैंपेन के दस्तावेज़ों की जांच की. इसमें मुझे पता चला कि इसे काफ़ी बदलाव की ज़रूरत है. मुझे कुछ समस्याएं मिली हैं. यहां उन समस्याओं के बारे में बताया गया है और हर समस्या के लिए मेरा सुझाव भी दिया गया है:
- Mautic का उपयोगकर्ता, कैंपेन बनाते समय कई तरह की कार्रवाइयों, फ़ैसलों, और शर्तों में से किसी एक को चुन सकता है. कई कार्रवाइयों और फ़ैसलों के लिए, दस्तावेज़ मौजूद नहीं हैं. हालांकि, कैंपेन की शर्तों के लिए कोई दस्तावेज़ मौजूद नहीं है. हमें असली उपयोगकर्ता के दस्तावेज़ में मौजूद जानकारी की पहचान करके, उसमें जो जानकारी मौजूद नहीं है उसे जोड़ना होगा.
- कैंपेन आसान या बहुत मुश्किल हो सकते हैं. यह दस्तावेज़, पहली बार कैंपेन बनाने वाले उपयोगकर्ताओं के लिए कोई फ़ायदेमंद नहीं है. मेरा सुझाव है कि कुछ इस्तेमाल के उदाहरणों (आसान और मुश्किल, दोनों) की पहचान की जाए और सैंपल वर्कफ़्लो बनाए जाएं. ये वर्कफ़्लो, सिलसिलेवार निर्देशों वाले ट्यूटोरियल या असली उपयोगकर्ता के लिए बनी गाइड में मौजूद विषयों या वॉक-थ्रू वीडियो के तौर पर बनाए जा सकते हैं. इनकी मदद से, पहली बार इस्तेमाल करने वाला व्यक्ति अपने कैंपेन बनाने से पहले, इनका रेफ़रंस ले सकता है.
- इस सेक्शन में जानकारी को ज़्यादा व्यवस्थित और व्यवस्थित तरीके से दिखाया जाना चाहिए. इस्तेमाल करने की सुविधा को बढ़ाने के लिए, टास्क और कॉन्सेप्ट पर आधारित तरीका अपनाना चाहिए. ये विषय, टेबल का इस्तेमाल करके कार्रवाइयों, फ़ैसलों, और शर्तों के बारे में जानकारी दे सकते हैं. 'तारीख के ट्रिगर का इस्तेमाल करना' विषय थोड़ा अलग है. इसे 'शर्तें' में नेस्ट किया जा सकता है.
कैंपेन के अलावा, मैंने यूज़र इंटरफ़ेस (यूआई) के हिसाब से ईमेल के दस्तावेज़ की भी जांच की. मेरा सुझाव है कि इन पर काम किया जाए:
- ईमेल के लिए डाइनैमिक कॉन्टेंट, कस्टम कोड वाले ईमेल टेंप्लेट के लिए उपलब्ध है. यह टेंप्लेट ईमेल और सेगमेंट ईमेल, दोनों के लिए उपलब्ध है. हालांकि, फ़िलहाल, इसके लिए कोई दस्तावेज़ उपलब्ध नहीं है. डायनैमिक कॉन्टेंट के काम करने के तरीके और उसे सेट अप करने के बारे में जानकारी दें. साथ ही, कुछ उदाहरण भी दें.
- ईमेल मॉनिटर करने के लिए, अलग से कोई विषय जोड़ें. इसमें डैशबोर्ड पर उपलब्ध ईमेल विजेट के इस्तेमाल के बारे में जानकारी और ईमेल-संबंधी मेट्रिक और गतिविधियों को ट्रैक करने के लिए उनका इस्तेमाल करने का तरीका शामिल हो सकता है. साथ ही, ईमेल के ज़रिए ट्रैक करने की सुविधा के बारे में जानकारी भी यहां ले जाएं.
- दस्तावेज़ में यह साफ़ तौर पर नहीं बताया गया है कि संपर्क के जवाब, बाउंस मैनेजमेंट, मेलर का मालिकाना हक - ये ग्लोबल कॉन्फ़िगरेशन सेटिंग हैं. इन्हें ईमेल सेटिंग में कॉन्फ़िगर किया जा सकता है. सभी ईमेल सेटिंग, एक मुख्य विषय के तहत होनी चाहिए. साथ ही, ईमेल की कई अन्य सेटिंग, जैसे कि डिफ़ॉल्ट फ़्रीक्वेंसी के नियम, सदस्यता छोड़ने की सेटिंग का दस्तावेज़ नहीं बनाया जाता. बताएं कि कौनसी सेटिंग ज़रूरी हैं और कौनसी वैकल्पिक हैं.
- बाउंस मैनेजमेंट पेज से, वेबहुक के बारे में सारी जानकारी हटाएं और उसे वेबहुक के लिए अलग से बनाए गए विषय में डालें. इसके बाद, हम यहां से उस विषय का लिंक दे सकते हैं.
इसके अलावा: - डैशबोर्ड विषय में, उपलब्ध विजेट के बारे में पूरी जानकारी नहीं है. यह जानकारी ज़रूरी है और इसे जोड़ना ज़रूरी है, क्योंकि इससे उपयोगकर्ताओं को अपने Mautic संसाधनों का विश्लेषण करने और उन्हें मॉनिटर करने में मदद मिलती है.
अंतर की पहचान करने के लिए, पूरे दस्तावेज़ को स्नैग करना ज़रूरी है. हमें उपयोगकर्ताओं के लिए दस्तावेज़ को ज़्यादा आसान बनाना होगा.
मैं इस प्रोजेक्ट के लिए अपने ज्ञान/अनुभव से क्या फ़ायदा होने की उम्मीद कर सकता/सकती हूं?
पिछले महीने, Mautic के दस्तावेज़ों में कई समस्याओं पर काम करने के बाद, मुझे एंड-यूज़र दस्तावेज़ के स्ट्रक्चर के बारे में पता चला है. साथ ही, दस्तावेज़ों में मौजूद अंतरों की पहचान करने में भी मदद मिली है. इन समस्याओं में, Mautic 3.0 के नए वर्शन के लिए सहायता जोड़ना भी शामिल है. मैंने मार्केटिंग ऑटोमेशन टूल के दस्तावेज़ों के बारे में रिसर्च करने और Mautic के असली उपयोगकर्ताओं के दस्तावेज़ों की तुलना करने में समय बिताया है. इससे हमें यह समझने में मदद मिली है कि हम अपने दस्तावेज़ों में मौजूद खामियों को कैसे ठीक कर सकते हैं. एचटीएमएल भाषा, ओपन सोर्स टूल, और प्रोसेस के बारे में मेरी जानकारी एक और फ़ायदा है. फ़िलहाल, मैं उपयोगकर्ता अनुभव से जुड़ी रिसर्च का कोर्स कर रही हूं. इस कोर्स में मिले सिद्धांतों का इस्तेमाल करके, मैं उपयोगकर्ताओं के हिसाब से दस्तावेज़ बना सकती हूं. साथ ही, जानकारी के स्ट्रक्चर से जुड़े अपने अनुभव की मदद से, मैं कॉन्टेंट को व्यवस्थित कर पाऊंगा और उपयोगकर्ता के लक्ष्यों के हिसाब से दस्तावेज़ तैयार करने के लिए आइडिया सुझा पाऊंगा. इसके अलावा, मेरे पास नए तकनीकी डोमेन के बारे में अपनी जानकारी बढ़ाने का हुनर है. मेरे पास तकनीकी लेखन का 10 साल का अनुभव है. साथ ही, तकनीकी डोमेन वाले किसी संगठन के प्रोजेक्ट को पूरा करने के पिछले जीएसओडी के अनुभव के साथ, मुझे लगता है कि मैं मॉटिक दस्तावेज़ों में दिए गए अपने योगदान के लिए न्याय कर पाऊंगा.