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