AI प्रॉम्प्ट इंजीनियरिंग · पाठ

तकनीकी दस्तावेज़ीकरण के प्रॉम्प्ट

सटीक तकनीकी शैली में README फ़ाइलें, API दस्तावेज़ और कैसे-करे मार्गदर्शिकाएँ।

पाठ 3, कुल 4 में से13 चरण

तकनीकी दस्तावेज़ीकरण के प्रॉम्प्ट, CoddyKit पर AI प्रॉम्प्ट इंजीनियरिंग का एक निःशुल्क पाठ है। यह 4 में से 3वाँ पाठ है। इस अध्ययन पथ के 3 तक कोई भी पाठ पूरा पढ़ना निःशुल्क है — इसके बाद CoddyKit PRO हर पाठ अनलॉक करता है, साथ ही अंतर्निर्मित कोड संपादक और चौबीसों घंटे एआई शिक्षक के साथ व्यावहारिक अभ्यास भी उपलब्ध कराता है। यह AI प्रॉम्प्ट इंजीनियरिंग सीखने के मार्ग का हिस्सा है और आपकी प्रगति वेब तथा CoddyKit ऐप पर सिंक होती रहती है। AI प्रॉम्प्ट इंजीनियरिंग पाठ्यक्रम में कुल 4 पाठ शामिल हैं।

तकनीकी दस्तावेज़ीकरण एक लेखन-विधा है

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

प्रभावी तकनीकी दस्तावेज़ीकरण प्रॉम्प्ट इस विधा को स्पष्ट रूप से शामिल करते हैं — दस्तावेज़ का प्रकार, पाठक के माने गए ज्ञान का स्तर, उस दस्तावेज़ प्रकार की मानक संरचना और भाषा-शैली की परंपरा (आमतौर पर कैसे-करें मार्गदर्शिकाओं में द्वितीय पुरुष और संदर्भ दस्तावेज़ों में तृतीय पुरुष)।

README फ़ाइल के प्रॉम्प्ट

README किसी परियोजना का प्रवेश-बिंदु है। इसकी मानक संरचना अच्छी तरह स्थापित है। प्रभावी README प्रॉम्प्ट में हर अनुभाग निर्दिष्ट किया जाता है:

परियोजना का नाम और एक-पंक्ति विवरण
यह क्या करता है: उद्देश्य के 2–3 वाक्य
पूर्वापेक्षाएँ: क्या-क्या स्थापित होना चाहिए
स्थापना: आदेशों के साथ क्रमांकित चरण
त्वरित शुरुआत: न्यूनतम कार्यशील उदाहरण
विन्यास: पर्यावरण चर और विकल्प
योगदान: पुल अनुरोध भेजने का तरीका
लाइसेंस

प्रॉम्प्ट में सभी अनुभागों के नाम देने से पूरा README तैयार होता है। स्पष्ट निर्देश न होने पर छूटे हुए अनुभाग शामिल नहीं किए जाएँगे।

कोड में README प्रॉम्प्ट

परियोजना का मेटाडेटा स्वीकार करने वाला संरचित README जनरेटर:

import openai

client = openai.OpenAI(api_key='sk-...')

def generate_readme(project_name, description, language, dependencies,
                    install_steps, quick_start_example, config_vars, license_type):

    prompt = f'''Write a README.md for the following project.

Project name: {project_name}
Description: {description}
Language/stack: {language}
Dependencies: {dependencies}
Installation steps: {install_steps}
Quick start example: {quick_start_example}
Key configuration variables: {config_vars}
License: {license_type}

Structure the README with these sections in order:
1. Project title and badge line (GitHub stars, license)
2. One-sentence description
3. Features (3-5 bullet points)
4. Prerequisites
5. Installation (numbered steps with code blocks)
6. Quick Start (minimal working example in a code block)
7. Configuration (table: Variable | Description | Default)
8. Contributing (2-3 sentences)
9. License

Voice: second person imperative for steps ("Run...", "Install...").
Code blocks: use correct language identifiers.
Do not add placeholder content — only include sections where I provided information.'''

    response = client.chat.completions.create(
        model='gpt-4o-mini',
        messages=[{'role': 'user', 'content': prompt}]
    )
    return response.choices[0].message.content

