यह क्या करता है

readme-gen स्किल आपके कोडबेस का गहन विश्लेषण करके उच्च-गुणवत्ता, पेशेवर README दस्तावेज़ीकरण के निर्माण को स्वचालित करती है। फ़ोल्डर संरचनाएँ मैन्युअल रूप से टाइप करने या डिपेंडेंसी वर्शन खोजने की बजाय, यह स्किल आपके प्रोजेक्ट मैनिफेस्ट (जैसे package.json, pyproject.toml, या cargo.toml) और सोर्स फ़ाइलें पढ़कर एक संरचित, सटीक तकनीकी दस्तावेज़ तैयार करती है।

यह कैसे काम करता है

सटीकता सुनिश्चित करने के लिए स्किल एक बहु-चरणीय डिस्कवरी प्रक्रिया का पालन करती है:

• मेटाडेटा एक्सट्रैक्शन: सिस्टम मैनिफेस्ट से प्रोजेक्ट का नाम, वर्शन और लाइसेंस पहचानता है।
• स्टैक डिटेक्शन: भाषाओं (TS, Python, Go, Rust) और फ्रेमवर्क (Next.js, Vite, Docker) की पहचान के लिए glob पैटर्न का उपयोग करता है।
• API मैपिंग: एक्सपोर्ट किए गए फ़ंक्शन और क्लास को स्वचालित रूप से दस्तावेज़ीकृत करने के लिए एंट्री पॉइंट पढ़ता है।
• एनवायरनमेंट डिस्कवरी: .env फ्रैगमेंट और दस्तावेज़ीकरण के माध्यम से आवश्यक एनवायरनमेंट वेरिएबल का पता लगाता है।

इस स्किल का उपयोग क्यों करें?

दस्तावेज़ीकरण लिखना अक्सर डेवलपर्स की प्राथमिकता सूची में सबसे अंत में होता है। मैन्युअल रूप से उच्च-स्तरीय README सेट करना पुराना पड़ने की संभावना रखता है। चूँकि यह स्किल वास्तविक कोड और फ़ाइल संरचना का विश्लेषण करती है, इसलिए यह आपके प्रोजेक्ट की वास्तविक स्थिति को दर्शाती है। यह मैन्युअल प्रॉम्प्टिंग की तुलना में काफी तेज़ है क्योंकि यह जानती है कि किन फ़ाइलों की जाँच करनी है और एक मानक रिपॉजिटरी लुक के लिए shields.io बैज और स्क्रिप्ट टेबल को कैसे फ़ॉर्मेट करना है।