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