एपीआई लेखक: Difference between revisions
(Created page with "{{Short description|Technical writer who writes documents}} {{no footnotes|date=April 2009}} एक एपीआई लेखक एक तकनीकी लेखक ह...") |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Short description|Technical writer who writes documents}} | {{Short description|Technical writer who writes documents}} | ||
एक एपीआई लेखक एक [[तकनीकी लेखक]] है जो एक [[अप्लिकेशन प्रोग्रामिंग अंतरफलक]] (एपीआई) का वर्णन करने वाले दस्तावेज़ लिखता है। प्राथमिक दर्शकों में प्रोग्रामर, डेवलपर्स, आर्उपकरणेक्ट प्रणाली और डिजाइनर प्रणाली सम्मिलित हैं। | |||
एक एपीआई लेखक एक [[तकनीकी लेखक]] है जो एक [[अप्लिकेशन प्रोग्रामिंग अंतरफलक]] (एपीआई) का वर्णन करने वाले दस्तावेज़ लिखता है। प्राथमिक दर्शकों में प्रोग्रामर, डेवलपर्स, | |||
== सिंहावलोकन == | == सिंहावलोकन == | ||
एक एपीआई एक [[ पुस्तकालय (कम्प्यूटिंग) ]] है जिसमें सॉफ्टवेयर एप्लिकेशन बनाने के लिए इंटरफेस, फ़ंक्शंस, क्लास (कंप्यूटर साइंस), | एक एपीआई एक [[ पुस्तकालय (कम्प्यूटिंग) | लाइब्रेरी (कम्प्यूटिंग)]] है जिसमें सॉफ्टवेयर एप्लिकेशन बनाने के लिए इंटरफेस, फ़ंक्शंस, क्लास (कंप्यूटर साइंस), संरचनाओं, गणना आदि सम्मिलित हैं। इसका उपयोग डेवलपर्स द्वारा सॉफ़्टवेयर के साथ सहभागिता करने और उसका विस्तार करने के लिए किया जाता है। किसी दिए गए [[प्रोग्रामिंग भाषा]] या प्रणाली के लिए एक एपीआई में प्रणाली-परिभाषित और उपयोगकर्ता-परिभाषित निर्माण सम्मिलित हो सकते हैं। जैसे-जैसे इन निर्माणों की संख्या और जटिलता बढ़ती है, डेवलपर्स के लिए सभी कार्यों और परिभाषित मापदंडों को याद रखना बहुत कठिन हो जाता है। इसलिए, एपीआई लेखक [[कंप्यूटर सॉफ्टवेयर]] अनुप्रयोगों के निर्माण में महत्वपूर्ण भूमिका निभाते हैं। | ||
तकनीकी विषय वस्तु के कारण, एपीआई लेखकों को एपीआई दस्तावेजों की आवश्यकता वाली जानकारी निकालने के लिए एप्लिकेशन स्रोत कोड को पर्याप्त रूप से समझना चाहिए। एपीआई लेखक | तकनीकी विषय वस्तु के कारण, एपीआई लेखकों को एपीआई दस्तावेजों की आवश्यकता वाली जानकारी निकालने के लिए एप्लिकेशन स्रोत कोड को पर्याप्त रूप से समझना चाहिए। एपीआई लेखक प्रायः टूलिंग का उपयोग करते हैं जो प्रोग्रामर द्वारा स्रोत कोड में संरचित तरीके से रखे गए सॉफ़्टवेयर दस्तावेज़ों को निकालता है, टिप्पणियों और प्रोग्रामिंग के बीच संबंधों को संरक्षित करता है जो वे दस्तावेज़ बनाते हैं। | ||
एपीआई लेखकों को सॉफ्टवेयर उत्पाद को समझना चाहिए और नए सॉफ्टवेयर रिलीज के हिस्से के रूप में नई सुविधाओं या परिवर्तनों को दस्तावेज करना चाहिए। सॉफ़्टवेयर रिलीज़ का | एपीआई लेखकों को सॉफ्टवेयर उत्पाद को समझना चाहिए और नए सॉफ्टवेयर रिलीज के हिस्से के रूप में नई सुविधाओं या परिवर्तनों को दस्तावेज करना चाहिए। सॉफ़्टवेयर रिलीज़ का नियोजन संगठन से संगठन में भिन्न होता है। एपीआई लेखकों को सॉफ़्टवेयर जीवन चक्र को अच्छी तरह से समझने और स्वयं को [[सिस्टम विकास जीवन चक्र|प्रणाली विकास जीवन चक्र]] (एसडीएलसी) में एकीकृत करने की आवश्यकता है। | ||
[[संयुक्त राज्य अमेरिका]] में एपीआई लेखक | [[संयुक्त राज्य अमेरिका]] में एपीआई लेखक सामान्यतः [[व्याकरण]] और [[विराम चिह्न]] के [[स्टाइल का शिकागो मैनुअल|स्टाइल का शिकागो नियमावली]] का पालन करते हैं।{{Citation needed|date=August 2020}} | ||
== योग्यता == | == योग्यता == | ||
एपीआई लेखकों के पास | एपीआई लेखकों के पास सामान्यतः प्रोग्रामिंग और भाषा कौशल का मिश्रण होता है; कई एपीआई लेखकों के पास [[कंप्यूटर प्रोग्रामिंग]] या [[तकनीकी लेखन]] की पृष्ठभूमि है। | ||
*कंप्यूटर प्रोग्रामिंग पृष्ठभूमि ([[सी (प्रोग्रामिंग भाषा)]], [[ सी ++ ]], [[जावा (प्रोग्रामिंग भाषा)]], [[पीएचपी]], या अन्य प्रोग्रामिंग भाषाओं का ज्ञान) | *कंप्यूटर प्रोग्रामिंग पृष्ठभूमि ([[सी (प्रोग्रामिंग भाषा)]], [[ सी ++ ]], [[जावा (प्रोग्रामिंग भाषा)]], [[पीएचपी]], या अन्य प्रोग्रामिंग भाषाओं का ज्ञान) | ||
*[[Doxygen]], [[Javadoc]], | *[[Doxygen|डॉक्सिजन]], [[Javadoc|जावाडोक]], ओपनएपीआई विशिष्टता, या [[डार्विन सूचना टंकण वास्तुकला]] जैसे स्वरूपण मानकों का ज्ञान | ||
*[[फ्रेम मेकर]] जैसे संपादकों और | *[[फ्रेम मेकर]] जैसे संपादकों और उपकरण का ज्ञान | ||
* डेवलपर्स के साथ बातचीत करने के लिए उत्कृष्ट संचार और लेखन कौशल | * डेवलपर्स के साथ बातचीत करने के लिए उत्कृष्ट संचार और लेखन कौशल | ||
विशेषज्ञ एपीआई/[[ सॉफ़्टवेयर विकास किट ]] (एसडीके) लेखक आसानी से कंप्यूटर प्रोग्रामिंग लेखक बन सकते हैं। | विशेषज्ञ एपीआई/[[ सॉफ़्टवेयर विकास किट | सॉफ़्टवेयर विकास उपकरण]] (एसडीके) लेखक आसानी से कंप्यूटर प्रोग्रामिंग लेखक बन सकते हैं। | ||
== एपीआई लेखन प्रक्रिया == | == एपीआई लेखन प्रक्रिया == | ||
एपीआई लेखन प्रक्रिया | एपीआई लेखन प्रक्रिया सामान्यतः स्रोत कोड, योजना, लेखन और समीक्षा के विश्लेषण और समझने के बीच विभाजित होती है। प्रायः ऐसा होता है कि विश्लेषणात्मक, नियोजन और लेखन चरण एक सख्त रैखिक फैशन में नहीं होते हैं। | ||
लेखन और मूल्यांकन मानदंड संगठनों के बीच भिन्न होते हैं। कुछ सबसे प्रभावी एपीआई दस्तावेज उन लोगों द्वारा लिखे गए हैं जो किसी विशेष एप्लिकेशन के कामकाज को समझने में पर्याप्त रूप से सक्षम हैं, ताकि वे सॉफ्टवेयर को उपयोगकर्ताओं या विभिन्न घटक निर्माणों को कार्यक्रम के समग्र उद्देश्य से संबंधित कर सकें। एपीआई लेखक [[उपयोगकर्ता (कंप्यूटिंग)]]|अंतिम-उपयोगकर्ता उत्पाद प्रलेखन को संलेखित करने के लिए भी | लेखन और मूल्यांकन मानदंड संगठनों के बीच भिन्न होते हैं। कुछ सबसे प्रभावी एपीआई दस्तावेज उन लोगों द्वारा लिखे गए हैं जो किसी विशेष एप्लिकेशन के कामकाज को समझने में पर्याप्त रूप से सक्षम हैं, ताकि वे सॉफ्टवेयर को उपयोगकर्ताओं या विभिन्न घटक निर्माणों को कार्यक्रम के समग्र उद्देश्य से संबंधित कर सकें। एपीआई लेखक [[उपयोगकर्ता (कंप्यूटिंग)]]|अंतिम-उपयोगकर्ता उत्पाद प्रलेखन को संलेखित करने के लिए भी उत्तरदायी हो सकते हैं। | ||
जबकि संदर्भ दस्तावेज़ पूर्णता सुनिश्चित करने के लिए स्वत: उत्पन्न हो सकते हैं, दस्तावेज़ीकरण जो डेवलपर्स को आरंभ करने में | जबकि संदर्भ दस्तावेज़ पूर्णता सुनिश्चित करने के लिए स्वत: उत्पन्न हो सकते हैं, दस्तावेज़ीकरण जो डेवलपर्स को आरंभ करने में सहायता करता है, एक कुशल एपीआई लेखक द्वारा लिखा जाना चाहिए और विषय वस्तु विशेषज्ञों द्वारा समीक्षा की जानी चाहिए।<ref>{{cite book |last1=Jacobson |first1=Daniel |title=APIs : a strategy guide |date=2011 |publisher=O'Reilly |isbn=9781449321642 |page=101}}</ref> इससे यह सुनिश्चित करने में सहायता मिलती है कि डेवलपर्स प्रमुख अवधारणाओं को समझते हैं और जल्दी से प्रारंभ कर सकते हैं। | ||
== उत्पाद == | == उत्पाद == | ||
एपीआई लेखक दस्तावेज तैयार करते हैं जिनमें | एपीआई लेखक दस्तावेज तैयार करते हैं जिनमें सम्मिलित हैं: | ||
* एपीआई संदर्भ | * एपीआई संदर्भ नियमावली | ||
* प्रोग्रामर | * प्रोग्रामर नियमावली | ||
* डेवलपर | * डेवलपर नियमावली | ||
* प्रशासन | * प्रशासन नियमावली | ||
* स्थापना | * स्थापना नियमावली | ||
*कार्यान्वयन और एकीकरण | *कार्यान्वयन और एकीकरण नियमावली | ||
== यह भी देखें == | == यह भी देखें == | ||
Revision as of 20:11, 3 March 2023
एक एपीआई लेखक एक तकनीकी लेखक है जो एक अप्लिकेशन प्रोग्रामिंग अंतरफलक (एपीआई) का वर्णन करने वाले दस्तावेज़ लिखता है। प्राथमिक दर्शकों में प्रोग्रामर, डेवलपर्स, आर्उपकरणेक्ट प्रणाली और डिजाइनर प्रणाली सम्मिलित हैं।
सिंहावलोकन
एक एपीआई एक लाइब्रेरी (कम्प्यूटिंग) है जिसमें सॉफ्टवेयर एप्लिकेशन बनाने के लिए इंटरफेस, फ़ंक्शंस, क्लास (कंप्यूटर साइंस), संरचनाओं, गणना आदि सम्मिलित हैं। इसका उपयोग डेवलपर्स द्वारा सॉफ़्टवेयर के साथ सहभागिता करने और उसका विस्तार करने के लिए किया जाता है। किसी दिए गए प्रोग्रामिंग भाषा या प्रणाली के लिए एक एपीआई में प्रणाली-परिभाषित और उपयोगकर्ता-परिभाषित निर्माण सम्मिलित हो सकते हैं। जैसे-जैसे इन निर्माणों की संख्या और जटिलता बढ़ती है, डेवलपर्स के लिए सभी कार्यों और परिभाषित मापदंडों को याद रखना बहुत कठिन हो जाता है। इसलिए, एपीआई लेखक कंप्यूटर सॉफ्टवेयर अनुप्रयोगों के निर्माण में महत्वपूर्ण भूमिका निभाते हैं।
तकनीकी विषय वस्तु के कारण, एपीआई लेखकों को एपीआई दस्तावेजों की आवश्यकता वाली जानकारी निकालने के लिए एप्लिकेशन स्रोत कोड को पर्याप्त रूप से समझना चाहिए। एपीआई लेखक प्रायः टूलिंग का उपयोग करते हैं जो प्रोग्रामर द्वारा स्रोत कोड में संरचित तरीके से रखे गए सॉफ़्टवेयर दस्तावेज़ों को निकालता है, टिप्पणियों और प्रोग्रामिंग के बीच संबंधों को संरक्षित करता है जो वे दस्तावेज़ बनाते हैं।
एपीआई लेखकों को सॉफ्टवेयर उत्पाद को समझना चाहिए और नए सॉफ्टवेयर रिलीज के हिस्से के रूप में नई सुविधाओं या परिवर्तनों को दस्तावेज करना चाहिए। सॉफ़्टवेयर रिलीज़ का नियोजन संगठन से संगठन में भिन्न होता है। एपीआई लेखकों को सॉफ़्टवेयर जीवन चक्र को अच्छी तरह से समझने और स्वयं को प्रणाली विकास जीवन चक्र (एसडीएलसी) में एकीकृत करने की आवश्यकता है।
संयुक्त राज्य अमेरिका में एपीआई लेखक सामान्यतः व्याकरण और विराम चिह्न के स्टाइल का शिकागो नियमावली का पालन करते हैं।[citation needed]
योग्यता
एपीआई लेखकों के पास सामान्यतः प्रोग्रामिंग और भाषा कौशल का मिश्रण होता है; कई एपीआई लेखकों के पास कंप्यूटर प्रोग्रामिंग या तकनीकी लेखन की पृष्ठभूमि है।
- कंप्यूटर प्रोग्रामिंग पृष्ठभूमि (सी (प्रोग्रामिंग भाषा), सी ++ , जावा (प्रोग्रामिंग भाषा), पीएचपी, या अन्य प्रोग्रामिंग भाषाओं का ज्ञान)
- डॉक्सिजन, जावाडोक, ओपनएपीआई विशिष्टता, या डार्विन सूचना टंकण वास्तुकला जैसे स्वरूपण मानकों का ज्ञान
- फ्रेम मेकर जैसे संपादकों और उपकरण का ज्ञान
- डेवलपर्स के साथ बातचीत करने के लिए उत्कृष्ट संचार और लेखन कौशल
विशेषज्ञ एपीआई/ सॉफ़्टवेयर विकास उपकरण (एसडीके) लेखक आसानी से कंप्यूटर प्रोग्रामिंग लेखक बन सकते हैं।
एपीआई लेखन प्रक्रिया
एपीआई लेखन प्रक्रिया सामान्यतः स्रोत कोड, योजना, लेखन और समीक्षा के विश्लेषण और समझने के बीच विभाजित होती है। प्रायः ऐसा होता है कि विश्लेषणात्मक, नियोजन और लेखन चरण एक सख्त रैखिक फैशन में नहीं होते हैं।
लेखन और मूल्यांकन मानदंड संगठनों के बीच भिन्न होते हैं। कुछ सबसे प्रभावी एपीआई दस्तावेज उन लोगों द्वारा लिखे गए हैं जो किसी विशेष एप्लिकेशन के कामकाज को समझने में पर्याप्त रूप से सक्षम हैं, ताकि वे सॉफ्टवेयर को उपयोगकर्ताओं या विभिन्न घटक निर्माणों को कार्यक्रम के समग्र उद्देश्य से संबंधित कर सकें। एपीआई लेखक उपयोगकर्ता (कंप्यूटिंग)|अंतिम-उपयोगकर्ता उत्पाद प्रलेखन को संलेखित करने के लिए भी उत्तरदायी हो सकते हैं।
जबकि संदर्भ दस्तावेज़ पूर्णता सुनिश्चित करने के लिए स्वत: उत्पन्न हो सकते हैं, दस्तावेज़ीकरण जो डेवलपर्स को आरंभ करने में सहायता करता है, एक कुशल एपीआई लेखक द्वारा लिखा जाना चाहिए और विषय वस्तु विशेषज्ञों द्वारा समीक्षा की जानी चाहिए।[1] इससे यह सुनिश्चित करने में सहायता मिलती है कि डेवलपर्स प्रमुख अवधारणाओं को समझते हैं और जल्दी से प्रारंभ कर सकते हैं।
उत्पाद
एपीआई लेखक दस्तावेज तैयार करते हैं जिनमें सम्मिलित हैं:
- एपीआई संदर्भ नियमावली
- प्रोग्रामर नियमावली
- डेवलपर नियमावली
- प्रशासन नियमावली
- स्थापना नियमावली
- कार्यान्वयन और एकीकरण नियमावली
यह भी देखें
संदर्भ
- ↑ Jacobson, Daniel (2011). APIs : a strategy guide. O'Reilly. p. 101. ISBN 9781449321642.