एपीआई दस्तावेज़ीकरण के प्रॉम्प्ट

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

"किसी REST एंडपॉइंट के लिए एपीआई दस्तावेज़ीकरण लिखिए। इनमें शामिल कीजिए: विधि (POST), पथ (/api/v1/users), विवरण, पैरामीटर-सारणी (नाम, प्रकार, आवश्यक, विवरण), अनुरोध के मुख्य भाग का JSON उदाहरण, सफल उत्तर (200) का JSON उदाहरण, और त्रुटि उत्तर (400, 401, 422) के JSON उदाहरण। भाषा-शैली: तृतीय पुरुष, वर्तमान काल। पैरामीटर के लिए मार्कडाउन सारणियों का उपयोग कीजिए।"

हर संरचनात्मक तत्व का स्पष्ट रूप से नाम लिया जाना चाहिए — मॉडल आपके दस्तावेज़ीकरण मानक का अनुमान नहीं लगाएगा।

कैसे-करें मार्गदर्शिकाओं के निर्देश

कैसे-करें मार्गदर्शिकाएँ प्रक्रियात्मक होती हैं: वे क्रमांकित चरणों के माध्यम से पाठक को अवस्था A (समस्या) से अवस्था B (समाधान) तक ले जाती हैं। कैसे-करें मार्गदर्शिकाओं के लिए निर्देश के तत्व:

पूर्वापेक्षाएँ: शुरू करने से पहले क्या सही होना चाहिए
परिणाम: पाठक ने क्या हासिल कर लिया होगा
चरण: क्रमांकित हों और प्रत्येक में केवल एक कार्य हो — एक चरण में कई कार्य नहीं
कोड उदाहरण: जहाँ प्रासंगिक हो, प्रत्येक चरण के लिए एक, जिसमें भाषा निर्दिष्ट हो
सत्यापन: पाठक कैसे जान सकता है कि प्रत्येक चरण सफल हुआ
समस्या-निवारण: दो या तीन सबसे कठिन चरणों में आने वाली सामान्य विफलताओं के तरीके

दस्तावेज़ीकरण के निर्देशों में तकनीकी सटीकता

अधिकांश अन्य सामग्री प्रकारों की तुलना में तकनीकी दस्तावेज़ीकरण में सटीकता की आवश्यकता अधिक होती है। दस्तावेज़ीकरण के निर्देशों में सटीकता सुधारने की दो तकनीकें:

वास्तविक कोड उपलब्ध कराएँ: वास्तविक फ़ंक्शन हस्ताक्षर, विन्यास विकल्प या एपीआई विनिर्देशन चिपकाएँ। इससे मॉडल विवरण गढ़ने के बजाय वास्तव में मौजूद चीज़ों का दस्तावेज़ बनाता है।

सत्यापन का एक चरण माँगें: "प्रत्येक चरण लिखने के बाद, उपयोगकर्ता के परिवेश या प्रणाली के व्यवहार के बारे में बनाई गई किसी भी धारणा को नोट करें। प्रकाशन से पहले मुझे जिन बातों का सत्यापन करना चाहिए, उन्हें चिह्नित करें।"

तकनीकी समीक्षा के बिना एआई द्वारा निर्मित दस्तावेज़ीकरण का कभी उपयोग न करें — मॉडल पूरे विश्वास के साथ उन चीज़ों का दस्तावेज़ बना सकता है जो मौजूद ही नहीं हैं या गलत हैं।

दस्तावेज़ों में कोड उदाहरणों की गुणवत्ता

कोड उदाहरण तकनीकी दस्तावेज़ीकरण का सबसे महत्वपूर्ण तत्व होते हैं। उनके लिए स्पष्ट निर्देश दें:

