इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- वीएलसी
- तकनीकी लेखक:
- अभिषेक प्रताप सिंह
- प्रोजेक्ट का नाम:
- VLC उपयोगकर्ता दस्तावेज़ को नए तरीके से बनाने की प्रोसेस जारी रखें
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
दस्तावेज़ की मौजूदा स्थिति
VLC उपयोगकर्ता दस्तावेज़ को आधुनिक बनाया जा रहा है और इसे अपडेट किया जा रहा है. विकी पर आधारित पुराने दस्तावेज़[1] से ReadTheDocs पर होस्ट किए गए sphinx के आधुनिक उपयोगकर्ता दस्तावेज़[2] में ट्रांज़िशन की प्रोसेस जारी है.
टारगेट ऑडियंस
टारगेट ऑडियंस में दिलचस्पी रखने वाले ऐसे उपयोगकर्ता होते हैं जो सामान्य मीडिया प्लेयर के अलावा, VLC मीडिया प्लेयर की सुविधाओं के बारे में जानना चाहते हैं. साथ ही, कुछ हद तक इससे डेवलपर को आसान रेफ़रंस गाइड के तौर पर काम करने में भी मदद मिलेगी. इसलिए, मेरी योजना है कि जीयूआई-आधारित निर्देशों (जहां ज़रूरी हो, इमेज के साथ) और सीएलआई-आधारित तरीकों (कोड स्निपेट के साथ) को शामिल करें, ताकि असली उपयोगकर्ता को अपने हिसाब से विकल्प मिले.
मेरा मानना है कि दस्तावेज़ों की भाषा (खास तौर पर जीयूआई सेक्शन) इतनी छोटी होनी चाहिए कि जिस व्यक्ति को कंप्यूटर इस्तेमाल करने की बहुत कम जानकारी हो, वह इस गाइड को समझ सके और उसे लागू कर सके. दूसरी ओर, यह बहुत ज़्यादा लंबा नहीं होना चाहिए या इस बारे में विस्तार से नहीं बताना चाहिए (खास तौर पर सीएलआई सेक्शन में) कि कोड करने वालों की दिलचस्पी खत्म हो रही हो.
पेज की शुरुआत में ज़रूरी शर्तों के बारे में बताकर या फिर ऐसे वैकल्पिक सेक्शन रखकर सही संतुलन बनाया जा सकता है जिन्हें अच्छी तरह जानते हैं.
अनुवाद उपलब्ध कराने के लिए, टारगेट ऑडियंस, VLC के डेवलपर/उपयोगकर्ता हैं. इन्हें अंग्रेज़ी और उस भाषा में अच्छी समझ होती है जिसमें वे अनुवाद करेंगे.
टूल
नए दस्तावेज़ को Sling बनाता है और ReadTheDocs पर होस्ट करता है. साथ ही, इसका वर्शन कंट्रोल सिस्टम GitLab में लागू किया गया है. मुझे Git और GitHub का इस्तेमाल करने का कुछ पुराना अनुभव है. इससे मुझे GitLab के बारे में जानने में मदद मिली. हालांकि, कुछ अलग-अलग सुविधाओं को भी सीखने में कुछ समय लगा.
स्फ़िंक्स की बात करें, तो मैंने इसके बारे में पढ़ा था जब एक साथी ओपन-सोर्स उत्साही ने टिप्पणी की थी कि कितने संगठन अपने दस्तावेज़ बनाने के लिए इसका इस्तेमाल कर रहे हैं (ब्लेंडर के उल्लेखनीय उदाहरण के साथ, जो अपने यूज़र मैन्युअल[3] और एपीआई दस्तावेज़ बनाने के लिए स्फ़िंक्स का इस्तेमाल करता है).[4].
मुझे ReadTheDocs के बारे में थोड़ी-बहुत जानकारी है. यह वर्शन बनाने और तकनीकी दस्तावेज़ों को होस्ट करने के लिए एक अच्छा टूल है. इसलिए, मैं बिना किसी समस्या के VLC दस्तावेज़ बना पाया. साथ ही, मुझे इस्तेमाल किए गए फ़ॉर्मैट के रीस्ट्रक्चर्ड टेक्स्ट की जानकारी है.
अनुवादों के लिए, VLC, i18n और l10n को लागू करने के लिए, .po फ़ाइलें जनरेट करने के लिए Nearby का इस्तेमाल कर रहा है. फ़िलहाल, मैं खुद को बेबल वर्कफ़्लो के बारे में जानता हूं. साथ ही, मैं स्फ़िंक्स का इस्तेमाल करके .mo फ़ाइलें बनाने के तरीके के बारे में भी जानता हूं.
ऊपर बताए गए टूल की बारीकियों के बारे में जानने के लिए, मेरा मकसद बॉन्डिंग पीरियड का इस्तेमाल करना है.
डिलीवर किए जाने वाले आइटम और हर हफ़्ते की समयावधि
2019 के प्रोजेक्ट के हिस्से के तौर पर, इंस्टॉलेशन, इंटरफ़ेस, ऑडियो, वीडियो, वीडियो चलाने जैसे काम करने के कुछ हिस्से (ज़्यादातर बुनियादी सुविधाएं) पहले ही शामिल कर लिए गए हैं. इसलिए, मुझे 2020 के प्रोजेक्ट के लिए, 'उपयोगकर्ता के दस्तावेज़' के बेहतर इस्तेमाल वाले सेक्शन पर काम करना है.
डिलीवर किया जा सकने वाला 1 [हफ़्ता 1-2]: #7[5] में बताए गए ट्रांसकोड दस्तावेज़ को अपडेट करें.
- ट्रांसकोड
- एक से ज़्यादा वीडियो को ट्रांसकोड करें
- लोगो जोड़ें
- वीडियो को एक साथ मर्ज करें
- किसी फ़ाइल से ऑडियो और वीडियो एक्स्ट्रैक्ट करना
- डीवीडी रिप करें
डिलीवर करने का दूसरा विकल्प [तीसरा से चौथा हफ़्ता]: Firefox 77, Chrome 83, और Edge 83 में VLC को वेब प्लगिन के तौर पर इस्तेमाल करके अपडेट करना[6].
- वीडियो के साथ वेबपेज बनाना
- टैग एट्रिब्यूट एम्बेड करें
- JavaScript API की जानकारी
डिलीवर करने लायक तीसरा हफ़्ता [पांचवां हफ़्ता]: कमांड लाइन इंटरफ़ेस[7] कमांड की जांच करें और उसके हिसाब से अपडेट करें.
- स्ट्रीम
- मॉड्यूल चुनना
- आइटम के लिए खास विकल्प
- फ़िल्टर
छठा हफ़्ता: ऊपर दिए गए तीन डिलीवरी के लिए बफ़र हफ़्ता.
डिलीवर करने लायक 4 [हफ़्ता सात से आठवां हफ़्ता]: अनुवाद की तैयारी करें. अपडेट करने के अलावा, मुझे दूसरी भाषाओं में अनुवाद की तैयारी करनी है. यह ज़रूरी है, क्योंकि अनुवाद करने के बाद, अंग्रेज़ी बैकग्राउंड वाले उपयोगकर्ता, दस्तावेज़ पढ़ सकते हैं. साथ ही, वीएलसी की मदद से वे वर्ल्ड डॉमिनेशन हासिल करने में भी मदद कर पाएंगे[8].
जैसा कि प्रस्ताव के टूल सेक्शन में बताया गया है, फ़िलहाल VLC, अनुवादों के लिए .po फ़ाइलें जनरेट करने के लिए, Babel का इस्तेमाल करता है. मुझे उपयोगकर्ता/वॉलंटियर के लिए, दस्तावेज़ की प्रोसेस से जुड़ी जानकारी देनी होगी:
- बुनियादी दस्तावेज़ स्थानीय तौर पर डाउनलोड करें और बनाएं.
- ज़रूरी फ़ाइलें जनरेट करने के लिए, Babel का इस्तेमाल करें.
- स्ट्रिंग के लिए अनुवाद डालें.
- स्फ़िंक्स का इस्तेमाल करके अनुवाद किए गए दस्तावेज़ बनाना.
- परिवर्तन लागू करें.
DELIVERABLE 5 [हफ़्ता 9 से 10वां हफ़्ता]: मॉड्यूल से जुड़े दस्तावेज़ तैयार करें. जैसा कि मेंटॉर के साथ बातचीत की गई है, मेरी योजना दो भागों में मॉड्यूल के दस्तावेज़ तैयार करने की है.
भाग - I: एक स्क्रिप्ट के ज़रिए मॉड्यूल के नज़दीक फ़ाइलें बनाना जो कोड बेस से मान्य विकल्प तलाशती है और उनके एक पंक्ति के इस्तेमाल (और डिफ़ॉल्ट वैल्यू) को संबंधित विकी पेजों से निकालती है. यह एक बेसिक ड्राफ़्ट के तौर पर काम करेगा.
भाग - II: प्लैटफ़ॉर्म के हिसाब से एक स्ट्रक्चर बनाना, जो किसी प्लैटफ़ॉर्म (Windows और अगर समय हो, तो Fedora के लिए भी) के लिए सभी मॉड्यूल+प्लगिन+विकल्पों को लिंक करता है.
मॉड्यूल के पास फ़ाइलें बनाने से यह पक्का होगा कि दस्तावेज़ सोर्स कोड के करीब है. सबसे नीचे के तरीके का इस्तेमाल करके, मुख्य मॉड्यूल से जुड़े दस्तावेज़ बनाने के लिए, पार्ट - I में बनी फ़ाइलों को मिलाकर, रेफ़रंस के तौर पर पार्ट - II में बनाए गए स्ट्रक्चर का इस्तेमाल किया जाएगा.
ऑटोमेशन की मदद से बनाई गई फ़ाइलों की समीक्षा करनी होगी. हालांकि, सबसे पहले फ़ंक्शनल फ़्रेमवर्क बनाना ज़रूरी है. इसके बाद, उपलब्ध समय के हिसाब से, विकल्पों की पुष्टि करने के लिए फ़ाइलों की समीक्षा की जाएगी. फ़्रेमवर्क के उपलब्ध होने के बाद, इसे प्राथमिकता दी जा रही है. इसके इस्तेमाल के उदाहरण जोड़कर, डेवलपर और मेंटेन करने वाले लोग भी योगदान देना शुरू कर सकते हैं.
BONUS DELIVERABLE [11वां हफ़्ता]: 4.0 रिलीज़ के लिए तैयार हो जाएं. अगर प्रोजेक्ट शेड्यूल के मुताबिक बना रहता है, तो मुझे एक बोनस मिलेगा. जैसा कि मेंटॉर ने बताया, 4.0 रिलीज़ की तैयारी का मतलब है, वर्शन 3.0 के लिए एक स्थिर और करीब-करीब पूरा दस्तावेज़ मौजूद होना.
इसलिए, मुझे यहां दिए गए तरीकों की पुष्टि करने और उन्हें अपडेट करने के लिए, नीचे दिए गए सेक्शन के पहले से भरे गए दस्तावेज़ देखने होंगे:
- सामान्य इस्तेमाल: मीडिया, प्लेबैक, ऑडियो, वीडियो, सबटाइटल, हॉटकी, रिकॉर्डिंग, सेटिंग, सलाह, और तरकीबें.
- बेहतर इस्तेमाल: प्लेयर, इंटरफ़ेस, ट्रांसकोड, स्ट्रीमिंग, असामान्य मामले.
- ऐड-ऑन: एक्सटेंशन, स्किन.
12वां हफ़्ता: ऊपर दिए गए तीन डिलीवरी और फ़ाइनल रिपोर्ट का बफ़र हफ़्ता.
इस प्रोजेक्ट का अधिकार रखने वाला व्यक्ति ही क्यों है?
टेक्नोलॉजी में दिलचस्पी रखने वाले के तौर पर, मुझे सॉफ़्टवेयर को इस्तेमाल करने/टेस्ट करने का अनुभव है. साथ ही, समय-समय पर, मैं सॉफ़्टवेयर के कोड बेस से कोई मतलब निकालने की कोशिश करती हूं. असल में, एक ओपन-सोर्स संगठन के कोड बेस को समझने की कोशिश करना पहली बार था, जब मैंने दस्तावेज़ की अहमियत को असल में समझा. इसके अलावा, संगीत का एक शौकीन होने के नाते, मुझे VLC के साथ काम करने का काफ़ी अनुभव है :)
इसके अलावा, मैं ज़िंदगी भर एक रिसर्चर और लेखक रही हूं. जब तक मैं कुछ नहीं लिखता, तब तक मैं उसे कभी समझ नहीं पाता. इस आदत ने मुझे एक बेहतरीन नोट बनाने वाला और डॉक्यूमेंट्री बनाने में मदद की है.
इन दोनों आदतों की वजह से, मैं तकनीकी दस्तावेज़ के लिए सही व्यक्ति बन पाता हूं. मैं तकनीकी पहलुओं के साथ-साथ अपने नतीजों/प्रोसेसों को इस तरह से रिकॉर्ड करने की कोशिश कर सकता/सकती हूं कि लोग इन्हें समझ पाएं.
लिंक: [1] https://wiki.videolan.org/Docs:User_Guide/ [2] https://vlc-user-document.readthedocs.io/en/latest/index.html [3] https://docs.blender.org/manual/en/latest/ [4] https://docs.blender.org/api/current/index.html [5] https://docs.blender/docs.LC/guidelines.ctx.ctx. वेबलिंक