VLC प्रोजेक्ट

इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.

प्रोजेक्ट की खास जानकारी

ओपन सोर्स संगठन:

वीएलसी

तकनीकी लेखक:

एवी

प्रोजेक्ट का नाम:

एक मोबाइल पोर्ट (Android) के लिए VLC उपयोगकर्ता दस्तावेज़ बनाना

प्रोजेक्ट की अवधि:

मानक अवधि (तीन महीने)

प्रोजेक्ट का विवरण

असर

असली उपयोगकर्ताओं की मदद करने के लिए, उपयोगकर्ता दस्तावेज़ का इस्तेमाल स्टैटिक सपोर्ट सिस्टम के तौर पर किया जाता है. इससे किसी प्रॉडक्ट या सेवा के बारे में तकनीकी और गैर-तकनीकी जानकारी, दोनों मिलती है. इससे उपयोगकर्ताओं को सॉफ़्टवेयर या सेवा को इस्तेमाल करने का तरीका जानने में मदद मिलती है. हर व्यक्ति सहायता टीम से संपर्क नहीं करना चाहता और न ही ईमेल के जवाब का इंतज़ार करना चाहता है. उसे बस कोई निर्देश, सलाह या तरकीब चाहिए. उपयोगकर्ता दस्तावेज़ बस यही करता है. इससे सहायता पर होने वाला खर्च भी कम होता है. साथ ही, यह प्रॉडक्ट की सेहत और डेवलपर टीम की पहचान है.

Android के लिए VLC को, सिर्फ़ Google Play Store से 10 करोड़ से ज़्यादा बार डाउनलोड किया जा चुका है. VLC अपने मोबाइल पोर्ट के लिए, ऑडियो-वीडियो प्लेबैक से लेकर नेटवर्क स्ट्रीम तक कई सुविधाएं देता है. अक्सर लोग इन शानदार सुविधाओं का इस्तेमाल करना चाहते हैं, लेकिन वे ऐसा नहीं कर पाते. इसके लिए कोई ब्लॉग या कोई भी वीडियो खोजते समय, बहुत समय और धैर्य की ज़रूरत होती है. इसके बावजूद, इस जानकारी की प्रामाणिकता नहीं होती. फ़िलहाल, Android उपयोगकर्ता दस्तावेज़ों के लिए VLC को wiki पेज पर होस्ट किया जाता है. साथ ही, इन सुविधाओं का कम या कोई ब्यौरा नहीं दिया जाता. इसके अलावा, विकी पेजों को आखिरी बार मार्च 2019 में अपडेट किया गया. मौजूदा प्रोजेक्ट, नए डिज़ाइन वाले नए उपयोगकर्ता से जुड़े दस्तावेज़ उपलब्ध कराएगा. साथ ही, Android पोर्ट के इस्तेमाल को और भी आसान बना देगा.

मौजूदा स्थिति

विकी पेज पूरी तरह पुराने हैं और उनमें VLC के सबसे नए वर्शन के बारे में बहुत कम जानकारी है. साथ ही, इन पर नेविगेट करना आसान नहीं होता. दस्तावेज़ को अंग्रेज़ी के अलावा किसी दूसरी भाषा में पढ़ने का कोई विकल्प नहीं है. इसमें किसी सुविधा का ब्यौरा नहीं दिया गया है.

विश्लेषण

-> फ़िलहाल, मौजूदा दस्तावेज़ पुराना हो गया है. इसे नए तरीके से और अलग प्लैटफ़ॉर्म और टूल का इस्तेमाल करके लिखा जाना चाहिए.

-> Android इस्तेमाल करने वाले ज़्यादातर लोगों को या तो बहुत कम तकनीकी जानकारी होती है या कोई जानकारी नहीं होती. हालांकि, कुछ ऐसे लोग हैं जिन्हें किसी सुविधा के बारे में ज़्यादा तकनीकी जानकारी की ज़रूरत होती है. ऊपर दिए गए हर मकसद के लिए, दो अलग-अलग दस्तावेज़ लिखना और उन्हें मैनेज करना अच्छा आइडिया नहीं है. इसके अलावा, अगर उसी दस्तावेज़ में किसी सुविधा को तकनीकी और गैर-तकनीकी के आधार पर बांट दिया जाता है, तो भ्रम पैदा होता है. ज़्यादातर लोग उस यूज़र इंटरफ़ेस (यूआई) को इस्तेमाल कर रहे होते हैं जिसे वे देखते हैं या वे कौनसी सुविधाएं इस्तेमाल करते हैं. इसलिए, यह सभी के लिए यह तय करना आसान नहीं होता कि कोई चीज़ तकनीकी है या गैर-तकनीकी. इसलिए, हम उनके लिए यह काम आसान बनाना चाहते हैं.

