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