इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- जूलिया की भाषा
- तकनीकी लेखक:
- mkg33
- प्रोजेक्ट का नाम:
- साइंटिफ़िक मशीन लर्निंग का यूनिफ़ाइड दस्तावेज़
- प्रोजेक्ट की अवधि:
- लंबे समय तक दौड़ना (पांच महीने)
प्रोजेक्ट का विवरण
मुझे SciML संगठन के इंटिग्रेशन के लिए काम करना है, क्योंकि इस क्षेत्र में सुधार की काफ़ी गुंजाइश है. इस प्रोजेक्ट के पूरा होने से, Julia प्रोग्रामर और SciML के सक्रिय योगदान देने वालों/रखरखावों, दोनों को तुरंत फ़ायदा मिलेगा. पूरे SciML पैकेज में कुछ ज़रूरी टूल मिलते हैं. हालांकि, इस बात का खतरा हमेशा रहता है कि शायद उन पर ध्यान न दिया जाए (खास तौर पर, नए लोग). ऐसा इसलिए हो सकता है, क्योंकि उपयोगकर्ता पैकेज को नहीं ढूंढ पाता है और उसे अपनी समस्या के समाधान के लिए इस्तेमाल नहीं कर पाता है.
हालांकि, पैकेज का मुख्य मकसद प्रोग्रामर की ज़्यादा से ज़्यादा ऑडियंस (जैसे, नौसिखिए और विशेषज्ञ) तक पहुंचना है, इसलिए यह निराश करने वाली बात है. ऊपर बताई गई स्थिति से बचने के लिए, हमारा सुझाव है कि SciML दस्तावेज़ के 'फ़्रंट पेज' में बदलाव करें. साथ ही, एक ऐसा हब बनाएं जिसका इस्तेमाल लोग मिलते-जुलते पैकेज को ब्राउज़ करने और बढ़ते नेटवर्क को एक्सप्लोर करने के लिए कर सकें. इसकी मदद से, ज़्यादा अनुभवी उपयोगकर्ताओं को मदद मिल सकती है और वे ज़्यादा बेहतर तरीके से काम कर सकते हैं.
सबसे पहले, हर पैकेज के मौजूदा दस्तावेज़ में स्टाइल से जुड़ी बुनियादी समस्याओं (जैसे कि वर्तनी, विराम चिह्न, व्याकरण वगैरह) में बदलाव की ज़रूरत होती है. स्टाइल को एक जैसा बनाए रखने के लिए, SciML चैनल पर एक कंक्रीट स्टाइल गाइड की ज़रूरत होती है. इससे पुराने बदलाव करने और आने वाले समय में रेफ़रंस देने के लिए ज़रूरी है. नए सिरे से शुरुआत करने में समय बर्बाद नहीं होगा. इसके बजाय, इसे जूलिया के मौजूदा तौर-तरीकों पर आधारित होना चाहिए. साथ ही, इसमें SciML से जुड़ी समस्याओं के लिए नए वाक्य शामिल किए जाने चाहिए.
स्टाइल गाइड पूरी हो जाने के बाद, प्रोजेक्ट के दूसरे चरण में मौजूदा दस्तावेज़ में बदलाव किया जाता है. इससे दस्तावेज़ ज़्यादा पेशेवर और बेहतर तरीके से काम करेगा. मैंने पहले ही कई पुल अनुरोध बना लिए हैं, जो इस टास्क को लेकर मेरे नज़रिए को दिखाते हैं. इस चरण में, मेरी कोशिश एक असरदार उद्धरण सिस्टम बनाने और उसे लागू करने का भी है. सबसे पहला काम, पुराने उद्धरण पेज को अपडेट करना होगा.
तीसरा चरण, सबसे अहम है, एससीआईएमएल रोडमैप को डिज़ाइन करना. इस चरण में, बिखरे हुए पैकेज के बीच के इंटरैक्शन पर ज़ोर दिया जाएगा. दो पैकेज के बीच का तालमेल जितना मज़बूत होगा (समस्या या कोड के हिसाब से), वे 'यह भी देखें' सूची में उतने ही करीब दिखेंगे. मेरा सुझाव है कि आप दो सुझाव कुंजियां बनाएं: एक कोड समानता के लिए और दूसरी समस्या से मेल खाने के लिए. इस तरह उपयोगकर्ता इससे जुड़े डेटा स्टोर करने की जगहों और दस्तावेज़ों की मदद से, ज़्यादा तेज़ ब्राउज़िंग करने के मुकाबले ज़्यादा तेज़ी से काम के अन्य पैकेज की पहचान कर पाएंगे. पैकेज के सभी संभावित कनेक्शन की सूची बनाने के बजाय, मुझे बड़े पैकेज पर फ़ोकस करना है और उनके लिंक छोटे पैकेज के साथ शेयर करने की कोशिश करनी है. इस तरीके को ट्यूटोरियल को अपडेट करने के लिए इस्तेमाल किया जाएगा, जहां किसी दूसरे पैकेज के कनेक्शन के बारे में बताया जाना चाहिए. यह तरीका इस बात की गारंटी देता है कि 'यह भी देखें' सूचियां, जानकारी देने वाली होंगी. हालांकि, इनमें पैकेज के कॉम्बिनेशन की पूरी सूची नहीं होनी चाहिए.