-> ज़्यादातर उपयोगकर्ता अपने स्मार्टफ़ोन से ही जानकारी पाने की कोशिश करते हैं और डेस्कटॉप या अन्य डिवाइसों के ज़रिए आराम करने की कोशिश करते हैं. इसलिए, दस्तावेज़ हर स्क्रीन साइज़ के हिसाब से आसानी से अपडेट होने चाहिए. और इससे नेविगेशन को लेकर कोई उलझन नहीं होगी.

-> डेस्कटॉप वर्शन की सभी सुविधाएं Android पोर्ट में उपलब्ध नहीं हैं. साथ ही, अगर दोनों पोर्ट में एक जैसी सुविधा उपलब्ध न हो. इसकी वजह यह है कि डेस्कटॉप ऐप्लिकेशन पर काफ़ी समय से काम चल रहा है और यह एक तरह से सेचुरेशन वाली स्थिति हासिल कर चुका है. हालांकि, इसके उलट मोबाइल पोर्ट काफ़ी नया है और अब भी डेवलप हो रहा है. इसके अलावा, हालांकि आज के समय में मोबाइल डिवाइस बहुत शक्तिशाली होते जा रहे हैं, फिर भी हम सीधे तौर पर असली उपयोगकर्ताओं की मांग के चलते ऐसी सुविधाओं को शामिल कर सकते हैं, जिन्हें हम शामिल कर सकते हैं. किसी सुविधा का इस्तेमाल न करना, उसके डेवलपमेंट के संसाधनों की बर्बादी होती है. इसलिए, सुविधाओं के आधार पर दोनों दस्तावेज़ों में बदलाव करने का सुझाव नहीं दिया जाता.

ऊपर दिए गए विश्लेषण के आधार पर, मैं इन बातों का सुझाव देता/देती हूं. 1. अब तक डेस्कटॉप उपयोगकर्ता दस्तावेज़,Sphinx दस्तावेज़ जनरेटर और दस्तावेज़ थीम पढ़ें का इस्तेमाल कर रहा है. Android पोर्ट के लिए उसी तरीके का इस्तेमाल करने से, हमें इन तरीकों से मदद मिलेगी: -> दोनों दस्तावेज़ों को आसानी से मर्ज किया जा सकता है. -> इसे सभी स्क्रीन साइज़ के लिए ऑप्टिमाइज़ किया गया है. -> डेस्कटॉप दस्तावेज़ की मदद से, Android उपयोगकर्ता के दस्तावेज़ पर नेविगेट करने का आसान अनुभव

1. चैप्टर, सेक्शन, और सब-सेक्शन को उनकी जगह के हिसाब से अलग-अलग करना. उदाहरण के लिए - बैकग्राउंड/पीआईपी मोड ज़्यादा -> सेटिंग->वीडियो के अंदर है, इसलिए चैप्टर का स्ट्रक्चर

   ज़्यादा दिखाएं

   |__सेटिंग

   | |__मीडिया लाइब्रेरी

   | |__Video -->बैकग्राउंड/पीआईपी मोड

   : -> इस तरीके से ऐक्सेस करने में आसानी होगी, क्योंकि उपयोगकर्ता उस हिस्से पर आसानी से नेविगेट कर पाएंगे जहां उन्हें मदद की ज़रूरत है. इसके लिए, उन्हें ऐप्लिकेशन में जगह की जानकारी से तुलना करनी होगी. हर सुविधा के लिए, हम तकनीकी और गैर-तकनीकी हिस्सों को अलग-अलग कर सकते हैं. हम सबसे पहले एक ऐसा ब्यौरा लिखेंगे जो तकनीकी रूप से आसान नहीं है. इसके बाद, उसी सुविधा के कुछ तकनीकी हिस्सों, अगर कोई हो, तो उसके ठीक नीचे हाइलाइट या लेबल किया जाएगा. इससे कुछ दोहराव हो सकता है, लेकिन इससे गैर-तकनीकी बहुमत का सहज अनुभव सुनिश्चित होगा. इससे आने वाले समय में भी डेटा को मैनेज करने में मदद मिलेगी. ऐप्लिकेशन के बेहतर होने की स्थिति में, मिलते-जुलते यूज़र इंटरफ़ेस (यूआई) में बहुत ज़्यादा बदलाव होने की संभावना नहीं है. इसलिए, अगर आने वाले समय में कोई नई सुविधा जोड़ी या हटाई जाती है, तो हम उस सेक्शन को रीफ़ैक्टर कर सकते हैं. अगर पूरे यूज़र इंटरफ़ेस (यूआई) को बदल दिया जाता है, तो हम सेक्शन/चैप्टर को फिर से व्यवस्थित कर सकते हैं या पूरे दस्तावेज़ को फिर से तैयार कर सकते हैं. किसी भी स्थिति में, हमें पूरे दस्तावेज़ में बदलाव करना होगा, क्योंकि मौजूदा यूआई से मेल खाने के लिए स्क्रीनशॉट को बदलना होगा. एक चालू डेमो यहां होस्ट किया गया है : https://avinal.gitlab.io/vlc-android-docs/

