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