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