प्रोग्रामिंग मंदारिन प्रॉम्प्ट
प्रोजेक्ट README जेनरेटर
प्रोजेक्ट जानकारी के आधार पर संरचित README: परिचय, इंस्टॉलेशन, उपयोग, कॉन्फ़िगरेशन विकल्प और FAQ — स्वर उपयोगकर्ता-केंद्रित।
पूरा प्रॉम्प्ट
आप एक ओपन-सोर्स दस्तावेज़ीकरण इंजीनियर हैं; README का सिद्धांत: 5 सेकंड में समझ आए, पढ़कर तुरंत इस्तेमाल किया जा सके।
प्रोजेक्ट जानकारी: [प्रोजेक्ट का नाम / उद्देश्य / टेक स्टैक]।
आवश्यकताएँ:
1. मानक संरचना आउटपुट करें: एक वाक्य परिचय → स्क्रीनशॉट/डेमो प्लेसहोल्डर → इंस्टॉलेशन (pip/npm कमांड) → त्वरित उपयोग (3 चरण) → कॉन्फ़िगरेशन तालिका → 2 सामान्य प्रश्न → लाइसेंस विवरण प्लेसहोल्डर
2. परिचय में "is / does / not" सूत्र का उपयोग करें (यह क्या है / क्या करता है / क्या नहीं करता)
3. उपयोग उदाहरणों में वास्तविक कॉपी करने योग्य कमांड और पैरामीटर विवरण दें, "जल्द आ रहा है" न लिखें
4. कॉन्फ़िगरेशन विकल्प तालिका में दें (फ़ील्ड/डिफ़ॉल्ट मान/विवरण)
5. स्वर उपयोगकर्ता-केंद्रित रखें, डेवलपर-आंतरिक नहीं, और शब्दावली के ढेर से बचें
आउटपुट: पूरा README कंकाल + हर अनुभाग के लिए 1 वाक्य लेखन संकेत।
इस्तेमाल कैसे करें:
ऊपर दिया प्रॉम्प्ट कॉपी करें → किसी भी AI टूल में पेस्ट करें → कोणीय कोष्ठक के अंदर के वेरिएबल को अपनी सामग्री से बदलें → भेजें।
बदलने योग्य वेरिएबल
| वेरिएबल | उदाहरण |
|---|---|
| [प्रोजेक्ट नाम+उद्देश्य+टेक स्टैक] | Python पर आधारित छवियों की बैच कंप्रेशन का एक छोटा टूल |
Hot