"प्रत्येक प्रमुख अवधारणा के लिए एक कार्यशील कोड उदाहरण शामिल करें। उदाहरण स्व-निहित होने चाहिए — पाठक को उन्हें कॉपी करके चला पाने में सक्षम होना चाहिए।"
"सही उपयोग और एक सामान्य गलती, दोनों दिखाएँ तथा टिप्पणी में समझाएँ कि गलती क्यों विफल होती है।"
"कोड उदाहरणों में यथार्थपरक चर-नाम और डेटा होने चाहिए, 'फलाँ', 'फलाँ', 'परीक्षण' नहीं।"
"भाषा: पाइथन 3.11। प्रकार-संकेतों का उपयोग करें। नेटवर्क अनुरोध के लिए त्रुटि-प्रबंधन शामिल करें।"

कोड उदाहरणों के बारे में स्पष्ट निर्देश न होने पर मॉडल अधूरे, छद्म-कोड वाले अंश बना सकता है जो वास्तव में चलते ही नहीं हैं।

दस्तावेज़ीकरण की भाषा और शैली

तकनीकी दस्तावेज़ीकरण की एक विशिष्ट भाषा होती है, जो अन्य प्रकार के लेखन से अलग होती है:

प्रक्रियाओं के लिए द्वितीय पुरुष आज्ञार्थक शैली: "सेटिंग्स खोलें। एपीआई टैब चुनें। अपनी कुंजी दर्ज करें।"
संदर्भ दस्तावेज़ों के लिए तृतीय पुरुष: "प्रमाणित() विधि 24 घंटे तक मान्य वाहक टोकन लौटाती है।"
वर्तमान काल: "फ़ंक्शन लौटाता है...", न कि "फ़ंक्शन लौटाएगा..."
कोई अनिश्चित भाषा नहीं: "यह आदेश चलाएँ", न कि "आप इस आदेश को चलाने पर विचार कर सकते हैं"
सुसंगत शब्दावली: पूरे दस्तावेज़ में एक ही अवधारणा के लिए एक ही शब्द का उपयोग करें — समानार्थी शब्दों का नहीं

परिवर्तन-लॉग और रिलीज़ टिप्पणियों के निर्देश

परिवर्तन-लॉग और रिलीज़ टिप्पणियों का एक पारंपरिक प्रारूप होता है, जिसे निर्देशों में शामिल किया जाना चाहिए:

"संस्करण 2.3.0 के लिए रिलीज़ टिप्पणियाँ लिखें। प्रारूप: संस्करण शीर्षक, रिलीज़ की तारीख, फिर तीन अनुभाग: 'जोड़ा गया' (नई सुविधाएँ), 'बदला गया' (मौजूदा सुविधाओं में संशोधन), 'ठीक किया गया' (त्रुटि-सुधार)। प्रत्येक मद: एक पंक्ति, कर्तृवाच्य में, क्रिया से शुरू हो। लक्षित पाठक: इस पुस्तकालय को एकीकृत करने वाले विकासकर्ता। भाषा-शैली: सटीक और तटस्थ — विपणन भाषा नहीं। ये वास्तविक बदलाव हैं: [वास्तविक बदलावों की सूची]।"

वास्तविक बदलावों को इनपुट डेटा के रूप में उपलब्ध कराने से सटीकता सुनिश्चित होती है। इनके बिना मॉडल विश्वसनीय लगने वाली, लेकिन काल्पनिक रिलीज़ टिप्पणियाँ गढ़ देगा।

दस्तावेज़ीकरण की पूर्णता जाँच

तकनीकी दस्तावेज़ीकरण तैयार करने के बाद, पूर्णता-जाँच का निर्देश चलाएँ:

import openai

client = openai.OpenAI(api_key='sk-...')

