OpenMRS.org प्रोजेक्ट

इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.

प्रोजेक्ट की खास जानकारी

ओपन सोर्स संगठन:

OpenMRS.org

टेक्निकल राइटर:

आयशमेंथा

प्रोजेक्ट का नाम:

REST API के लिए, उपयोगकर्ता के हिसाब से बनाए गए GitHub दस्तावेज़ बनाना

प्रोजेक्ट की अवधि:

स्टैंडर्ड अवधि (तीन महीने)

प्रोजेक्ट का विवरण

इस प्रोजेक्ट का मुख्य मकसद, एक ऐसा इंटरैक्टिव दस्तावेज़ बनाना है जिसमें असली उपयोगकर्ता, एपीआई के साथ इंटरैक्ट कर सकें. साथ ही, इसमें एंडपॉइंट के इस्तेमाल के बारे में ज़्यादा जानकारी दी गई हो. इससे तकनीकी और गैर-तकनीकी लोगों को यह समझने में मदद मिलेगी कि किन स्थितियों में एंडपॉइंट का इस्तेमाल करना चाहिए.

मौजूदा swagger एनवायरमेंट बहुत अच्छा है. हालांकि, टेक्नोलॉजी के बारे में कम जानकारी रखने वाले लोगों और टेक्नोलॉजी के बारे में ज़्यादा जानकारी रखने वाले लोगों के लिए, सही दस्तावेज़ के बिना सीधे तौर पर कोई आइडिया पाना मुश्किल है. मुख्य मकसद, इस स्वैगर एनवायरमेंट और दस्तावेज़ को एक ही जगह पर बेहतर तरीके से दिखाना है. JS, एचटीएमएल, और सीएसएस की मदद से.