VideoLAN प्रोजेक्ट

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

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

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

VideoLAN

तकनीकी लेखक:

एडिओंग ऐनी असिकपो

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

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

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

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

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

असर

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

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

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

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

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

मेरे सुझाए गए उपयोगकर्ता दस्तावेज़ को मौजूदा वीडियो की तुलना में बेहतर क्यों बनाया गया है?

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

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

विश्लेषण

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

स्फ़िंक्स

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

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

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

वर्डिक्ट

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

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

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

संभावित दस्तावेज़ की संरचना

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

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

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

यह प्रोजेक्ट ही क्यों?

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

इस प्रोजेक्ट का अधिकार रखने वाला व्यक्ति क्यों है

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

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