इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- VLC
- टेक्निकल राइटर:
- Avii
- प्रोजेक्ट का नाम:
- एक मोबाइल पोर्ट (Android) के लिए, VLC का उपयोगकर्ता दस्तावेज़ बनाएं
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
ABSTRACT
उपयोगकर्ता के दस्तावेज़ का इस्तेमाल, असली उपयोगकर्ताओं की मदद करने के लिए स्टैटिक सपोर्ट सिस्टम के तौर पर किया जाता है. यह किसी प्रॉडक्ट या सेवा के बारे में तकनीकी और गैर-तकनीकी, दोनों तरह की जानकारी देता है. इससे उपयोगकर्ताओं को सॉफ़्टवेयर या सेवा का इस्तेमाल करने का तरीका जानने में मदद मिलती है. अगर किसी व्यक्ति को सिर्फ़ थोड़ी सी जानकारी, सलाह या तरकीब चाहिए, तो वह सहायता टीम से संपर्क नहीं करना चाहता या ईमेल का जवाब मिलने का इंतज़ार नहीं करना चाहता. उपयोगकर्ता दस्तावेज़ में यही जानकारी दी जाती है. इससे सहायता टीम को मिलने वाले खर्च में भी कमी आती है. साथ ही, यह प्रॉडक्ट के सही तरीके से काम करने और डेवलपर टीम की पहचान के बारे में बताता है.
सिर्फ़ Google Play Store से, VLC for Android को 10 करोड़ से ज़्यादा बार डाउनलोड किया जा चुका है. VLC, अपने मोबाइल पोर्ट के लिए कई सुविधाएं उपलब्ध कराता है. जैसे, ऑडियो-वीडियो प्लेबैक से लेकर नेटवर्क स्ट्रीम तक. अक्सर लोग इन बेहतरीन सुविधाओं का इस्तेमाल करना चाहते हैं, लेकिन वे ऐसा नहीं कर पाते. इसके लिए, ब्लॉग या कोई वीडियो खोजने में काफ़ी समय और धैर्य लगता है. इसके बावजूद, मिली जानकारी की पुष्टि नहीं की जा सकती. फ़िलहाल, VLC, Android उपयोगकर्ता के दस्तावेज़ों के लिए विकी पेज पर VLC होस्ट करता है. साथ ही, इन सुविधाओं के बारे में कम या कोई जानकारी नहीं देता. इसके अलावा, विकी पेजों को पिछली बार मार्च 2019 में अपडेट किया गया था. मौजूदा प्रोजेक्ट में नए डिज़ाइन वाले उपयोगकर्ता दस्तावेज़ उपलब्ध होंगे. साथ ही, Android पोर्ट को इस्तेमाल करना ज़्यादा आसान होगा.
मौजूदा स्थिति
विकी पेज पूरी तरह से पुराने हैं और इनमें VLC के नए वर्शन के बारे में बहुत कम जानकारी है. साथ ही, इन पर नेविगेट करना आसान नहीं होता. दस्तावेज़ को अंग्रेज़ी के अलावा किसी दूसरी भाषा में पढ़ने का विकल्प नहीं दिख रहा है. इसमें सुविधाओं के ब्यौरे नहीं हैं.
विश्लेषण
-> फ़िलहाल, दस्तावेज़ का मौजूदा वर्शन पुराना हो गया है. इसे नए तरीके से लिखने और किसी दूसरे प्लैटफ़ॉर्म और टूल का इस्तेमाल करने की ज़रूरत है.
-> ज़्यादातर Android उपयोगकर्ताओं के पास तकनीकी जानकारी कम होती है या कोई जानकारी नहीं होती. हालांकि, कुछ लोगों को किसी सुविधा के बारे में ज़्यादा तकनीकी जानकारी चाहिए. ऊपर दिए गए हर एक मकसद के लिए दो अलग-अलग दस्तावेज़ लिखना और उन्हें संभालकर रखना एक अच्छा विचार नहीं है. इसके अलावा, एक ही दस्तावेज़ में किसी सुविधा को तकनीकी और गैर-तकनीकी के आधार पर बांटने से भी भ्रम की स्थिति बनती है. दरअसल, ज़्यादातर उपयोगकर्ता अपने देखे जाने वाले यूज़र इंटरफ़ेस (यूआई) या इस्तेमाल की जाने वाली सुविधाओं के बारे में जानते हैं. इसलिए, सभी के लिए यह तय करना आसान नहीं है कि कोई चीज़ तकनीकी है या गैर-तकनीकी. इसलिए, हम इसे उनके लिए आसान बनाना चाहते हैं.
-> ज़्यादातर उपयोगकर्ता अपने स्मार्टफ़ोन से ही जानकारी पाने की कोशिश करेंगे और बाकी डेस्कटॉप या दूसरे डिवाइस पर आराम करेंगे. दस्तावेज़ ऐसा होना चाहिए कि हर स्क्रीन साइज़ के हिसाब से उसे आसानी से अडजस्ट किया जा सके. इससे नेविगेशन के बारे में कोई भ्रम नहीं होगा.
-> डेस्कटॉप वर्शन की हर सुविधा Android पोर्ट में उपलब्ध नहीं होती है. साथ ही, उपलब्ध होने पर दोनों पोर्ट में एक ही तरह से काम नहीं करती. ऐसा इसलिए है क्योंकि डेस्कटॉप ऐप्लिकेशन पर लंबे समय से काम चल रहा है और यह एक तरह की संतृप्ति स्थिति हासिल कर चुका है, जबकि इसके उलट मोबाइल पोर्ट नया है और अभी भी विकसित हो रहा है. इसके अलावा, आजकल मोबाइल डिवाइसों की परफ़ॉर्मेंस बहुत बेहतर हो रही है. हालांकि, हम उनमें कुछ खास सुविधाएं नहीं जोड़ सकते. ऐसा, ज़्यादातर असली उपयोगकर्ताओं की मांग की वजह से होता है. अगर कोई ऐसी सुविधा उपलब्ध कराता है जिसका कोई इस्तेमाल न करता हो, तो इससे डेवलपमेंट के संसाधनों की बर्बादी होती है. इसलिए, सुविधाओं के आधार पर दोनों दस्तावेज़ों को बदलने का सुझाव नहीं दिया जाता.
ऊपर दिए गए विश्लेषण के आधार पर, मेरा सुझाव है कि: 1. फ़िलहाल, डेस्कटॉप उपयोगकर्ता के दस्तावेज़ में Sphinx दस्तावेज़ जनरेटर और Read the Docs थीम का इस्तेमाल किया जा रहा है. Android पोर्ट के लिए इसका इस्तेमाल करने से हमें इन तरीकों से मदद मिलेगी: -> दोनों दस्तावेज़ों को आसानी से मर्ज किया जा सकता है. -> इसे सभी स्क्रीन साइज़ के लिए ऑप्टिमाइज़ किया गया है. -> डेस्कटॉप दस्तावेज़ों की मदद से, Android उपयोगकर्ता दस्तावेज़ पर नेविगेट करते समय आसान अनुभव
- चैप्टर, सेक्शन, और सब-सेक्शन को उनकी जगह के हिसाब से अलग-अलग करना. उदाहरण के लिए - बैकग्राउंड/पीआईपी मोड, ज़्यादा -> सेटिंग->वीडियो में मौजूद है. इसलिए, चैप्टर का स्ट्रक्चर इस तरह होगा
- ज़्यादा दिखाएँ
- |__सेटिंग
- | |__मीडिया लाइब्रेरी
- | |__वीडियो -->बैकग्राउंड/पीआईपी मोड
- : -> इस तरीके से, ऐक्सेस करने में आसानी होगी. इसकी वजह यह है कि उपयोगकर्ता, ऐप्लिकेशन में उस जगह की तुलना करके, आसानी से उस हिस्से पर नेविगेट कर पाएंगे जहां उन्हें मदद चाहिए. हम हर सुविधा के लिए, तकनीकी और गैर-तकनीकी हिस्सों को अलग-अलग कर सकते हैं. हम सबसे पहले, आसान और ग़ैर-तकनीकी जानकारी देंगे. इसके बाद, उस सुविधा के तकनीकी हिस्सों को हाइलाइट करेंगे या लेबल करेंगे. हालांकि, ऐसा सिर्फ़ तब किया जाएगा, जब सुविधा में तकनीकी हिस्से हों. इससे कुछ जानकारी दोहराई जा सकती है, लेकिन इससे ज़्यादातर गैर-तकनीकी लोगों को आसानी से जानकारी मिल पाएगी. इससे आने वाले समय में, डेटा को मैनेज करने में भी मदद मिलेगी. ऐप्लिकेशन के पूरा होने पर, यूज़र इंटरफ़ेस (यूआई) में ज़्यादा बदलाव नहीं होगा. इसलिए, आने वाले समय में अगर कोई नई सुविधा जोड़ी जाती है या हटाई जाती है, तो हम सेक्शन को आसानी से फिर से बना सकते हैं. अगर पूरे यूज़र इंटरफ़ेस (यूआई) में बदलाव किया जाता है, तो हम सेक्शन/चैप्टर को फिर से व्यवस्थित कर सकते हैं या पूरे दस्तावेज़ का स्ट्रक्चर बदल सकते हैं. दोनों ही मामलों में, हमें पूरे दस्तावेज़ में बदलाव करना होगा, क्योंकि मौजूदा यूज़र इंटरफ़ेस (यूआई) से मैच करने के लिए, स्क्रीनशॉट को बदलना होगा. ठीक से काम करने वाला डेमो यहां होस्ट किया गया है : https://avinal.gitlab.io/vlc-android-docs/
दस्तावेज़ के हर सेक्शन में लेबल किया गया स्क्रीनशॉट, सुविधा का ब्यौरा, अगर कोई तकनीकी जानकारी हो, तो उसका ज़्यादा तकनीकी हिस्सा, और सुविधा के बारे में सुझाव और तरकीबें शामिल होंगी.
-> डेस्कटॉप से उपयोगकर्ता के लिए इस दस्तावेज़ को अलग से डेवलप करने से, हमें दोनों दस्तावेज़ों को कुछ ही चरणों में मर्ज करने में मदद मिलेगी. ऐसा करने से, मौजूदा दस्तावेज़ पर कोई असर नहीं पड़ेगा और न ही डेवलपमेंट के दौरान उस पर कोई असर पड़ेगा. मेरा सुझाव है कि इस पूरे दस्तावेज़ को डेस्कटॉप के दस्तावेज़ के Android सेक्शन में शामिल किया जाए. इसके बाद, Android के लिए VLC के दस्तावेज़ का पेर्मलिंक बनाया जाए.
-> अन्य सुधारों में, डेस्कटॉप उपयोगकर्ता दस्तावेज़ के स्टार्ट पेज को फिर से डिज़ाइन करना शामिल हो सकता है. इससे उपयोगकर्ता सीधे अपने पसंदीदा ओएस को चुन पाएंगे और फिर चुने गए ओएस के दस्तावेज़ पर रीडायरेक्ट हो पाएंगे. Windows, MacOS, और Linux के लिए VLC का उपयोगकर्ता दस्तावेज़ पहले से ही अच्छी तरह से डिज़ाइन और बातचीत किया गया है. इसलिए, हम Windows/MacOS/Linux या Android या iOS में से चुनने के विकल्प दे सकते हैं. इससे, उपयोगकर्ता के दस्तावेज़ अलग-अलग होंगे, लेकिन एक ही लिंक से सभी पोर्ट के लिए इस्तेमाल किए जा सकेंगे.
मेरा सुझाया गया उपयोगकर्ता दस्तावेज़ बेहतर क्यों है? उपयोगकर्ता के लिए सुझाया गया यह दस्तावेज़, उन सामान्य पैटर्न के आधार पर बनाया गया है जिनका इस्तेमाल करके असली उपयोगकर्ता मदद पाता है. दस्तावेज़ में सभी ज़रूरी सुविधाएं शामिल होती हैं.जैसे, आसानी, साफ़ तौर पर जानकारी, लुक और फ़ील, तकनीकी जानकारी. इससे, इस्तेमाल करने में आसानी और असली उपयोगकर्ता अनुभव को बेहतर बनाया जा सकता है. इसे आसानी से मैनेज भी किया जा सकता है, क्योंकि अब हर पोर्ट के लिए उपयोगकर्ता के अलग-अलग दस्तावेज़ों को मैनेज करने की ज़रूरत नहीं है.
मैं इस प्रोजेक्ट के लिए सही व्यक्ति क्यों हूं? -> मैं दो साल से कोड लिख रहा हूं. अक्सर मुझे कुछ लाइब्रेरी या सॉफ़्टवेयर के लिए एपीआई दस्तावेज़ पढ़ने पड़ते हैं. इसके अलावा, मुझे अपने कोड का दस्तावेज़ भी बनाना पड़ता है. इसलिए, मुझे पता है कि लोग दस्तावेज़ में क्या देखना चाहते हैं, उन्हें किस तरह की समस्या आती है, और वे मदद पाने के लिए किस तरह से संपर्क करते हैं. मैं इस अनुभव का इस्तेमाल करके, एक जैसा और आसानी से पढ़ा जा सकने वाला दस्तावेज़ लिख पाऊंगा.
-> मैं Quora, Stack Overflow, और कई अन्य प्लैटफ़ॉर्म पर तकनीकी विषयों पर लगातार लिख रहा/रही हूं. मुझे चीज़ों को ऐसे तरीके से समझाने का तरीका पता है जिससे लोगों को आसानी से समझ आ जाए.
-> VLC for Android एक बेहतरीन और लोकप्रिय टूल है. हालांकि, इसकी ज़्यादातर सुविधाओं के बारे में लोगों को पता नहीं है या इसके लिए कोई मदद उपलब्ध नहीं है. मैं कई सालों से डेस्कटॉप और मोबाइल, दोनों प्लैटफ़ॉर्म पर VLC का इस्तेमाल कर रही हूं और मुझे पता है कि लोगों को किस तरह की समस्याएं आ सकती हैं. मेरे सारे ज्ञान और अनुभव को मिलाकर एक बढ़िया दस्तावेज़ होगा.