इस पेज में, Docs के Google सीज़न के लिए स्वीकार किए गए तकनीकी राइटिंग प्रोजेक्ट की जानकारी दी गई है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- OpenMRS.org
- तकनीकी लेखक:
- आयशमंथा
- प्रोजेक्ट का नाम:
- REST API के लिए, उपयोगकर्ता के हिसाब से सही GithHub दस्तावेज़ बनाना
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
प्रोजेक्ट का मुख्य मकसद एक इंटरैक्टिव दस्तावेज़ तैयार करना है. इसमें असली उपयोगकर्ता, एपीआई आज़माने के विकल्पों के साथ एपीआई के साथ इंटरैक्ट कर सकते हैं. इस दौरान, वे ज़्यादा जानकारी और खुद से जानकारी देने वाली जानकारी भी दे सकते हैं. इस जानकारी से यह पता चलता है कि तकनीकी और गैर-तकनीकी लोगों को किस स्थिति में एंडपॉइंट का इस्तेमाल करना चाहिए.
स्वैगर के मौजूदा माहौल में टेक्नोलॉजी के क्षेत्र से जुड़े लोगों और टेक्नोलॉजी के लोगों के लिए, अब भी सही दस्तावेज़ के बिना कोई आइडिया पाना मुश्किल है. मुख्य आइडिया यह है कि इस शानदार सुविधा और दस्तावेज़ को एक ही जगह पर बेहतर तरीके से दिखाया जाए. JS, एचटीएमएल, और सीएसएस की मदद से.