def check_documentation_completeness(doc_text, doc_type='how-to guide'):
    checklist = {
        'how-to guide': [
            'Prerequisites stated?',
            'Expected outcome stated?',
            'Each step is a single action?',
            'Code examples included where relevant?',
            'Validation step for each major action?',
            'Common errors addressed?'
        ],
        'readme': [
            'One-line description present?',
            'Installation steps numbered with commands?',
            'Quick start example included?',
            'Configuration variables documented?',
            'License specified?'
        ]
    }

    items = checklist.get(doc_type, [])
    check_prompt = f'Review this {doc_type} and answer each question (Yes/No + brief note):\n'
    for item in items:
        check_prompt += f'- {item}\n'
    check_prompt += f'\nDocument:\n{doc_text[:2000]}'

    response = client.chat.completions.create(
        model='gpt-4o-mini',
        messages=[{'role': 'user', 'content': check_prompt}]
    )
    return response.choices[0].message.content

मिश्रित पाठकों के लिए पारिभाषिक शब्दों का अनुवाद

तकनीकी दस्तावेज़ीकरण को अक्सर तकनीकी और गैर-तकनीकी, दोनों प्रकार के पाठकों की आवश्यकताएँ पूरी करनी होती हैं। निर्देश का एक व्यावहारिक प्रारूप:

"इस दस्तावेज़ीकरण को दो स्तरों में लिखें। पहला स्तर: 3 वाक्यों में गैर-तकनीकी सारांश (यह क्या करता है, यह क्यों महत्वपूर्ण है, इसका उपयोग कब करना चाहिए)। दूसरा स्तर: पूर्ण तकनीकी विनिर्देशन। दोनों स्तरों के बीच एक स्पष्ट दृश्य विभाजक रखें। इससे गैर-तकनीकी प्रबंधक सारांश पढ़कर रुक सकते हैं और तकनीकी पाठक सारांश छोड़कर विनिर्देशन पढ़ सकते हैं।"

दो-स्तरीय दस्तावेज़ीकरण, दोनों पाठक-वर्गों की आवश्यकताएँ अपर्याप्त रूप से पूरी करने वाले एक ही संस्करण को लिखने की कोशिश से अधिक उपयोगी होता है।

ज्ञान-जाँच: तकनीकी दस्तावेज़ीकरण के निर्देश

आप 50 एपीआई प्रवेश-बिंदुओं के लिए दस्तावेज़ीकरण तैयार करने के निर्देश लिख रहे हैं। सबसे महत्वपूर्ण गुणवत्ता-आवश्यकता यह है कि दस्तावेज़ीकरण एपीआई के वास्तविक कार्य को सटीक रूप से दर्शाए, न कि मॉडल की कल्पना को। सटीकता सुनिश्चित करने के लिए कौन-सा तरीका सबसे प्रभावी है?

इंटरैक्टिव पाठ में इसका उत्तर दें

पुनरावलोकन: तकनीकी दस्तावेज़ीकरण के निर्देश

तकनीकी दस्तावेज़ीकरण एक विशिष्ट विधा है, जिसमें प्रक्रियाओं के लिए सटीकता, संरचना और द्वितीय-पुरुष आज्ञार्थक शैली आवश्यक होती है। प्रभावी निर्देश दस्तावेज़ का प्रकार, नाम से आवश्यक अनुभाग, कोड उदाहरणों की आवश्यकताएँ (स्व-निहित उदाहरण, यथार्थपरक चर-नाम और भाषा-संस्करण) तथा दस्तावेज़ीकरण की शैली-संबंधी परंपरा स्पष्ट करते हैं।

सटीकता की सबसे महत्वपूर्ण तकनीक यह है: वास्तविक कोड, एपीआई विनिर्देशन या विन्यास डेटा हमेशा इनपुट के रूप में उपलब्ध कराएँ — तकनीकी विवरण गढ़ने के लिए मॉडल से कभी न कहें। एआई द्वारा निर्मित दस्तावेज़ीकरण प्रकाशित करने से पहले हमेशा मानव द्वारा तकनीकी समीक्षा कराएँ।

