कोडबेस आर्किटेक्चर ऑनबोर्डिंग डॉक्यूमेंट जनरेटर

**प्रसंग:** मैं एक डेवलपर हूं जो अभी-अभी प्रोजेक्ट से जुड़ा है और मैं आपका उपयोग कर रहा हूं, एक AI कोडिंग सहायक, मौजूदा कोडबेस की गहन समझ हासिल करने के लिए। मेरा लक्ष्य जल्द से जल्द उत्पादक बनना है और वर्तमान सिस्टम की ठोस समझ के आधार पर सूचित तकनीकी निर्णय लेना है। **प्राथमिक उद्देश्य:** इस प्रोजेक्ट/वर्कस्पेस में उपलब्ध सोर्स कोड का विश्लेषण करें और एक विस्तृत, स्पष्ट और सुव्यवस्थित Markdown दस्तावेज़ तैयार करें जो सिस्टम की आर्किटेक्चर, विशेषताओं, मुख्य प्रवाहों, प्रमुख घटकों और तकनीकी स्टैक की व्याख्या करे। यह दस्तावेज़ एक तकनीकी ऑनबोर्डिंग गाइड के रूप में काम करे। जब भी संभव हो, प्रासंगिक फाइलों, क्लासेस और फंक्शन्स के सीधे लिंक प्रदान करके नेविगेबिलिटी में सुधार करें, साथ ही कोड उदाहरण भी दें जो अवधारणाओं को स्पष्ट करने में मदद करें। --- ## विस्तृत निर्देश - कृपया निम्नलिखित बिंदुओं को संबोधित करें: ### 1. README / निर्देश फाइलों का सारांश - README.md, LEIAME.md, CONTRIBUTING.md, या समान दस्तावेज़ों जैसी फाइलों की तलाश करें। - एक नए डेवलपर के लिए सबसे प्रासंगिक अनुभागों का एक वस्तुनिष्ठ लेकिन विस्तृत सारांश प्रदान करें, जिसमें शामिल हैं: - प्रोजेक्ट अवलोकन - सिस्टम को स्थानीय रूप से कैसे सेट अप और चलाएं - अपनाए गए मानक और परंपराएं - योगदान दिशानिर्देश (यदि उपलब्ध हों) --- ### 2. विस्तृत तकनीकी स्टैक - प्रोजेक्ट में उपयोग किए गए पूर्ण तकनीकी स्टैक की पहचान करें और सूचीबद्ध करें: - प्रोग्रामिंग भाषा(एं), जब पता लगाने योग्य हों तो संस्करणों सहित (जैसे, package.json, pom.xml, .tool-versions, requirements.txt, build.gradle, आदि से)। - मुख्य फ्रेमवर्क (बैकएंड, फ्रंटएंड, आदि - जैसे, Spring Boot, .NET, React, Angular, Vue, Django, Rails)। - डेटाबेस: - प्रकार (SQL / NoSQL) - नाम (PostgreSQL, MongoDB, आदि) - कोर आर्किटेक्चर शैली (जैसे, Monolith, Microservices, Serverless, MVC, MVVM, Clean Architecture)। - क्लाउड प्लेटफॉर्म (यदि SDK या कॉन्फ़िगरेशन के माध्यम से पहचाना जा सकता है - AWS, Azure, GCP)। - बिल्ड टूल और पैकेज मैनेजर (Maven, Gradle, npm, yarn, pip)। - कोई अन्य प्रासंगिक तकनीक (कैशिंग, मैसेज ब्रोकर, कंटेनरीकरण - Docker, Kubernetes)। - प्रत्येक आइटम को प्रदर्शित करने वाली कॉन्फ़िगरेशन फाइलों को संदर्भित और लिंक करें। --- ### 3. सिस्टम अवलोकन और उद्देश्य - स्पष्ट रूप से वर्णन करें कि सिस्टम क्या करता है और यह किसके लिए है। - यह किन समस्याओं का समाधान करता है? - मुख्य कार्यक्षमताओं की सूची बनाएं। - यदि संभव हो, तो सिस्टम को शामिल व्यावसायिक डोमेन से संबंधित करें। - मुख्य विशेषताओं का उच्च-स्तरीय विवरण प्रदान करें। --- ### 4. प्रोजेक्ट संरचना और पठन अनुशंसाएं - प्रवेश बिंदु: मुझे कोड की खोज कहां से शुरू करनी चाहिए? मुख्य प्रवेश बिंदुओं की पहचान करें (जैसे, main.go, index.js, Program.cs, app.py, Application.java)। इन फाइलों के सीधे लिंक प्रदान करें। - सामान्य संगठन: समग्र फ़ोल्डर और फ़ाइल संरचना की व्याख्या करें। महत्वपूर्ण परंपराओं को उजागर करें। वास्तविक फ़ोल्डर और फ़ाइल नाम उदाहरणों का उपयोग करें। - कॉन्फ़िगरेशन: क्या मुख्य कॉन्फ़िगरेशन फाइलें हैं? (जैसे, config.yaml, .env, appsettings.json) कौन से कॉन्फ़िगरेशन महत्वपूर्ण हैं? लिंक प्रदान करें। - पठन अनुशंसा: एक क्रम या प्रमुख फाइलों/मॉड्यूल्स का सेट सुझाएं जिन्हें प्रोजेक्ट की मुख्य अवधारणाओं को जल्दी से समझने के लिए पहले पढ़ा जाना चाहिए। --- ### 5. प्रमुख घटक - सबसे महत्वपूर्ण या केंद्रीय मॉड्यूल, क्लासेस, फंक्शन्स या सेवाओं की पहचान करें और उनका वर्णन करें। - प्रत्येक घटक की जिम्मेदारियों की व्याख्या करें। - उनकी जिम्मेदारियों और अन्योन्याश्रितताओं का वर्णन करें। - प्रत्येक घटक के लिए: - एक प्रतिनिधि कोड स्निपेट शामिल करें - एक लिंक प्रदान करें जहां इसे लागू किया गया है - जब भी संभव हो सीधे लिंक और कोड उदाहरण प्रदान करें। --- ### 6. निष्पादन और डेटा प्रवाह - सबसे सामान्य या महत्वपूर्ण वर्कफ़्लो या व्यावसायिक प्रक्रियाओं का वर्णन करें (जैसे, ऑर्डर प्रोसेसिंग, उपयोगकर्ता प्रमाणीकरण)। - समझाएं कि डेटा सिस्टम के माध्यम से कैसे प्रवाहित होता है: - डेटा कहां संग्रहीत किया जाता है - इसे कैसे पढ़ा, संशोधित और प्रचारित किया जाता है - जब भी संभव हो, उदाहरणों के साथ चित्रित करें और प्रासंगिक फंक्शन्स या क्लासेस से लिंक करें। #### 6.1 डेटाबेस स्कीमा अवलोकन (यदि लागू हो) - डेटा-गहन अनुप्रयोगों के लिए: - मुख्य इकाइयों/टेबल्स/कलेक्शन्स की पहचान करें - उनके प्राथमिक संबंधों का वर्णन करें - यदि उपलब्ध हो तो ORM मॉडल, माइग्रेशन या स्कीमा फाइलों पर आधारित करें --- ### 7. निर्भरताएं और एकीकरण - निर्भरताएं: उपयोग की जाने वाली मुख्य बाहरी लाइब्रेरी, फ्रेमवर्क और SDK की सूची बनाएं। प्रत्येक की भूमिका संक्षेप में समझाएं। लिंक प्रदान करें जहां वे कॉन्फ़िगर या सबसे अधिक उपयोग किए जाते हैं। - एकीकरण: बाहरी सेवाओं, अतिरिक्त डेटाबेस, तृतीय-पक्ष API, मैसेज ब्रोकर आदि के साथ एकीकरण की पहचान करें और समझाएं। संचार कैसे होता है? जिम्मेदार मॉड्यूल/क्लासेस की ओर इंगित करें और लिंक शामिल करें। #### 7.1 API दस्तावेज़ीकरण (यदि लागू हो) - यदि प्रोजेक्ट API उजागर करता है: - क्या API दस्तावेज़ीकरण टूल या मानकों के प्रमाण हैं (जैसे, Swagger/OpenAPI, Javadoc, एंडपॉइंट-विशिष्ट docstrings)? - यह दस्तावेज़ीकरण कहां पाया जा सकता है या इसे कैसे उत्पन्न किया जा सकता है? --- ### 8. आरेख - सिस्टम आर्किटेक्चर और व्यवहार की कल्पना करने के लिए उच्च-स्तरीय आरेख उत्पन्न करें: - घटक आरेख (मुख्य मॉड्यूल और उनकी बातचीत को उजागर करना) - डेटा प्रवाह आरेख (दिखाता है कि जानकारी सिस्टम के माध्यम से कैसे चलती है) - क्लास आरेख (मुख्य क्लासेस और संबंध दिखाना, यदि लागू हो) - सरलीकृत डिप्लॉयमेंट आरेख (जहां घटक चलते हैं, यदि पता लगाने योग्य हो) - सरलीकृत इंफ्रास्ट्रक्चर/डिप्लॉयमेंट आरेख (यदि इंफ्रास्ट्रक्चर विवरण स्पष्ट हैं) - इन आरेखों को Markdown फ़ाइल के अंदर Mermaid सिंटैक्स का उपयोग करके बनाएं। - आरेख उच्च-स्तरीय होने चाहिए; व्यापक विवरण की आवश्यकता नहीं है। --- ### 9. परीक्षण - क्या स्वचालित परीक्षण हैं? - यूनिट परीक्षण - एकीकरण परीक्षण - एंड-टू-एंड (E2E) परीक्षण - वे प्रोजेक्ट में कहां स्थित हैं? - कौन से परीक्षण फ्रेमवर्क उपयोग किए जाते हैं? - परीक्षण आमतौर पर कैसे निष्पादित किए जाते हैं? - परीक्षण स्थानीय रूप से कैसे चलाए जा सकते हैं? - क्या परीक्षणों से जुड़ी कोई CI/CD रणनीति है? --- ### 10. त्रुटि प्रबंधन और लॉगिंग - एप्लिकेशन सामान्य रूप से त्रुटियों को कैसे संभालता है? - क्या कोई मानक पैटर्न है (जैसे, वैश्विक मिडलवेयर, कस्टम अपवाद)? - कौन सी लॉगिंग लाइब्रेरी उपयोग की जाती है? - क्या कोई मानक लॉगिंग प्रारूप है? - क्या मॉनिटरिंग टूल (जैसे, Datadog, Sentry) के साथ दृश्यमान एकीकरण है? --- ### 11. सुरक्षा विचार - क्या कोड में स्पष्ट सुरक्षा तंत्र हैं? - प्रमाणीकरण - प्राधिकरण (मिडलवेयर/फिल्टर) - इनपुट सत्यापन - क्या विशिष्ट सुरक्षा लाइब्रेरी प्रमुख रूप से उपयोग की जाती हैं (जैसे, Spring Security, Passport.js, JWT लाइब्रेरी)? - क्या उल्लेखनीय सुरक्षा प्रथाएं हैं? - रहस्य प्रबंधन - सामान्य हमलों से सुरक्षा --- ### 12. अन्य प्रासंगिक अवलोकन (बिल्ड/डिप्लॉय सहित) - क्या बिल्ड या डिप्लॉयमेंट से संबंधित फाइलें हैं? - Dockerfile - docker-compose.yml - बिल्ड/डिप्लॉय स्क्रिप्ट - CI/CD कॉन्फ़िगरेशन फाइलें (जैसे, .github/workflows/, .gitlab-ci.yml) - ये फाइलें एप्लिकेशन के निर्माण और तैनाती के बारे में क्या संकेत देती हैं? - क्या एक नए डेवलपर के लिए कुछ और महत्वपूर्ण या विशेष रूप से सहायक है? - टिप्पणियों में उल्लिखित ज्ञात तकनीकी ऋण - असामान्य डिज़ाइन पैटर्न - महत्वपूर्ण कोडिंग परंपराएं - प्रदर्शन नोट --- ## अंतिम आउटपुट प्रारूप - पूर्ण प्रतिक्रिया को एक अच्छी तरह से स्वरूपित Markdown (.md) दस्तावेज़ के रूप में उत्पन्न करें। - स्पष्ट और प्रत्यक्ष भाषा का उपयोग करें। - उपरोक्त क्रमांकित अनुभागों के अनुसार शीर्षकों और उपशीर्षकों के साथ सामग्री व्यवस्थित करें। - प्रासंगिक कोड स्निपेट (छोटे और प्रतिनिधि) शामिल करें। - जब भी किसी विशिष्ट कोड तत्व का उल्लेख किया जाए तो फाइलों, फंक्शन्स, क्लासेस और परिभाषाओं के क्लिक करने योग्य लिंक शामिल करें। - पठनीयता के लिए क्रमांकित अनुभागों का उपयोग करके दस्तावेज़ संरचना करें। जब भी संभव हो: - फाइलों, फंक्शन्स और क्लासेस के क्लिक करने योग्य लिंक शामिल करें। - छोटे, प्रतिनिधि कोड स्निपेट दिखाएं। - सूचियों के लिए बुलेट पॉइंट या टेबल का उपयोग करें। --- ### महत्वपूर्ण विश्लेषण को प्रोजेक्ट की सभी फाइलों पर विचार करना चाहिए। इस कार्य को पूरी तरह से निष्पादित करने और सिस्टम की पूरी समझ हासिल करने के लिए आवश्यक सभी फाइलों को पढ़ें और समझें। --- ### कार्रवाई कृपया मेरे वातावरण/वर्कस्पेस में वर्तमान में उपलब्ध सोर्स कोड का विश्लेषण करें और अनुरोधित Markdown दस्तावेज़ उत्पन्न करें। आउटपुट फ़ाइल नाम इस प्रारूप का पालन करना चाहिए: <yyyy-mm-dd-project-name-app-dev-discovery_cursor.md>