VideoLAN प्रोजेक्ट

इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.

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

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

VideoLAN

टेक्निकल राइटर:

Edidiong Anny Asikpo

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

VLC उपयोगकर्ता के दस्तावेज़ को मॉडर्न करना (फिर से लिखना)

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

स्टैंडर्ड अवधि (तीन महीने)

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

ABSTRACT

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

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

इस लेख को लिखने के समय तक, VLC के उपयोगकर्ता दस्तावेज़ को 4,634,065 बार ऐक्सेस किया जा चुका है. साथ ही, VLC मीडिया प्लेयर को मुख्य वेबसाइट से हर महीने करीब 2.3 करोड़ बार डाउनलोड किया जाता है. इससे पता चलता है कि दुनिया भर में कई लोग VLC मीडिया प्लेयर का इस्तेमाल करते हैं. साथ ही, वे मीडिया प्लेयर को इस्तेमाल करने के तरीके के बारे में जानने के लिए, इसका उपयोगकर्ता दस्तावेज़ पढ़ना चाहते हैं. हालांकि, VLC मीडिया प्लेयर का उपयोगकर्ता दस्तावेज़ फ़िलहाल पुराना और अधूरा है. इसमें आखिरी बार 28 अक्टूबर, 2015 को बदलाव किया गया था. VideoLAN कम्यूनिटी, इस प्रोजेक्ट का इस्तेमाल करके अपने उपयोगकर्ता दस्तावेज़ को बेहतर बनाना चाहती है, ताकि असली उपयोगकर्ताओं को VLC मीडिया प्लेयर का इस्तेमाल करते समय आसानी हो.

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

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

मेरा सुझाया गया उपयोगकर्ता दस्तावेज़, मौजूदा दस्तावेज़ से बेहतर क्यों है?

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

मेंटर: जीन-बैप्टिस्ट, एलेक्स, साइमन

विश्लेषण

जीन-बैप्टिस्ट और मैंने उस नए एनवायरमेंट के बारे में बातचीत की थी जिसमें मौजूदा उपयोगकर्ता दस्तावेज़ को बेहतर बनाने के लिए माइग्रेट किया जाएगा. उन्होंने दो लिंक शेयर किए, जिनमें Sphinx के साथ लिखी गई सोर्स फ़ाइल का Gitlab रिपॉज़िटरी और Read the Docs पर होस्ट किया गया मुख्य दस्तावेज़ दिखाया गया था. उन्होंने कहा कि उन्हें उम्मीद है कि नया दस्तावेज़ इससे मिलता-जुलता होगा. इन टूल के काम करने के तरीके को बेहतर तरीके से समझने के लिए, मैंने इनके बारे में काफ़ी रिसर्च की.

स्फ़िंक्स

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

दस्तावेज़ पढ़ें

Read the Docs, आपके दस्तावेज़ों को बनाने, वर्शन बनाने, और होस्ट करने की प्रोसेस को ऑटोमेट करके, सॉफ़्टवेयर दस्तावेज़ को आसान बनाता है. यह कभी भी सिंक से बाहर नहीं होता है; यानी, जब भी आप अपने पसंदीदा वर्शन कंट्रोल सिस्टम में कोड पुश करते हैं, चाहे वह Git, Mercurial, बाज़ार या Subversion हो, तो दस्तावेज़ पढ़ें अपने आप आपके दस्तावेज़ बना देंगे ताकि आपका कोड और दस्तावेज़ हमेशा अप-टू-डेट रहें. इसके कई वर्शन हैं; Read the Docs आपके दस्तावेज़ों के कई वर्शन होस्ट और बनाए सकता है. इसलिए, आपके दस्तावेज़ों का 1.0 वर्शन और 2.0 वर्शन होना उतना ही आसान है जितना आपके वर्शन कंट्रोल सिस्टम में अलग-अलग शाखा या टैग होना. Read the Docs, बिना किसी शुल्क के इस्तेमाल किया जा सकता है. यह ओपन सोर्स है और इसमें 1,00,000 बड़े और छोटे ओपन सोर्स प्रोजेक्ट के दस्तावेज़ मौजूद हैं. ये दस्तावेज़, ज़्यादातर मानव और कंप्यूटर भाषाओं में उपलब्ध हैं.

VERDICT

Sphinx एक बेहतरीन टूल है. Read the Docs, Sphinx दस्तावेज़ों को होस्ट करने के लिए बनाया गया है. इससे आपके दस्तावेज़ सभी वर्शन के लिए अप-टू-डेट रहते हैं. कुल मिलाकर, ये टूल का एक ऐसा शानदार सेट है जिसका इस्तेमाल डेवलपर और तकनीकी लेखक, उपयोगकर्ता दस्तावेज़ बनाने के लिए कर सकते हैं. यह टूल असली उपयोगकर्ताओं के लिए सबसे अच्छा होगा.

