एपीआई लेखक

एक एपीआई लेखक एक तकनीकी लेखक है जो एक अप्लिकेशन प्रोग्रामिंग अंतरफलक (एपीआई) का वर्णन करने वाले दस्तावेज़ लिखता है। प्राथमिक दर्शकों में प्रोग्रामर, डेवलपर्स, सिस्टम आर्किटेक्ट और सिस्टम डिजाइनर शामिल हैं।

सिंहावलोकन

एक एपीआई एक पुस्तकालय (कम्प्यूटिंग) है जिसमें सॉफ्टवेयर एप्लिकेशन बनाने के लिए इंटरफेस, फ़ंक्शंस, क्लास (कंप्यूटर साइंस), स्ट्रक्चर, एन्यूमरेशन आदि शामिल हैं। इसका उपयोग डेवलपर्स द्वारा सॉफ़्टवेयर के साथ सहभागिता करने और उसका विस्तार करने के लिए किया जाता है। किसी दिए गए प्रोग्रामिंग भाषा या सिस्टम के लिए एक एपीआई में सिस्टम-परिभाषित और उपयोगकर्ता-परिभाषित निर्माण शामिल हो सकते हैं। जैसे-जैसे इन निर्माणों की संख्या और जटिलता बढ़ती है, डेवलपर्स के लिए सभी कार्यों और परिभाषित मापदंडों को याद रखना बहुत कठिन हो जाता है। इसलिए, एपीआई लेखक कंप्यूटर सॉफ्टवेयर अनुप्रयोगों के निर्माण में महत्वपूर्ण भूमिका निभाते हैं।

तकनीकी विषय वस्तु के कारण, एपीआई लेखकों को एपीआई दस्तावेजों की आवश्यकता वाली जानकारी निकालने के लिए एप्लिकेशन स्रोत कोड को पर्याप्त रूप से समझना चाहिए। एपीआई लेखक अक्सर टूलिंग का उपयोग करते हैं जो प्रोग्रामर द्वारा स्रोत कोड में संरचित तरीके से रखे गए सॉफ़्टवेयर दस्तावेज़ों को निकालता है, टिप्पणियों और प्रोग्रामिंग के बीच संबंधों को संरक्षित करता है जो वे दस्तावेज़ बनाते हैं।

एपीआई लेखकों को सॉफ्टवेयर उत्पाद को समझना चाहिए और नए सॉफ्टवेयर रिलीज के हिस्से के रूप में नई सुविधाओं या परिवर्तनों को दस्तावेज करना चाहिए। सॉफ़्टवेयर रिलीज़ का शेड्यूल संगठन से संगठन में भिन्न होता है। एपीआई लेखकों को सॉफ़्टवेयर जीवन चक्र को अच्छी तरह से समझने और स्वयं को सिस्टम विकास जीवन चक्र (एसडीएलसी) में एकीकृत करने की आवश्यकता है।

संयुक्त राज्य अमेरिका में एपीआई लेखक आमतौर पर व्याकरण और विराम चिह्न के स्टाइल का शिकागो मैनुअल का पालन करते हैं।

योग्यता

एपीआई लेखकों के पास आमतौर पर प्रोग्रामिंग और भाषा कौशल का मिश्रण होता है; कई एपीआई लेखकों के पास कंप्यूटर प्रोग्रामिंग या तकनीकी लेखन की पृष्ठभूमि है।

• कंप्यूटर प्रोग्रामिंग पृष्ठभूमि (सी (प्रोग्रामिंग भाषा), सी ++ , जावा (प्रोग्रामिंग भाषा), पीएचपी, या अन्य प्रोग्रामिंग भाषाओं का ज्ञान)
• Doxygen, Javadoc, OpenAPI विशिष्टता, या डार्विन सूचना टंकण वास्तुकला जैसे स्वरूपण मानकों का ज्ञान
• फ्रेम मेकर जैसे संपादकों और टूल का ज्ञान
• डेवलपर्स के साथ बातचीत करने के लिए उत्कृष्ट संचार और लेखन कौशल

विशेषज्ञ एपीआई/सॉफ़्टवेयर विकास किट (एसडीके) लेखक आसानी से कंप्यूटर प्रोग्रामिंग लेखक बन सकते हैं।

एपीआई लेखन प्रक्रिया

एपीआई लेखन प्रक्रिया आमतौर पर स्रोत कोड, योजना, लेखन और समीक्षा के विश्लेषण और समझने के बीच विभाजित होती है। अक्सर ऐसा होता है कि विश्लेषणात्मक, नियोजन और लेखन चरण एक सख्त रैखिक फैशन में नहीं होते हैं।

लेखन और मूल्यांकन मानदंड संगठनों के बीच भिन्न होते हैं। कुछ सबसे प्रभावी एपीआई दस्तावेज उन लोगों द्वारा लिखे गए हैं जो किसी विशेष एप्लिकेशन के कामकाज को समझने में पर्याप्त रूप से सक्षम हैं, ताकि वे सॉफ्टवेयर को उपयोगकर्ताओं या विभिन्न घटक निर्माणों को कार्यक्रम के समग्र उद्देश्य से संबंधित कर सकें। एपीआई लेखक उपयोगकर्ता (कंप्यूटिंग)|अंतिम-उपयोगकर्ता उत्पाद प्रलेखन को संलेखित करने के लिए भी जिम्मेदार हो सकते हैं।

जबकि संदर्भ दस्तावेज़ पूर्णता सुनिश्चित करने के लिए स्वत: उत्पन्न हो सकते हैं, दस्तावेज़ीकरण जो डेवलपर्स को आरंभ करने में मदद करता है, एक पेशेवर एपीआई लेखक द्वारा लिखा जाना चाहिए और विषय वस्तु विशेषज्ञों द्वारा समीक्षा की जानी चाहिए। इससे यह सुनिश्चित करने में मदद मिलती है कि डेवलपर्स प्रमुख अवधारणाओं को समझते हैं और जल्दी से शुरू कर सकते हैं।

उत्पाद

एपीआई लेखक दस्तावेज तैयार करते हैं जिनमें शामिल हैं:

• एपीआई संदर्भ गाइड
• प्रोग्रामर गाइड
• डेवलपर मैनुअल
• प्रशासन मैनुअल
• स्थापना गाइड
• कार्यान्वयन और एकीकरण गाइड

यह भी देखें

• तकनीकी संचार
• तकनीकी संचार उपकरण
• प्रलेखन जनरेटर की तुलना