इस पेज में एक तकनीकी लेखन प्रोजेक्ट की जानकारी है, जिसे दस्तावेज़ के Google सीज़न के लिए स्वीकार किया जाता है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Mautic
- टेक्निकल राइटर:
- फ़ेवर केल्विन
- प्रोजेक्ट का नाम:
- Knowledgebase
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
खास जानकारी
नॉलेज बेस एक ऐसा प्लैटफ़ॉर्म है जहां डेटा को सभी जगह सेव किया जाता है. यहां जानकारी को सेव, व्यवस्थित, और फिर शेयर किया जाता है. बाहरी इस्तेमाल के दौरान, नॉलेज बेस वह जगह है जहां उपयोगकर्ता किसी कंपनी के प्रॉडक्ट या सेवाओं, संगठन, और इंडस्ट्री के बारे में ज़रूरत की हर जानकारी पा सकते हैं. वहीं दूसरी ओर, इंटरनल नॉलेज बेस का इस्तेमाल, आम तौर पर कम्यूनिटी/उपयोगकर्ताओं को साथ मिलकर काम करने और कंपनी के अंदर की जाने वाली जानकारी और जानकारी बांटने के लिए किया जाता है. अलग-अलग नॉलेज बेस का कॉन्टेंट कई बातों के आधार पर अलग-अलग होता है. हालांकि, ज़्यादातर नॉलेज बेस में, किसी प्रॉडक्ट का इस्तेमाल शुरू करने, बेहतर सुविधाओं का ज़्यादा से ज़्यादा फ़ायदा पाने, और सामान्य समस्याओं को हल करने के बारे में जानकारी शामिल होती है. दर्शकों के लिए नॉलेज बेस बनाकर उसे पेश करने का मुख्य फ़ायदा यह है कि इससे आपको दर्शकों/उपयोगकर्ताओं/कम्यूनिटी को ज़्यादा जानकारी, तुरंत और मांग पर जवाब देने में मदद मिलती है. इसके लिए, आपको हर बार अलग से जवाब देने की ज़रूरत नहीं पड़ती.
Mautic का नॉलेजबेस, Mautic से जुड़े विषयों पर ट्यूटोरियल, 'कैसे करें' गाइड, और सबसे सही तरीकों का एक मुख्य डेटाबेस है. इनमें सीधे तौर पर (उदाहरण के लिए, Mautic में काम करने का तरीका) या किसी दूसरे तरीके से (उदाहरण के लिए, मार्केटिंग की सामान्य रणनीतियां) Mautic से जुड़ी जानकारी शामिल होती है.
यह लेख लिखे जाने के समय, Mautic का नॉलेज बेस पूरी तरह से नया और अधूरा है. साथ ही, Mautic कम्यूनिटी इस प्रोजेक्ट की मदद से, उपयोगकर्ता के दस्तावेज़ को मांग पर उपलब्ध जानकारी देने के तरीके को बेहतर बनाना चाहती है. इससे असली उपयोगकर्ताओं को मॉटिक का इस्तेमाल करते समय बेहतर अनुभव मिल पाएगा. Mautic के नॉलेजबेस को पढ़ने से काफ़ी जानकारी मिली, लेकिन इसमें अपडेट किए गए ट्यूटोरियल और 'कैसे करें' गाइड की ज़रूरत थी. साथ ही, Mautic के 3x वर्शन के हिसाब से नए ट्यूटोरियल और गाइड बनाने की भी ज़रूरत थी.
मौजूदा दस्तावेज़ों को पढ़ने के बाद मेरे शुरुआती अनुभव फ़िलहाल, Mautic का नॉलेजबेस https://kb.mautic.org/ पर उपलब्ध है. दस्तावेज़ में मौजूद कुछ ट्यूटोरियल, 'कैसे करें' गाइड, और सबसे सही तरीकों के विषय अप-टू-डेट नहीं हैं. साथ ही, इनमें बहुत कम या अधूरी जानकारी दी गई है. इनमें mautic के मौजूदा वर्शन के बारे में जानकारी भी नहीं दी गई है.
आपका सुझाव, मौजूदा सुझाव से बेहतर क्यों है/किन क्षेत्रों में मुझे योगदान देना है? इस सुझाए गए सुधार से, किसी भी असली उपयोगकर्ता के लिए परफ़ॉर्मेंस, एक जैसी सुविधाएं, और भरोसेमंद सेवा को बेहतर बनाया जा सकेगा. इसमें लिखित ट्यूटोरियल और 'कैसे करें' गाइड के साथ-साथ सबसे सही तरीके और उनसे जुड़ी इमेज शामिल होंगी. साथ ही, इसमें mautic की हर सुविधा को इस्तेमाल करने के तरीके के बारे में निर्देश और जानकारी शामिल होगी. यह अप-टू-डेट, आसानी से नेविगेट की जा सकने वाली, और समझने में आसान होगी.
विश्लेषण
Mautic नॉलेजबेस, Grav फ़्लैट-फ़ाइल कॉन्टेंट मैनेजमेंट सिस्टम और KLB4 थीम में लिखा गया था. मैंने नॉलेजबेस के दस्तावेज़ों को बेहतर बनाने के तरीकों पर काफ़ी रिसर्च की है
प्रोजेक्ट के लक्ष्य
- नॉलेजबेस देखें.
- Mautic 3x वर्शन के हिसाब से ट्यूटोरियल और 'कैसे करें' गाइड अपडेट करें.
- Mautic कम्यूनिटी के नए नॉलेजबेस के लिए संसाधन बनाना
- 'कैसे करें' ट्यूटोरियल और गाइड की एक सीरीज़ लिखें. इससे Mautic के उपयोगकर्ताओं को ऐप्लिकेशन को सेट अप करने, कॉन्फ़िगर करने, और इस्तेमाल करने में ज़्यादा मदद मिलेगी.
- वीडियो ट्यूटोरियल को Mautic के 3x वर्शन के हिसाब से अपडेट करें.
- पुरानी इमेज और जानकारी हटाएं.
- नॉलेज बेस को फिर से लिखें, ताकि इसे आसानी से समझा जा सके.
- पक्का करें कि नॉलेजबेस दस्तावेज़ों के लिए स्टाइल गाइड/पैटर्न को सही तरीके से लागू किया गया हो
टाइमलाइन
1 अगस्त से पहले
- संगठन में योगदान देना जारी रखें.
- नॉलेजबेस दस्तावेज़ और Mautic के मौजूदा वर्शन के बारे में ज़्यादा जानें.
- नई तकनीकें और तकनीकी लेखन कौशल सीखें, जो प्रोजेक्ट को लागू करते समय मददगार साबित होंगे.
कम्यूनिटी बॉन्डिंग (1 अगस्त से 1 सितंबर)
- बातचीत के लिए चैनल और समय सेट अप करना (समय के अंतर की वजह से)
- अपने लक्ष्यों को बेहतर बनाना और दोनों पक्षों की उम्मीदें सेट करना
- कम्यूनिटी और प्रॉडक्ट के बारे में ज़्यादा जानें
- संगठन के मेंटर और अन्य सदस्यों के साथ, दस्तावेज़ के प्रस्तावित स्ट्रक्चर के बारे में बातचीत करना.
- मौजूदा दस्तावेज़ में, सुझाई गई सुविधाओं और अन्य बदलावों को फ़ाइनल करें.
दस्तावेज़ की अवधि
- पहला हफ़्ता (2 सितंबर से 22 नवंबर)
- इन अवधियों के दौरान, मैं सीधे अपने मेंटर के साथ काम करूंगा, ताकि :
- नॉलेजबेस देखें.
- Mautic 3x वर्शन के हिसाब से ट्यूटोरियल और 'कैसे करें' गाइड अपडेट करें.
- Mautic कम्यूनिटी के नए नॉलेजबेस के लिए संसाधन बनाना
- 'कैसे करें' ट्यूटोरियल और गाइड की एक सीरीज़ लिखें. इससे Mautic के उपयोगकर्ताओं को ऐप्लिकेशन को सेट अप करने, कॉन्फ़िगर करने, और इस्तेमाल करने में ज़्यादा मदद मिलेगी.
- वीडियो ट्यूटोरियल को Mautic के 3x वर्शन के हिसाब से अपडेट करें.
- पुरानी इमेज और जानकारी हटाएं.
- नॉलेजबेस को फिर से लिखें, ताकि उसे आसानी से समझा जा सके.
- पक्का करें कि नॉलेजबेस दस्तावेज़ के स्टाइल गाइड/पैटर्न को सही तरीके से लागू किया गया हो.
- रिलीज़ के समय को ध्यान में रखते हुए, डेवलपर की टीम छोटी-मोटी सुविधाओं की रिलीज़ में व्यस्त रहेगी
प्रोजेक्ट का आकलन (25 नवंबर से 29 नवंबर, 2019)
- प्रोजेक्ट रिपोर्ट सबमिट करना और मेरे मेंटर की ओर से उसका आकलन पाना
- 'Docs का सीज़न' में हिस्सा लेने के अपने अनुभव की रिपोर्ट लिखना और सबमिट करना.