GitHub Copilot का उपयोग करके परियोजना दस्तावेज़ीकरण उत्पन्न करें
परियोजना प्रलेखन एक परियोजना के उद्देश्य, लक्ष्यों और आवश्यकताओं का वर्णन करता है। परियोजना प्रलेखन बनाने के लिए, आपको परियोजना संरचना, इसके घटकों और घटकों को एक दूसरे के साथ कैसे इंटरैक्ट करना होगा, यह समझने की आवश्यकता है।
GitHub Copilot का चैट दृश्य प्रोजेक्ट दस्तावेज़ीकरण तैयार करने के लिए एक आदर्श उपकरण है, क्योंकि यह संपूर्ण परियोजना संरचना का विश्लेषण कर सकता है और परियोजना के उच्च-स्तरीय अवलोकन प्रदान कर सकता है। चैट दृश्य का उपयोग विशिष्ट प्रकार के दस्तावेज़ीकरण को उत्पन्न करने के लिए भी किया जा सकता है, जैसे कि README फ़ाइलें, API संदर्भ और अन्य परियोजना-संबंधित दस्तावेज़।
आप प्रोजेक्ट दस्तावेज़ जनरेट करने के लिए चैट व्यू मोड (पूछें, एजेंट या योजना) में से प्रत्येक का उपयोग कर सकते हैं। प्रत्येक मोड की अपनी ताकत और कमजोरियां होती हैं। प्रोजेक्ट विनिर्देश और अन्य बाधाएं प्रभावित करती हैं कि किस मोड का उपयोग किया जाना चाहिए।
महत्त्वपूर्ण
जब आप एजेंट मोड में चैट व्यू का इस्तेमाल करते हैं, तो आपके द्वारा डाला गया हर प्रॉम्प्ट एक प्रीमियम अनुरोध के रूप में गिना जाता है, जिसे मॉडल के गुणक से गुणा किया जाता है. GitHub Copilot आपके कार्य को पूरा करने के लिए कई अनुवर्ती कार्रवाइयां कर सकती हैं, लेकिन ये अनुवर्ती कार्रवाइयां आपके प्रीमियम अनुरोध उपयोग में नहीं गिनी जाती हैं। केवल आपके द्वारा दर्ज किए गए संकेतों को बिल किया जाता है। उपयोग किए गए कुल प्रीमियम अनुरोध इस बात पर निर्भर करते हैं कि आप कितने संकेत दर्ज करते हैं और मॉडल का चयन किया गया है।
परियोजना प्रलेखन आवश्यकताओं को स्थापित करें
दस्तावेज़ीकरण प्रकार और सामग्री आवश्यकताएँ परियोजना, इच्छित उपभोक्ताओं और संगठन द्वारा अपनाए गए मानकों पर निर्भर करती हैं।
उदाहरण के लिए, README.md में निम्न अनुभाग शामिल हो सकते हैं:
- प्रोजेक्ट शीर्षक: आपकी परियोजना का नाम।
- विवरण: परियोजना क्या करती है और यह क्यों मौजूद है इसका एक संक्षिप्त अवलोकन।
- सामग्री की तालिका: वैकल्पिक, लेकिन लंबे समय तक READMEs के लिए सहायक।
- स्थापना: प्रोजेक्ट को स्थापित और सेट करने के तरीके के निर्देश।
- उपयोग: कोड स्निपेट या स्क्रीनशॉट सहित प्रोजेक्ट का उपयोग करने के तरीके के उदाहरण.
- विशेषताएं: प्रमुख विशेषताओं या कार्यक्षमता की एक सूची।
- कॉन्फ़िगरेशन: किसी भी कॉन्फ़िगरेशन विकल्प या पर्यावरण चर पर विवरण।
- योगदान: परियोजना में योगदान के लिए दिशानिर्देश।
- लाइसेंस: वितरित परियोजना द्वारा उपयोग किया जाने वाला कोई भी लाइसेंस।
- क्रेडिट और पावती: योगदानकर्ताओं, पुस्तकालयों या उपयोग किए गए संसाधनों की मान्यता।
- संपर्क: अनुरक्षकों या परियोजना टीम तक कैसे पहुंचें।
- चैंज: परिवर्तनों और अद्यतनों का इतिहास (कभी-कभी एक अलग फ़ाइल से जुड़ा हुआ)।
GitHub Copilot चैट आपको प्रोजेक्ट दस्तावेज़ तैयार करने में मदद कर सकता है जो आपके प्रोजेक्ट और उसके हितधारकों की विशिष्ट आवश्यकताओं को पूरा करता है।
प्रोजेक्ट दस्तावेज़ जनरेट करने के लिए एजेंट से पूछें मोड का उपयोग करें
आस्क एजेंट मोड का उपयोग कार्यक्षेत्र का विश्लेषण करने और फिर दस्तावेज़ीकरण उत्पन्न करने के लिए किया जा सकता है।
आस्क एजेंट मोड का उपयोग करके प्रोजेक्ट दस्तावेज़ जनरेट करने के लिए निम्न प्रक्रिया का उपयोग करें:
दस्तावेज़ीकरण आवश्यकताओं और सहायक संसाधनों की पहचान करें।
अपनी परियोजना के लिए दस्तावेज़ीकरण आवश्यकताओं की पहचान करें। दस्तावेज़ीकरण के प्रकार और आवश्यक दस्तावेज़ अनुभागों की पहचान करें।
दस्तावेज़ीकरण उत्पन्न करने के लिए आवश्यक संसाधनों की पहचान करें। आपका कोड कार्यक्षेत्र एकमात्र आवश्यक संसाधन हो सकता है। हालाँकि, आपको "योगदान", "क्रेडिट" और "संपर्क" जैसे अनुभागों के लिए चैट में संदर्भ जोड़ने की आवश्यकता हो सकती है।
चैट दृश्य खोलें और आस्क एजेंट मोड का उपयोग करके एक नया चैट सत्र शुरू करें।
चैट सत्र में संदर्भ जोड़ें।
- आप चैट सत्र में संदर्भ जोड़ सकते हैं और Visual Studio Code के EXPLORER दृश्य से फ़ाइलों को चैट दृश्य में छोड़ सकते हैं। आप अटैच कॉन्टेक्स्ट बटन (पेपरक्लिप आइकन) का भी उपयोग कर सकते हैं।
- आप उन संसाधनों को शामिल करने के लिए कोड संपादक में बाहरी फ़ाइलें खोल सकते हैं जो कार्यस्थान का हिस्सा नहीं हैं और अधिक संदर्भ प्रदान करने के लिए उनका उपयोग कर सकते हैं. उदाहरण के लिए, आप उन मार्कडाउन फ़ाइलों को खोल सकते हैं जिनमें योगदानकर्ता दिशानिर्देश या संपर्क जानकारी होती है और फिर उन्हें चैट दृश्य संदर्भ में जोड़ने के लिए संदर्भ संलग्न करें बटन का उपयोग कर सकते हैं.
अपनी दस्तावेज़ीकरण आवश्यकताओं की जांच करने वाले संकेतों की एक श्रृंखला दर्ज करें।
आप कार्यक्षेत्र का विश्लेषण करने और एक चैट सत्र इतिहास बनाने के लिए एजेंट से पूछें मोड का उपयोग कर सकते हैं जो आपकी दस्तावेज़ीकरण आवश्यकताओं का समर्थन करता है। अपने लक्ष्यों का वर्णन करने से चैट सत्र के लिए संदर्भ स्थापित करने में मदद मिल सकती है। आपकी आवश्यकताओं को पूरा करने वाले प्रश्न पूछने से GitHub Copilot दस्तावेज़ीकरण तैयार करने के लिए आवश्यक जानकारी की पहचान करने में मदद मिलती है।
आवश्यकतानुसार जोड़े गए संदर्भ को ताज़ा करें।
एक संकेत दर्ज करें जो सुझाए गए प्रोजेक्ट दस्तावेज़ीकरण के लिए पूछता है, जो आपके द्वारा पहले चरण में पहचाने गए आवश्यक अनुभागों को सूचीबद्ध करता है।
उदाहरण के लिए: "
@workspace /explain I need help creating a README file that can be used in the GitHub repository for this workspace. The file should be formatted as markdown. The README file needs to include the following sections: Project Title, Description, Table of Contents, Installation, Usage, Features, Configuration, and License."सुझाए गए प्रोजेक्ट दस्तावेज़ीकरण की समीक्षा करें, और यदि आवश्यक हो तो नए संकेतों का उपयोग करके परिणामों को परिशोधित करें।
सुझाए गए प्रोजेक्ट दस्तावेज़ीकरण को प्रोजेक्ट दस्तावेज़ीकरण फ़ाइल में ले जाएँ।
उदाहरण के लिए, कार्यस्थान के रूट पर एक README.md फ़ाइल बनाएँ, और फ़ाइल में सुझाई गई सामग्री सम्मिलित करें.
आप दस्तावेज़ बनाने के बाद अपने प्रोजेक्ट के विशिष्ट अनुभागों के लिए अद्यतनों का सुझाव देने के लिए एजेंट से पूछें मोड का उपयोग कर सकते हैं, या अद्यतनों में मदद करने के लिए अन्य GitHub Copilot उपकरणों का उपयोग कर सकते हैं।
प्रोजेक्ट दस्तावेज़ीकरण जनरेट करने के लिए योजना मोड का उपयोग करें
परियोजना प्रलेखन तैयार करने से पहले एक विस्तृत कार्यान्वयन योजना बनाने के लिए योजना मोड सबसे अच्छा है। योजना मोड कोडबेस का विश्लेषण करता है, दस्तावेज़ीकरण आवश्यकताओं की पहचान करता है, और चरण-दर-चरण योजना तैयार करता है। एक बार योजना स्वीकृत हो जाने के बाद, आप इसे निष्पादन के लिए एजेंट मोड में सौंप सकते हैं।
योजना मोड का उपयोग करके प्रोजेक्ट दस्तावेज़, जैसे README.md फ़ाइल जनरेट करने के लिए निम्न प्रक्रिया का उपयोग करें:
दस्तावेज़ीकरण आवश्यकताओं और सहायक संसाधनों की पहचान करें।
चैट दृश्य खोलें और योजना मोड का उपयोग करके एक नया चैट सत्र शुरू करें।
एक संकेत दर्ज करें जो आपके दस्तावेज़ीकरण कार्य का वर्णन करता है।
उदाहरण के लिए: "मुझे इस प्रोजेक्ट के लिए एक README फ़ाइल और सहायक दस्तावेज़ बनाने की आवश्यकता है। README में शामिल होना चाहिए: परियोजना शीर्षक, विवरण, सामग्री तालिका, स्थापना, उपयोग, सुविधाएँ, कॉन्फ़िगरेशन और लाइसेंस।
कार्यान्वयन योजना की समीक्षा करें।
कुछ क्षणों के बाद, प्लान एजेंट चैट दृश्य में एक योजना तैयार करता है। योजना एक उच्च-स्तरीय सारांश और चरणों का विवरण प्रदान करती है, जिसमें स्पष्टीकरण के लिए कोई भी खुला प्रश्न भी शामिल है। आप आवश्यकताओं को स्पष्ट करने, दायरा समायोजित करने या प्रश्नों के उत्तर देने के लिए कई बार पुनरावृति कर सकते हैं।
एक बार योजना पूरी हो जाने के बाद, योजना को एजेंट मोड में सौंपने के लिए कार्यान्वयन प्रारंभ करें का चयन करें, या बाद में उपयोग के लिए योजना को मार्कडाउन फ़ाइल के रूप में सहेजने के लिए संपादक में खोलें का चयन करें।
जब आप प्रारंभ कार्यान्वयन का चयन करते हैं, तो GitHub Copilot एजेंट मोड पर स्विच करता है और अनुमोदित योजना के आधार पर दस्तावेज़ीकरण को लागू करना प्रारंभ करता है। जेनरेट की गई दस्तावेज़ीकरण फ़ाइलों की समीक्षा करें और परिवर्तनों को स्वीकार या त्याग दें।
प्रोजेक्ट दस्तावेज़ीकरण जनरेट करने के लिए एजेंट मोड का उपयोग करें
एजेंट मोड परियोजना प्रलेखन उत्पन्न करने के लिए सबसे अच्छा है जिसके लिए परियोजना की गहन समझ की आवश्यकता होती है। एजेंट मोड प्रोजेक्ट दस्तावेज़ीकरण जनरेट करने से पहले संपूर्ण प्रोजेक्ट संरचना का विश्लेषण करता है। कई फ़ाइलों और फ़ोल्डरों से जानकारी एकत्र करके, एजेंट मोड जटिल संबंधों का वर्णन कर सकता है और दस्तावेजों के बीच लिंक शामिल कर सकता है।
प्रोजेक्ट दस्तावेज़, जैसे README.md फ़ाइल, एजेंट मोड का उपयोग करके उत्पन्न करने के लिए निम्न प्रक्रिया का उपयोग करें:
दस्तावेज़ीकरण आवश्यकताओं और सहायक संसाधनों की पहचान करें।
चैट दृश्य खोलें और एजेंट मोड का उपयोग करके एक नया चैट सत्र शुरू करें।
चैट सत्र में संदर्भ जोड़ें।
चैट में भाग लेने वाले एजेंट मोड में उपलब्ध नहीं हैं, इसलिए आप अपने संकेत के हिस्से के रूप में निर्दिष्ट
@workspaceनहीं कर सकते। हालाँकि, आप चैट संदर्भ में कार्यस्थान फ़ाइलों और फ़ोल्डरों को जोड़कर और उनका उपयोग#codebaseकरके चैट सत्र में संदर्भ जोड़ सकते हैं। बाहरी फ़ाइलों को Visual Studio Code में खोला जा सकता है और फिर Attach Context बटन का उपयोग करके चैट संदर्भ में जोड़ा जा सकता है।इच्छित प्रोजेक्ट दस्तावेज़ीकरण बनाने के लिए एक संकेत दर्ज करें।
उदाहरण के लिए: "प्रोजेक्ट दस्तावेज़ीकरण फ़ाइलों का संग्रह जनरेट करें। इस रिपॉसिटरी के लिए कार्यस्थान README.md फ़ाइल बनाएँ या अद्यतन करें. UsageExamples.md फ़ाइल बनाएँ या अद्यतन करें. ChangeLog.md फ़ाइल बनाएँ या अद्यतन करें. दस्तावेज़ीकरण फ़ाइलों, क्रॉस-रेफरेंस कक्षाओं और विधियों के बीच लिंक शामिल करें, और दस्तावेज़ों में स्थिरता सुनिश्चित करें।
दस्तावेज़ फ़ाइलों की समीक्षा करें, और तब अद्यतनों को सहेजें या छोड़ें.
यदि आवश्यक हो तो विशिष्ट अनुभागों को सही या एन्हांस करने के लिए संकेतों का उपयोग करके फ़ाइल का अद्यतन करें।
एजेंट मोड क्षमताएं
कई प्रलेखन कार्य हैं जहां एजेंट मोड सबसे अच्छा विकल्प है।
मल्टी-फाइल और क्रॉस-फाइल डॉक्यूमेंटेशन जनरेशन।
- एजेंट मोड संपूर्ण परियोजना संरचना का विश्लेषण कर सकता है, कई फ़ाइलों और फ़ोल्डरों से जानकारी एकत्र कर सकता है, और दस्तावेज़ीकरण उत्पन्न कर सकता है जो कोडबेस में सामग्री को लिंक और सारांशित करता है। उदाहरण के लिए, एक पूर्ण एपीआई संदर्भ या एक रीडमी उत्पन्न करना जो सभी प्रमुख घटकों का वर्णन करता है।
स्वचालित परियोजना विश्लेषण और संक्षेपण।
- एजेंट मोड आर्किटेक्चर को सारांशित करने, मुख्य वर्गों / सेवाओं की पहचान करने और आरेख या तालिकाओं का निर्माण करने जैसे कार्य कर सकता है जिन्हें फाइलों और घटकों के बीच संबंधों को समझने की आवश्यकता होती है।
गतिशील सामग्री निर्माण (उदाहरण के लिए, उपयोग उदाहरण, वर्ग तालिकाएँ)
- एजेंट मोड उपयोग उदाहरण, वर्ग जिम्मेदारी तालिकाओं, या सार्वजनिक एपीआई की सूची उत्पन्न करने के लिए परियोजना को स्कैन कर सकता है।
बैच प्रलेखन कार्य।
- एजेंट मोड एक वर्कफ़्लो में दस्तावेज़ीकरण कार्यों का अनुक्रम निष्पादित कर सकता है (उदाहरण के लिए, README अपडेट करें, CONTRIBUTING.md बनाएं, API डॉक्स जनरेट करें, चेंजलॉग अपडेट करें)।
बुद्धिमान लिंकिंग और नेविगेशन।
- एजेंट मोड दस्तावेज़ीकरण फ़ाइलों, क्रॉस-रेफरेंस कक्षाओं और विधियों के बीच लिंक बना सकता है, और डॉक्स में स्थिरता सुनिश्चित कर सकता है।
एजेंट मोड प्रोजेक्ट-वाइड, मल्टी-फाइल और संदर्भ-जागरूक प्रलेखन कार्यों के लिए आदर्श है जिनके लिए विश्लेषण, संश्लेषण और समन्वय की आवश्यकता होती है।
सारांश
GitHub Copilot आपको प्रोजेक्ट डॉक्यूमेंटेशन तैयार करने में मदद कर सकते हैं जो आपके प्रोजेक्ट और उसके हितधारकों की विशिष्ट आवश्यकताओं को पूरा करता है। चैट दृश्य का उपयोग तीन अलग-अलग मोड में प्रोजेक्ट दस्तावेज़ उत्पन्न करने के लिए किया जा सकता है: पूछें, एजेंट और योजना। प्रत्येक मोड की अपनी ताकत और कमजोरियां होती हैं, और उपयोग करने का सबसे अच्छा तरीका हाथ में विशिष्ट कार्य पर निर्भर करता है। आस्क एजेंट मोड आपके कोडबेस या प्रौद्योगिकी अवधारणाओं के बारे में प्रश्न पूछने के लिए सबसे अच्छा है। एजेंट मोड प्रोजेक्ट डॉक्यूमेंटेशन बनाने के लिए सबसे अच्छा है जिसके लिए प्रोजेक्ट की गहन समझ की आवश्यकता होती है। दस्तावेज़ बनाने से पहले एक विस्तृत कार्यान्वयन योजना बनाने के लिए योजना मोड सबसे अच्छा है, जिसे बाद में निष्पादन के लिए एजेंट मोड को सौंपा जा सकता है।