Sphinx में, दस्तावेज़ों का अनुवाद कई भाषाओं में करने की सुविधा शामिल है. इसमें वर्शन कंट्रोल की सुविधा होती है. इसका इस्तेमाल, दस्तावेज़ों को मैनेज करने के लिए किया जाता है. मौजूदा विकी के उलट, इस वर्शन कंट्रोल सिस्टम में कोई भी व्यक्ति बदलाव नहीं कर सकता. साथ ही, इसमें सही जानकारी भी नहीं जोड़ी जा सकती. इस सिस्टम से यह पक्का किया जा सकेगा कि मुख्य रिपॉज़िटरी में मर्ज करने से पहले, सभी बदलावों की समीक्षा की गई हो. वर्शन कंट्रोल की मदद से, दस्तावेज़ में प्रोजेक्ट के लिए ओपन सोर्स का योगदान भी बढ़ेगा. ऐसा इसलिए होगा, क्योंकि लोग समस्याएं बता सकते हैं, पुश अनुरोध कर सकते हैं वगैरह. Sphinx और Read the Docs का इस्तेमाल, कई अन्य कम्यूनिटी और बेहतरीन प्रोजेक्ट करते हैं. जैसे, ASP.NET, Kernel, Julia, Jupyter, PHPMyAdmin, Write the Docs वगैरह. यह VLC के नए उपयोगकर्ता दस्तावेज़ के लिए इस्तेमाल करने के लिए एक बेहतरीन टूल है.

मैंने इन टूल के बारे में सिर्फ़ पढ़ा ही नहीं, बल्कि एक बुनियादी सैंपल भी बनाया. मेरी Gitlab रिपॉज़िटरी का लिंक यह है: https://gitlab.com/Didicodes/demo-vlc-user-documentation. वहीं, readthedocs पर होस्ट किया गया वर्शन यहां देखा जा सकता है: [https://vlc-user-documentation-demo.readthedocs.io/en/latest/](https://vlc-user-documentation-demo.readthedocs.io/en/latest/.

सुझाए गए दस्तावेज़ का स्ट्रक्चर

मैंने VLC उपयोगकर्ता के दस्तावेज़ों के लिए एक स्ट्रक्चर तैयार किया है. इसे यहां देखा जा सकता है; https://docs.google.com/document/d/1Sy2V2IADoCyfnGBK70v8mkjiWK2tH-oWdUlDxAfQAYA/edit?usp=sharing. इस नए स्ट्रक्चर को लागू करने से पहले, मेंटर की मंज़ूरी लेनी होगी. इसका मतलब है कि मेंटर की समीक्षा के बाद, स्ट्रक्चर में बदलाव हो सकता है.

प्रोजेक्ट के लक्ष्य

• दस्तावेज़ को फिर से व्यवस्थित करें.
• VLC के नए वर्शन के हिसाब से दस्तावेज़ों को अपडेट करें.
• Sphinx और ReadtheDocs का इस्तेमाल करके, उपयोगकर्ता दस्तावेज़ को Gitlab पर माइग्रेट करें.
• पुरानी इमेज और जानकारी हटाएं.
• उपयोगकर्ता के दस्तावेज़ को दोबारा लिखें, ताकि इसे आसानी से समझा जा सके.
• Sphinx Internationalization का इस्तेमाल करके, अनुवाद के लिए इसे सेट अप करें.
• दस्तावेज़ को कम्यूनिटी के हिसाब से बनाएं, ताकि उपयोगकर्ता दस्तावेज़ पढ़ते समय आने वाली किसी भी समस्या की शिकायत कर सकें या उसे हल कर सकें.

यह प्रोजेक्ट क्यों शुरू किया गया?

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

मैं इस प्रोजेक्ट का सही व्यक्ति क्यों हूं

मुझे लगता है कि मैं इस प्रोजेक्ट के लिए सही व्यक्ति हूं, क्योंकि:

• मेरे पास संगठनों के दस्तावेज़ों को बेहतर बनाने का अनुभव है. साथ ही, मैं किसी भी वर्शन कंट्रोल सिस्टम का इस्तेमाल कर सकता/सकती हूं. इसलिए, Gitab पर निर्देशों को लागू करने में कोई समस्या नहीं होगी. इसके अलावा, मुझे ऐसे प्रोजेक्ट पर काम करना अच्छा लगता है जो लोगों के लिए फ़ायदेमंद हों.
• मेरा मानना है कि अगर आपको किसी को किसी काम को सबसे बेहतर तरीके से करने के लिए कहना है, तो आपको उसका दस्तावेज़ बनाना चाहिए. अपनी प्रोसेस को दस्तावेज़ में दर्ज करके, यह पक्का किया जा सकता है कि इसमें शामिल सभी लोग बेहतर तरीके से काम कर पाएं, एक जैसी परफ़ॉर्मेंस दें, और उन्हें किसी तरह की परेशानी न हो.
• मुझे VLC के उपयोगकर्ताओं की ज़रूरतों के बारे में पता है, क्योंकि मैं भी उनमें से एक हूं. इसकी मदद से, दस्तावेज़ को इस तरह लिखा जा सकेगा कि दुनिया भर के सभी उपयोगकर्ता, पहली बार में ही इसे समझ सकें.