इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Julia भाषा
- टेक्निकल राइटर:
- शुओ लियू
- प्रोजेक्ट का नाम:
- LightGraphs Docs 2.0 और उपयोगकर्ता के हिसाब से बनाए गए JuliaGraphs ट्यूटोरियल
- प्रोजेक्ट की अवधि:
- लंबे समय तक दौड़ना (पांच महीने)
प्रोजेक्ट का विवरण
लंबे समय तक चलने वाले इस प्रोजेक्ट में, मैं JuliaGraphs के मॉड्यूल की वेबसाइट और दस्तावेज़ों को बेहतर तरीके से पेश कर रही हूं. खास तौर पर, मेरे काम में ये कॉन्टेंट शामिल होंगे. हालांकि, इनके अलावा और भी कॉन्टेंट शामिल हो सकते हैं.
लाइटग्राफ़ दस्तावेज़ 2.0 - 10 हफ़्ते
- खास जानकारी: LightGraphs.jl, Julia के लिए ऑप्टिमाइज़ किया गया हल्का ग्राफ़ पैकेज है. यह JuliaGraphs नेटवर्क का मुख्य हिस्सा है. LightGraphs के आने वाले वर्शन 2.0 में, LightGraphs एपीआई में हुए बुनियादी बदलाव को दिखाया गया है. मैं पक्का करूंगा कि दस्तावेज़ में LightGraphs की नई और बेहतरीन सुविधाओं के बारे में बताया गया हो.
- डिलीवर किए जाने वाले आइटम: मैं मौजूदा एपीआई दस्तावेज़ों का ऑडिट करूंगा, ताकि यह पता लगाया जा सके कि कौनसे दस्तावेज़ पहले जैसे ही रह सकते हैं. साथ ही, 2.0 रिलीज़ में किए गए बदलावों का विश्लेषण करूंगा, ताकि यह पक्का किया जा सके कि उन्हें उदाहरणों के साथ सही तरीके से दस्तावेज़ में शामिल किया गया है. इस प्रोसेस के दौरान, मैं ऐसी पोस्ट लिखूंगा जिनमें 2.0 रिलीज़ में किए गए बड़े बदलावों के बारे में बताया गया हो. नए लोगों को LightGraphs को बेहतर तरीके से समझने में मदद करने के लिए, मैं शुरुआती लोगों के लिए गाइड बनाऊंगा. ये गाइड, उन लोगों के लिए होंगी जो Julia में ग्राफ़ का इस्तेमाल करना शुरू कर रहे हैं.
- ध्यान दें: इस प्रोजेक्ट में, LightGraphs दस्तावेज़ बनाने के लिए, Documenter.jl का इस्तेमाल दस्तावेज़ जनरेटर के तौर पर किया जाएगा. Coloring.jl जैसे मॉड्यूल के लिए एपीआई रेफ़रंस के अलावा, मुझे greedy_color.jl जैसे सबमॉड्यूल के लिए भी इनकी ज़रूरत है. मुझे LightGraphs के दस्तावेज़ को रिन्यू करने के लिए, उन्हें जोड़ने का तरीका पता चलेगा. इसके अलावा, ग्राफ़ थ्योरी गणित का काफ़ी तकनीकी क्षेत्र है. जिन लोगों की गणित की जानकारी नहीं है उनके लिए ग्राफ़ थ्योरी काफ़ी समझ नहीं आती. मैंने करीब दो साल तक अकादमिक रिसर्च की है और अपनी निजी वेबसाइट पर कई ब्लॉग पोस्ट लिखी हैं. इसलिए, मुझे भरोसा है कि शुरुआती लोगों के लिए गाइड बनाते समय, अलग-अलग एल्गोरिदम के बारे में आसानी से बताया जा सकता है. साथ ही, यह भी बताया जा सकता है कि अलग-अलग स्थितियों में किस एल्गोरिदम का इस्तेमाल करना है.
JuliaGraphs ट्यूटोरियल - 10 हफ़्ते
- खास जानकारी: JuliaGraphs पैकेज के कई दस्तावेज़, डेवलपर के लिए हैं. हम कुछ आसान उदाहरण जोड़ेंगे और हर सुविधा के इस्तेमाल के बारे में बताएंगे, ताकि उपयोगकर्ताओं को इसे इस्तेमाल करने में आसानी हो.
- डिलीवर किए जाने वाले आइटम: मैं LightGraphs के मौजूदा ट्यूटोरियल का ऑडिट करूंगा, ताकि यह पता लगाया जा सके कि कौनसे कॉन्टेंट को जोड़ना है. साथ ही, हर सुविधा के इस्तेमाल और फ़ायदों के बारे में बताऊंगा. इसके बाद, मैं JuliaGraphsTutorials के तरीके का इस्तेमाल करके, JuliaGraphs के ट्यूटोरियल को बढ़ाऊंगा. इसमें, LightGraphs के पारिस्थितिक तंत्र में शुरुआती लोगों के लिए गाइड भी शामिल होगी.
- ध्यान दें: फ़िलहाल, JuliaGraphsTutorials का कॉन्टेंट पूरी तरह से तैयार नहीं है. ऊपर दी गई डिलीवरबल, ज़्यादातर LightGraphs पैकेज के लिए हैं. अगर समय सही लगता है, तो मैं JuliaGraphs में मौजूद अन्य मॉड्यूल के लिए ट्यूटोरियल भी जोड़ऊंगा. जैसे, GraphPlot.jl, MetaGraphs.jl, और SimpleWeightedGraphs.jl.
JuliaGraphs Central की वेबसाइट - चार हफ़्ते
- खास जानकारी: JuliaGraphs की मुख्य वेबसाइट पर, इकोसिस्टम के पैकेज की खास जानकारी मिलती है. हालांकि, इसमें अब भी ज़्यादातर जानकारी दी गई है. इसे और बेहतर बनाया जा सकता है, ताकि यह Julia में ग्राफ़ बनाने की शुरुआत करने वाले लोगों के लिए पहला संसाधन बन सके. मैं विज़ुअलाइज़ेशन का इस्तेमाल करके, JuliaGraphs के अलग-अलग पैकेज की सुविधाओं को हाइलाइट करने का आसान तरीका ढूंढूंगा.
- डिलीवरेबल: मैं JuliaGraphs के पैकेज की सुविधाओं को हाइलाइट करने के लिए, इस्तेमाल के उदाहरण और उदाहरण उपलब्ध कराऊंगा. साथ ही, यह पक्का करने के लिए ऑडिट भी करूंगा कि ये काम के हैं और काम करते हैं. मैं एक सेक्शन बनाऊंगा, जिसमें अलग-अलग डोमेन (स्वास्थ्य सेवा, शिक्षा वगैरह) में अलग-अलग पैकेज के अलग-अलग इस्तेमाल को हाइलाइट किया जाएगा अगर समय दिया जाए, तो मैं ग्राफ़ में इस्तेमाल किए गए एल्गोरिदम की विज़ुअल जानकारी को रिसर्च करूंगा.
- ध्यान दें: JuliaGraphs के कई पैकेज का इस्तेमाल, अलग-अलग डोमेन में बड़े पैमाने पर किया गया है. NetworkViz के लिए DiGraph जैसे एक्सटेंशन के अलावा, मैं कुछ खास विषयों के कुछ अन्य ऐप्लिकेशन भी शामिल करूंगा. जैसे, जीव विज्ञान में बायोस्ट्रक्चर के लिए MetaGraph, शहरी योजना में TrafficAssighnment के लिए DijkstraState, शिक्षा में TreeView के लिए DiGraph वगैरह.