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