2. दस्तावेज़ के हर सेक्शन में एक लेबल किया गया स्क्रीनशॉट, सुविधा का ब्यौरा, अगर कोई सुविधा हो, तो उसका ज़्यादा तकनीकी हिस्सा, और सुविधा के लिए सुझाव और तरकीबें शामिल होंगी.

-> उपयोगकर्ता के इस दस्तावेज़ को डेस्कटॉप से स्वतंत्र रूप से डेवलप करने से, हमें कुछ ही चरणों में दोनों दस्तावेज़ों को मर्ज करने में मदद मिलेगी. ऐसा करने से, मौजूदा दस्तावेज़ों पर कोई असर नहीं पड़ेगा या डेवलपमेंट के दौरान इन दस्तावेज़ों पर कोई असर नहीं पड़ेगा. मेरा सुझाव है कि एक बार डेवलप हो जाने के बाद, इस पूरे दस्तावेज़ को डेस्कटॉप दस्तावेज़ के Android सेक्शन में रखें. इसके बाद, Android दस्तावेज़ के लिए VLC के लिए एक स्थायी लिंक बनाएं.

-> ज़्यादा सुधारों में डेस्कटॉप उपयोगकर्ता दस्तावेज़ों के शुरुआती पेज को फिर से डिज़ाइन करना शामिल हो सकता है, ताकि उपयोगकर्ता सीधे अपना पसंदीदा ओएस चुन सकें और फिर चुने गए ओएस के दस्तावेज़ पर रीडायरेक्ट कर सकें. Windows, MacOS, और Linux VLC के उपयोगकर्ता का दस्तावेज़ पहले से ही अच्छी तरह से डिज़ाइन किया गया है और इस बारे में बातचीत की जा रही है. इसलिए, हम Windows/MacOS/Linux या Android या iOS में से किसी को चुनने के विकल्प दे सकते हैं. इसका नतीजा यह होगा कि सभी पोर्ट के लिए, एक ही लिंक के साथ अच्छी तरह से अलग, लेकिन एक ही जगह पर उपयोगकर्ता के दस्तावेज़ मिलेंगे.

मेरा अनुमानित उपयोगकर्ता दस्तावेज़ बेहतर क्यों है? इस प्रस्तावित उपयोगकर्ता का दस्तावेज़, सामान्य पैटर्न के आधार पर तैयार किया गया है, ताकि उपयोगकर्ता मदद पाने के लिए असली उपयोगकर्ता से संपर्क कर सके. इस्तेमाल को आसान बनाने और असली उपयोगकर्ता के अनुभव को बढ़ाने के लिए, इस दस्तावेज़ में सभी ज़रूरी सुविधाएं शामिल हैं. जैसे, इस्तेमाल में आसान, साफ़ तौर पर समझ आने वाला, रंग-रूप, टेक्नोलॉजी की जानकारी, और टेक्नोलॉजी की जानकारी. इसे आसानी से मैनेज भी किया जा सकता है, क्योंकि अब हर पोर्ट के लिए, अलग-अलग उपयोगकर्ता दस्तावेज़ बनाने की ज़रूरत नहीं होती.

इस प्रोजेक्ट के लिए मैं सही व्यक्ति क्यों हूं? -> मैं दो साल से कोड लिख रहा हूं. मुझे कुछ लाइब्रेरी या सॉफ़्टवेयर के लिए, एपीआई दस्तावेज़ देखने या अपने कोड का दस्तावेज़ बनाने की ज़रूरत पड़ती है. इसलिए, मुझे पता है कि दस्तावेज़ में लोग क्या देखना चाहते हैं, उन्हें किस तरह की समस्या का सामना करना पड़ता है, और वे मदद पाने के लिए क्या करते हैं. मैं एक जैसा और आसानी से पढ़ने लायक दस्तावेज़ लिखने के लिए, उसी अनुभव को लागू कर पाऊंगा/पाऊंगी.

-> मैं सक्रिय रूप से Quora, Stack Overflow और अन्य कई प्लैटफ़ॉर्म पर तकनीकी सामग्री लिखने में लगा हूं. मुझे पता है कि चीज़ों को इस तरह से कैसे समझाना है जो आकर्षक हो और लोग आसानी से समझ जाएं.

-> Android के लिए VLC एक बेहतरीन टूल है, जो काफ़ी लोकप्रिय है. हालांकि, इसकी ज़्यादातर सुविधाओं के बारे में जानकारी नहीं है या कोई सहायता उपलब्ध नहीं है. मैं कई सालों से डेस्कटॉप और मोबाइल प्लैटफ़ॉर्म, दोनों पर VLC का इस्तेमाल कर रहा हूं. साथ ही, मुझे पता है कि उपयोगकर्ता को किस तरह की समस्याएं हो सकती हैं. अपनी सारी जानकारी और अनुभव के आधार पर, मुझे आपके लिए एक बढ़िया दस्तावेज़ मिल सकता है.