अंतिम पाठ में आप रचनात्मक और कहानी-कथन संबंधी सामग्री पर निर्देश देने की तकनीकों का उपयोग करेंगे।

शुरुआत निःशुल्क

एआई शिक्षक के साथ AI प्रॉम्प्ट इंजीनियरिंग सीखें — निःशुल्क

अपने ब्राउज़र में वास्तविक कोड लिखें और चलाएँ, चौबीसों घंटे एआई शिक्षक से तुरंत सहायता पाएँ, और वेब या ऐप पर वहीं से शुरू करें जहाँ आपने छोड़ा था।

पाठ्यक्रम: 53
पाठ: 199

निःशुल्क सीखना शुरू करें पूरा पाठ्यक्रम देखें

अक्सर पूछे जाने वाले प्रश्न

क्या “तकनीकी दस्तावेज़ीकरण के प्रॉम्प्ट” पाठ निःशुल्क है?

हाँ — AI प्रॉम्प्ट इंजीनियरिंग अध्ययन पथ के 3 तक कोई भी पाठ, जिसमें “तकनीकी दस्तावेज़ीकरण के प्रॉम्प्ट” भी शामिल है, यहाँ वेब पर पूरा पढ़ना निःशुल्क है। इसके बाद CoddyKit PRO हर पाठ अनलॉक करता है, साथ ही अंतर्निर्मित कोड संपादक और चौबीसों घंटे एआई शिक्षक के साथ इंटरैक्टिव अभ्यास भी उपलब्ध कराता है। AI प्रॉम्प्ट इंजीनियरिंग पाठ्यक्रम में कुल 4 पाठ शामिल हैं।

“तकनीकी दस्तावेज़ीकरण के प्रॉम्प्ट” में मैं क्या सीखूँगा?

सटीक तकनीकी शैली में README फ़ाइलें, API दस्तावेज़ और कैसे-करे मार्गदर्शिकाएँ। आप ब्राउज़र में सीधे चलाए जाने वाले व्यावहारिक कोड के साथ AI प्रॉम्प्ट इंजीनियरिंग का अभ्यास करते हैं, और पाठ पूरा करते समय 24/7 एआई ट्यूटर आपके प्रश्नों के उत्तर देता है।

क्या AI प्रॉम्प्ट इंजीनियरिंग शुरू करने के लिए मुझे किसी अनुभव की आवश्यकता है?

पहले के अनुभव की आवश्यकता नहीं है। CoddyKit पर AI प्रॉम्प्ट इंजीनियरिंग शुरुआती से लेकर उन्नत शिक्षार्थियों तक सभी के लिए व्यवस्थित किया गया है, इसलिए आप यहीं से या शुरुआत से सीखना शुरू कर सकते हैं और अपनी गति से आगे बढ़ सकते हैं। यह 4 में से 3वाँ पाठ है।

“तकनीकी दस्तावेज़ीकरण के प्रॉम्प्ट” पाठ पूरा करने में कितना समय लगता है?

CoddyKit का अधिकांश पाठ लगभग 5–10 मिनट में पूरा हो जाता है। हर पाठ छोटा और संवादात्मक है, इसलिए आप लगातार प्रगति करते हैं और वेब या ऐप पर वहीं से सीखना जारी रख सकते हैं जहाँ आपने छोड़ा था।

क्या मैं इस AI प्रॉम्प्ट इंजीनियरिंग पाठ में कोड लिख और चला सकता हूँ?

हाँ। हर AI प्रॉम्प्ट इंजीनियरिंग पाठ में एक अंतर्निर्मित कोड संपादक शामिल है, जिससे आप सीधे अपने ब्राउज़र में वास्तविक कोड लिख और चला सकते हैं और तुरंत एआई प्रतिक्रिया पा सकते हैं—स्थानीय सेटअप की आवश्यकता नहीं है।

इस पाठ्यक्रम के सभी पाठ

← AI प्रॉम्प्ट इंजीनियरिंग पर वापस जाएँ