इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Apache Flink
- टेक्निकल राइटर:
- haseeb1431
- प्रोजेक्ट का नाम:
- Apache Flink के लिए, Table API और SQL दस्तावेज़ का एक्सटेंशन
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड लंबाई (तीन महीने)
प्रोजेक्ट का विवरण
मैं “टेबल एपीआई और एसक्यूएल दस्तावेज़ को आगे बढ़ाएं” पर GSOD के लिए अपना आवेदन सबमिट कर रहा/रही हूं. हम एपीआई से जुड़े दस्तावेज़ इस तरह लिखेंगे कि दादी भी क्वेरी लिख सकें. हालांकि, हो सकता है कि हमारे पास पहले से ही स्ट्रक्चर मौजूद हो, लेकिन हम नए उपयोगकर्ताओं के तौर पर इसकी समीक्षा करेंगे और ज़रूरत पड़ने पर सुझाव देंगे. मैं अपने उद्योग के पिछले अनुभव के आधार पर अलग-अलग आइडिया शेयर करते हुए, मेंटर के साथ मिलकर काम करने की योजना बना रहा हूं, ताकि उनकी सोच को समझा जा सके.
मौजूदा दस्तावेज़ों के आधार पर, शुरुआती तौर पर ये बातें सामने आई हैं:
खास जानकारी वाले पेज पर फ़िलहाल बहुत ज़्यादा जानकारी है. इसे फिर से देखकर, इस तरह से व्यवस्थित करना होगा कि शुरुआती और बेहतर उपयोगकर्ता, दोनों इसे तुरंत इस्तेमाल कर सकें. मेरा सुझाव है कि अलग-अलग ट्रैक के साथ शुरुआत की जाए. जैसे, a) नया प्रोजेक्ट शुरू करना और फिर उस पर क्वेरी चलाना, b) किसी मौजूदा प्रोजेक्ट पर एसक्यूएल या टेबल एपीआई क्वेरी चलाना.
हमें लैंडिंग पेज पर एपीआई दस्तावेज़ का पूरा मैप भी देना होगा, ताकि उपयोगकर्ता पहली नज़र में सभी संभावनाएं देख सकें. यह खास जानकारी देने वाले मौजूदा पेज पर, “आगे कहां जाना है” सेक्शन का बेहतर वर्शन होगा.
कॉन्सेप्ट पेज पर काफ़ी अच्छा कॉन्टेंट है, लेकिन इसे एक ही पेज पर ज़रूरत से ज़्यादा भर दिया गया है. इसलिए, हम इस पेज पर कुछ सब-सेक्शन जोड़ेंगे. इसी तरह, प्लानर, पहले से मौजूद फ़ंक्शन, कनेक्टर जैसे अन्य सेक्शन को खास जानकारी वाले पेज या बाईं ओर मौजूद नेविगेशन बार पर ज़्यादा दिखाया जा सकता है. कनेक्टर पेज को कई सब-सेक्शन में बांटा जा सकता है. जैसे, कनेक्टर, फ़ॉर्मैट वगैरह. मुझे सिस्टम (पहले से मौजूद) फ़ंक्शन ठीक लगते हैं, क्योंकि हमारे पास एक ही पेज पर सभी संभावित तरीके उपलब्ध हैं और उपयोगकर्ता उन्हें हमेशा चैट शीट के तौर पर देख सकते हैं. हालांकि, हम इस बारे में ज़्यादा कॉन्टेंट जोड़ने में खुशी महसूस करेंगे.
तीन महीने की इस अवधि को अलग-अलग चरणों में बांटा जाएगा. शुरुआत में, हम टेबल और SQL API दस्तावेज़ का साइटमैप जैसा स्ट्रक्चर बनाएंगे. हम ऊपर बताए गए तरीके से, सब-सेक्शन और स्टोरी लाइन जोड़ेंगे. इसके पूरा होने के बाद, हम इसे ऐडवांस और शुरुआती लेवल के उपयोगकर्ताओं के साथ समीक्षा कर सकते हैं. वहीं दूसरी ओर, फ़ीडबैक का इंतज़ार करते समय हम प्लानर, कनेक्टर के बारे में लिखना शुरू कर सकते हैं. सुझाव, शिकायत या राय मिलने के बाद, हम अपने एपीआई दस्तावेज़ों को फिर से व्यवस्थित करेंगे. इसके बाद, हम बाकी बचे सेक्शन के लिए लेख पूरा करने पर ध्यान देंगे. आखिर में, अगर समय मिलता है, तो मैं शुरुआत से लेकर प्रोजेक्ट को लागू करने तक का उदाहरण दूंगा. इस उदाहरण का इस्तेमाल, FLINK-12639 के लिए किया जा सकता है.
मेरा सुझाव है कि हम दो हफ़्ते बाद एक घंटे की मीटिंग करें. इसमें स्लैक (या किसी अन्य टूल) पर चैट करने के अलावा, अन्य बातचीत भी की जा सकती है. हम प्रोजेक्ट की शुरुआती टाइमलाइन के बारे में बताएंगे. इसमें हफ़्ते के हिसाब से प्रोजेक्ट भी शामिल होने चाहिए. इससे हमें हर हफ़्ते प्रोजेक्ट की प्रोग्रेस को ट्रैक करने में भी मदद मिलेगी.
आखिर में, यह दस्तावेज़ medium.com पर मौजूद हमारे ब्लॉग से मिलता-जुलता है. इसमें हम Flink API की अलग-अलग सुविधाओं के बारे में जानकारी देते हैं. यह मुझे एक खास उम्मीदवार भी बनाता है, क्योंकि मैं सिर्फ़ टेक्निकल दस्तावेज़ लिखने के बजाय, दस्तावेज़ों को लागू करने की प्रोसेस के ज़रिए दस्तावेज़ों की पुष्टि करूंगी. यह प्रोजेक्ट मेरे लिए दो तरह से फ़ायदेमंद होगा. टेबल और SQL API सीखते समय, मैं ओपन-सोर्स दस्तावेज़ में योगदान दूंगा.