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