एपीआई दस्तावेज़ीकरण लेखक
प्रमाणीकरण, पैरामीटर, पेलोड, प्रतिक्रियाओं, त्रुटियों, उदाहरणों और कार्यान्वयन सावधानियों के साथ एंडपॉइंट व्यवहार को स्पष्ट एपीआई दस्तावेज़ में बदलें।
प्रॉम्प्ट
**एपीआई दस्तावेज़ीकरण लेखक** को पूरा करने के लिए नीचे दी गई सामग्री का उपयोग करें। उपयोगी परिणाम सामान्य सलाह नहीं है; यह "एपीआई डॉक्यूमेंटेशन राइटर प्रॉम्प्ट" क्वेरी के लिए निर्णय-तैयार परिणाम है। ## विवरण जो मायने रखते हैं - एपीआई दस्तावेज़ीकरण लेखक - [LANGUAGE] - एपीआई दस्तावेज़ीकरण लेखक के लिए, प्रासंगिक भाषा प्रदान करें। यदि अनुपलब्ध है, तो [LANGUAGE] 'अज्ञात' लेबल करें; इसका अनुमान कभी मत लगाना. - [EXPECTED_BEHAVIOR] - एपीआई दस्तावेज़ीकरण लेखक के लिए, प्रासंगिक अपेक्षित व्यवहार की आपूर्ति करें। यदि अनुपलब्ध है, तो [EXPECTED_BEHAVIOR] 'अज्ञात' लेबल करें; इसका अनुमान कभी मत लगाना. - [REPRODUCTION_STEPS] - एपीआई दस्तावेज़ीकरण लेखक के लिए, प्रासंगिक पुनरुत्पादन चरणों की आपूर्ति करें। यदि अनुपलब्ध है, तो [REPRODUCTION_STEPS] 'अज्ञात' लेबल करें; इसका अनुमान कभी मत लगाना. - [CODE] - एपीआई दस्तावेज़ीकरण लेखक के लिए, प्रासंगिक कोड प्रदान करें। यदि अनुपलब्ध है, तो [CODE] 'अज्ञात' लेबल करें; इसका अनुमान कभी मत लगाना. - [RUNTIME] - एपीआई दस्तावेज़ीकरण लेखक के लिए, प्रासंगिक रनटाइम प्रदान करें। यदि अनुपलब्ध है, तो [RUNTIME] 'अज्ञात' लेबल करें; इसका अनुमान कभी मत लगाना. - [ERROR_OUTPUT] - एपीआई दस्तावेज़ीकरण लेखक के लिए, प्रासंगिक त्रुटि आउटपुट की आपूर्ति करें। यदि अनुपलब्ध है, तो [ERROR_OUTPUT] `अज्ञात` लेबल करें; इसका अनुमान कभी मत लगाना. - [REQUIRED_POINTS] - एपीआई दस्तावेज़ीकरण लेखक के लिए, प्रासंगिक आवश्यक बिंदु प्रदान करें। यदि अनुपलब्ध है, तो [REQUIRED_POINTS] `अज्ञात` लेबल करें; इसका अनुमान कभी मत लगाना. - [REPOSITORY_CONTEXT] - एपीआई दस्तावेज़ीकरण लेखक के लिए, प्रासंगिक रिपॉजिटरी संदर्भ प्रदान करें। यदि अनुपलब्ध है, तो [REPOSITORY_CONTEXT] 'अज्ञात' लेबल करें; इसका अनुमान कभी मत लगाना. ## इस कार्य के लिए विधि - एपीआई दस्तावेज़ीकरण लेखक 1. दर्शकों, उद्देश्य, तथ्य, आवाज और वांछित कार्रवाई को लॉक करने के बाद ही ड्राफ्ट करें। 2. महत्वपूर्ण विकल्पों के लिए एक प्रकाशन योग्य संस्करण और एक संक्षिप्त तर्क प्रदान करें। 3. कुछ भी संपादित करने से पहले प्रासंगिक कोड पथ के माध्यम से अवलोकन योग्य व्यवहार का पता लगाएं। 4. सबसे छोटा बचाव योग्य पैच, प्रतिगमन परीक्षण और सटीक सत्यापन चरण प्रदान करें। 5. पुष्ट व्यवहार को परिकल्पनाओं से अलग करें। 6. किनारे के मामलों, सुरक्षा और पश्चगामी अनुकूलता पर विचार करें। 7. वैकल्पिक रिफैक्टरिंग से पहले न्यूनतम परिवर्तन दिखाएं। 8. उन परीक्षणों को शामिल करें जो सुधार से पहले विफल हो जाएंगे। 9. एपीआई दस्तावेज़ीकरण लेखक के लिए सीमा: एपीआई, पैकेज, फ़ाइलें, रनटाइम व्यवहार, कमांड आउटपुट, या सफल परीक्षण परिणामों का आविष्कार न करें। ## उपयोगी आउटपुट - एपीआई दस्तावेज़ीकरण लेखक - **एपीआई डॉक्यूमेंटेशन राइटर के लिए तकनीकी खोज** - एपीआई डॉक्यूमेंटेशन राइटर के लिए सामग्री इनपुट, प्रत्येक एपीआई डॉक्यूमेंटेशन राइटर प्रॉम्प्ट से जुड़ा हुआ है। - **एपीआई डॉक्यूमेंटेशन राइटर के लिए साक्ष्य या पुनरुत्पादन** - उपयोग के लिए तैयार एपीआई डॉक्यूमेंटेशन राइटर, एपीआई डॉक्यूमेंटेशन राइटर प्रॉम्प्ट के लिए स्वरूपित। - **एपीआई डॉक्यूमेंटेशन राइटर के लिए न्यूनतम परिवर्तन** - एपीआई डॉक्यूमेंटेशन राइटर कमजोर बिंदु, अज्ञात, और एपीआई डॉक्यूमेंटेशन राइटर प्रॉम्प्ट सीमाएँ। - **एपीआई डॉक्यूमेंटेशन राइटर के लिए टेस्ट कवरेज** - एपीआई डॉक्यूमेंटेशन राइटर प्रॉम्प्ट → उपयोग से पहले एपीआई डॉक्यूमेंटेशन राइटर को सत्यापित करें। - **एपीआई दस्तावेज़ीकरण लेखक के लिए सत्यापन आदेश** - एपीआई दस्तावेज़ीकरण लेखक प्रॉम्प्ट के साक्ष्य → एपीआई दस्तावेज़ीकरण लेखक; प्रस्तावना हटाएँ. ## सत्यापन - एपीआई दस्तावेज़ीकरण लेखक मूल अनुरोध के विरुद्ध अंतिम एपीआई दस्तावेज़ीकरण लेखक का ऑडिट करें। यदि कोई आवश्यक इनपुट अनुपस्थित है, तो सटीक रूप से बताएं कि यह परिणाम को कैसे सीमित करता है।
इस प्रॉम्प्ट का उपयोग कैसे करें
केवल आपकी स्थिति से संबंधित ब्रैकेट वाले फ़ील्ड बदलें। अज्ञात जानकारी को अज्ञात के रूप में चिह्नित रखें, पूर्ण प्रॉम्प्ट को एक सक्षम AI सहायक में पेस्ट करें, और इसका उपयोग करने से पहले परिणाम की समीक्षा करें।
सर्वश्रेष्ठ AI मॉडल
ChatGPT वह मॉडल है जिसे मूल स्रोत पेज ने इस प्रॉम्प्ट के लिए पहचाना है।
बेहतर परिणामों के लिए सुझाव
एपीआई दस्तावेज़ीकरण लेखक प्रॉम्प्ट के लिए पहले विषय और रचना को स्थिर रखें, फिर प्रकाश, रंग या पृष्ठभूमि में एक समय में केवल एक बदलाव करें।
अक्सर पूछे जाने वाले प्रश्न
यह एपीआई दस्तावेज़ीकरण लेखक प्रॉम्प्ट क्या तय करता है?
यह दृश्य के विषय, रचना, शैली और बनाए रखने योग्य मुख्य विवरण स्पष्ट करता है।
इसे कैसे उपयोग करें?
पूरा प्रॉम्प्ट इमेज टूल में चलाएँ, फिर हर बार प्रकाश या रचना में केवल एक नियंत्रित बदलाव करें।

