इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Zulip ओपन सोर्स टीम चैट
- तकनीकी लेखक:
- ड्रोसा
- प्रोजेक्ट का नाम:
- ReadTheDocs और एपीआई Docs की रीफ़ैक्टरिंग
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
मैं दो क्षेत्रों पर फ़ोकस करूंगी और साथ-साथ उन पर काम करूंगा. इनमें से एक तरीका zulip.readthedocs.io की क्वालिटी को बेहतर बनाना है, ताकि योगदान देने वाले नए लोगों को भ्रम और उलझनों का सामना न करना पड़े. बेहतर होगा कि पहली बार के योगदान से लेकर ज़ूलिप के काम करने के तरीके के बारे में जानने तक, यह एक आसान और सटीक तरीका हो. अन्य एंडपॉइंट के दस्तावेज़ बनाने की प्रोसेस को समझने में आसान बनाने के लिए, मैंने zulipchat.com/api, api.md, और openapi.md पर भी काम किया. इन दोनों हिस्सों में, कॉन्टेंट को अपडेट/आसान बनाना, लेखों में से ग़ैर-ज़रूरी चीज़ें शामिल करना, डेवलपर दस्तावेज़ न जोड़ना, और कोड लिखना/जांच करना शामिल हो सकता है.
यह प्रोजेक्ट चार चरणों में पूरा होगा. पहले चरण में, जानकारी उपलब्ध कराने वाले छोटे प्रोजेक्ट, तैयारी के लिए टूल तैयार करना, और दस्तावेज़ की मौजूदा ज़रूरतों की बेहतर जानकारी शामिल होगी. दूसरे चरण का मकसद, पतझड़ के इस मौसम में ज़ूलिप के लक्ष्यों के हिसाब से काम की संरचना तैयार करना, उसके बारे में जानकारी देना, और उसकी प्राथमिकता तय करना होगा. इसके बाद, प्रोजेक्ट को लागू करने के चरण पर बात की जाएगी. मैं सुझाव देने के लिए मेंटॉर और ज़ूलिप के बाकी डेवलपर समुदाय के साथ मिलकर, उनसे बातचीत करूंगा. आखिरी चरण में, चीज़ों को दोबारा देखना, ज़रूरत के हिसाब से उनमें बदलाव करना, और प्रोजेक्ट रिपोर्ट तैयार करनी होती है.
मुझे लगता है कि काम के दौरान बाकी कामों की वजह से, कुछ प्राथमिकताएं और टास्क बदल सकते हैं. इनमें मुख्य डेवलपर के फ़ैसले भी शामिल हैं. मुझे उम्मीद है कि जीएसओडी के बेहतर अनुभव के लिए, यह सीखना ज़रूरी है कि इन बदलावों के हिसाब से कैसे बदलाव किए जाएं. आने वाले समय में, सुझाए गए आइडिया को आगे के लिए स्थगित करना सही रहेगा. आम तौर पर, मेरा फ़ोकस यह पक्का करने पर रहेगा कि मेरे काम से Julip के ओपन सोर्स प्रोजेक्ट की सफलता को कोई फ़ायदा मिले.