इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- खाने की चीज़ों से जुड़ी जानकारी खोलें
- तकनीकी लेखक:
- FutureOfDocs
- प्रोजेक्ट का नाम:
- ओपन फ़ूड फ़ैक्ट्स एपीआई का दस्तावेज़ बनाएं
- प्रोजेक्ट की अवधि:
- लंबे समय तक दौड़ना (पांच महीने)
प्रोजेक्ट का विवरण
मैंने पहली बार "Docs के सीज़न" के बारे में कुछ महीने पहले लिए, REST API के दस्तावेज़ों के एक कोर्स के शिक्षक से मिले एक ई-मेल के ज़रिए सुना. हालांकि, मुझे यह आइडिया पसंद आया, लेकिन मैंने तय किया कि मुझे किसी प्रोजेक्ट के लिए तभी आवेदन करना चाहिए, जब मैं उसे समझ सकूं. अपने सामान्य काम के अलावा मैं यह काम करता था. अगर मैं यह कर पाऊं, तो यह मज़ेदार और फ़ायदेमंद होना चाहिए.
जब मैंने Open Food Facts का ब्यौरा पढ़ा, तब मुझे पता था कि मुझे वह प्रोजेक्ट मिल गया है. मुझे कसरत और खान-पान के ज़रिए, अपने शरीर और सेहत का ख्याल रखना पसंद है. मुझे सच में लगता है कि पोषण, खुशहाल ज़िंदगी की कुंजी है और हम सभी को बेहतर विकल्प चुनने चाहिए. ऐसा करना तभी मुमकिन है, जब हमारे पास खाने-पीने की चीज़ों और कॉस्मेटिक के बारे में पूरी जानकारी हो. Food Facts में जाकर, यह जानकारी हमारे लिए उपलब्ध कराई जाती है. मैं इस शानदार पहल में योगदान देना चाहता हूं.
पिछले तीन सालों से, मैं एक सॉफ़्टवेयर डेवलपमेंट कंपनी में तकनीकी लेखक के तौर पर काम कर रही हूं. इस कंपनी में, मैं प्रोसेस और ऑटोमेशन में विशेषज्ञ हूं. इसके अलावा, हमने स्वैगर के साथ REST API लागू किया है जिसकी मदद से डेवलपर, एपीआई अनुरोधों के ज़रिए हमारे ऐप्लिकेशन से संपर्क कर सकते हैं. मैंने अनुरोधों/जवाबों के लिए बेहतर ब्यौरा लिखने में डेवलपमेंट टीम की मदद की है. साथ ही, हमने यह भी पता लगाया है कि हमारे ग्राहकों को कौनसी जानकारी साफ़ तौर पर और कम शब्दों में देने के लिए ज़रूरी है.
मैं Open Food Facts API की मौजूदा साइट की समीक्षा कर रहा हूं. मुझे लगता है कि हम दस्तावेज़ों को फिर से तैयार कर सकते हैं और इन्हें बेहतर बना सकते हैं, ताकि लोगों के लिए इसे और ज़्यादा आसान बनाया जा सके (सामान्य, पढ़ें, और फिर से लिखे गए पेज पर). इसके अलावा, मुझे डेवलपमेंट टीम के साथ मिलकर, कोड से अपने-आप एपीआई दस्तावेज़ जनरेट करने का तरीका सेट अप करने में खुशी होगी (इसमें समय लगता है. इसलिए, मैंने साथ मिलकर लंबे समय तक काम करने का सुझाव दिया है).
हम सभी को पता है कि लुक ज़रूरी है ;) इसलिए, हम REST API सीएसएस और लोगो में बदलाव कर सकते हैं, ताकि वह उपयोगकर्ता दस्तावेज़ के साथ स्वैगर यूज़र इंटरफ़ेस (यूआई) को अलाइन कर सके.
मुझे इस प्रोजेक्ट पर आपके साथ काम करने का इंतज़ार रहेगा!