इस पेज में एक तकनीकी लेखन प्रोजेक्ट की जानकारी है, जिसे दस्तावेज़ के Google सीज़न के लिए स्वीकार किया जाता है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- OpenMRS.org
- टेक्निकल राइटर:
- batbrain7
- प्रोजेक्ट का नाम:
- OpenMRS REST API का दस्तावेज़
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
मैं अपने प्रस्ताव को अलग-अलग सेक्शन में बांटूंगा और Google Maps API दस्तावेज़ और GitHub API दस्तावेज़ जैसे फ़्लो का पालन करूंगा.
इनके अलावा, मैं एपीआई दस्तावेज़ के लिए रीडमी स्ट्रक्चर का भी सुझाव देना चाहूंगा, जो realworld.io ने किया है: https://github.com/gothinkster/realworld/tree/master/api
मुझे यह दस्तावेज़ समझने और इस्तेमाल करने में काफ़ी आसानी हुई.
मेरे प्रस्ताव में मुख्य रूप से तीन सेक्शन होंगे :
इस सेक्शन में, API, OpenMRS, और एपीआई के इस्तेमाल के तरीके के बारे में कम शब्दों में जानकारी दी जाती है. साथ ही, यह भी बताया जाता है कि इसके बाद क्या होता है.
एपीआई पासकोड और पुष्टि करने का तरीका, जो आम तौर पर एपीआई अनुरोध करने के लिए ज़रूरी होता है. इसमें एपीआई में मौजूद पुष्टि के टाइप, कुंजी और वैल्यू के लिए सैंपल के तौर पर दिया गया उदाहरण शामिल होगा. साथ ही, इसमें उन वैल्यू के उदाहरण भी शामिल होंगे जिन्हें उस हिस्से में मौजूद कुंजी के हिसाब से स्वीकार किया जाता है. किसी भी भाषा में कोड का सैंपल, एपीआई में हेडर और रिस्पॉन्स फ़ॉर्मैट और अन्य क्वेरी पैरामीटर लिखने का तरीका समझने में मदद करेगा.
एपीआई से फ़ेच किए गए जवाबों के टाइप, JSON के टाइप या एपीआई से मिले किसी भी अन्य तरह के नतीजे के बारे में बताया जाना चाहिए.
अलग-अलग एपीआई रूट और उन सभी पैरामीटर के साथ-साथ हेडर और अन्य चीज़ों को भेजने की ज़रूरत है. हर एपीआई के लिए, कुछ भाषाओं में कोड सैंपल दिए जाएंगे. इनसे यह पता चलता है कि कोड लिखते समय अनुरोध कैसे किया जाता है. इसके अलावा, हर एपीआई के लिए गड़बड़ी के सामान्य कोड भी बताए जाने चाहिए.
इस इमेज में बताया गया है कि REST API के लिए दस्तावेज़ कैसे बनाए जाएंगे.
प्रोजेक्ट का शेड्यूल इस प्रकार है :
1 अगस्त से 1 सितंबर
मेरे मेंटर से मिलें और कोडबेस के अलग-अलग हिस्सों में दस्तावेज़ के लेवल के बारे में ज़्यादा जानकारी पाएं. साथ ही, कम लेवल बनाम ज़्यादा लेवल के दस्तावेज़ के बारे में भी बातचीत करें. इस समय का इस्तेमाल, कोडबेस को समझने और कॉन्सेप्ट को पढ़ने में भी किया जाएगा, ताकि मैं उन्हें बेहतर तरीके से दस्तावेज़ में शामिल कर सकूं.
पहला और दूसरा हफ़्ता
मैं योगदान देने वालों की गाइड को अपडेट करूँगी और इसके बारे में ज़्यादा जानकारी दूंगी. मैं सोर्स कोड बनाने के तरीके से जुड़े दस्तावेज़ों में सुधार करूंगा. हम दस्तावेज़ बनाने वाले लोगों के लिए एक सेक्शन भी जोड़ेंगे. इसमें यह जानकारी दी जाएगी कि नए योगदानकर्ता, दस्तावेज़ बनाने में कैसे मदद कर सकते हैं. मैं एपीआई के अलग-अलग दस्तावेज़ों का अध्ययन करूंगा और एपीआई के बारे में जानकारी देने से शुरुआत करूंगा. साथ ही, एपीआई के लिए पुष्टि करने की सुविधा जोड़ूंगा.
तीसरा से आठवां हफ़्ता
हम हर तरह के एपीआई के लिए, कुछ कोड सैंपल के साथ-साथ एपीआई रूट और रिस्पॉन्स जोड़ेंगे. ऐसा हो सकता है कि मिलते-जुलते एपीआई हों.
नौवां और दसवां हफ़्ता
लिंक का इस्तेमाल करके, एपीआई दस्तावेज़ का स्ट्रक्चर जोड़ें. जैसे, लंबे एपीआई दस्तावेज़ के लिए लिंक किया गया इंडेक्स. साथ ही, इसे अलग-अलग आधार पर बांटें, जैसे कि कोड सेक्शन, खास जानकारी, पैरामीटर, रूट एंडपॉइंट.
आखिरी हफ़्ता
मैं अपने 12 हफ़्तों की दस्तावेज़ अवधि के दौरान किए गए काम की आखिरी रिपोर्ट तैयार करने के लिए, आखिरी हफ़्ते का इस्तेमाल करूंगा/करूंगी. इस समय का इस्तेमाल, दस्तावेज़ों की समीक्षा करने और उन्हें फ़ाइनल करने के लिए भी किया जाएगा.