तय करें कि मार्कडाउन किस लिए है
एक रिपॉज़िटरी README को सफलता का संक्षिप्त मार्ग चाहिए। एक संग्रह प्रवास पूर्णता को प्राथमिकता दे सकता है। LLM वर्कफ़्लो के नोट्स प्रकाशन की चमक के बजाय शीर्षकों और पठनीय टेबल को महत्व दे सकते हैं। रूपांतरण से पहले गंतव्य तय करें ताकि सफ़ाई का स्पष्ट समापन बिंदु हो।
- इच्छित पाठक और प्रकाशन प्रणाली की पहचान करें।
- तय करें कि मूल या मार्कडाउन सत्य का स्रोत बना रहेगा।
- तय करें कि एक बड़ी फ़ाइल कई केंद्रित दस्तावेज़ बननी चाहिए।
- वह प्लेटफ़ॉर्म-विशिष्ट सिंटैक्स रिकॉर्ड करें जिसे गंतव्य स्वीकार करता है।
स्रोत दस्तावेज़ तैयार करें
अपलोड से पहले स्पष्ट संरचना ठीक करना बाद में उसका अनुमान लगाने से तेज़ है। Word में शीर्षक और सूची शैलियों का उपयोग करें। स्प्रेडशीट में प्रति शीट एक आयताकार टेबल अलग करें। प्रस्तुतियों में सार्थक स्लाइड शीर्षक जोड़ें और आवश्यक निष्कर्षों को संपादन योग्य टेक्स्ट में रखें।
PDF के लिए पुष्टि करें कि टेक्स्ट चयन योग्य है। CSV, JSON और XML के लिए सिंटैक्स और एन्कोडिंग सत्यापित करें। HTML के लिए, रिमोट वेब पेज को लाने या निष्पादित करने की उम्मीद करने के बजाय सहेजा गया सामग्री-केंद्रित दस्तावेज़ अपलोड करें।
अपलोड करने से पहले संवेदनशील इनपुट घटाएँ
अस्थायी प्रसंस्करण प्रतिधारण जोखिम कम करता है, लेकिन डेटा न्यूनतमकरण अब भी सबसे अच्छा डिफ़ॉल्ट है। जब भी परिणाम के लिए आवश्यक न हों, क्रेडेंशियल, व्यक्तिगत जानकारी, निजी टिप्पणियाँ, छिपी वर्कशीट, ट्रैक किए गए परिवर्तन और असंबंधित परिशिष्ट हटाएँ।
संरचना से विवरण तक समीक्षा करें
दस्तावेज़ की रूपरेखा से शुरू करें। यदि पठन क्रम या शीर्षक पदानुक्रम गलत है, तो व्यक्तिगत विराम चिह्नों को सुधारना व्यर्थ प्रयास होगा। फिर सूचियों और टेबल की समीक्षा करें, उसके बाद लिंक, इमेज, कोड ब्लॉक और सामान्य रिक्ति की।
- रूपरेखा: एक H1, तार्किक शीर्षक प्रगति, कोई दोहराया पेज फ़र्नीचर नहीं।
- प्रवाह: पैराग्राफ और स्लाइड इच्छित पठन क्रम में दिखाई देते हैं।
- संरचनाएँ: सूचियाँ सन्निहित हैं और टेबल में सुसंगत कॉलम गिनती है।
- संदर्भ: लिंक गंतव्य में हल होते हैं और इमेज में उपयोगी alt टेक्स्ट होता है।
- सटीकता: नाम, संख्याएँ, सूत्र और कोड आधिकारिक स्रोत से मेल खाते हैं।
प्रारूप-विशिष्ट विफलता मोड जानें
PDF कॉलम मिला सकती हैं या हेडर दोहरा सकती हैं। Word दस्तावेज़ टेक्स्ट बॉक्स में अर्थ छिपा सकते हैं। स्लाइड स्थानिक संबंधों पर बहुत अधिक निर्भर करती हैं। वर्कबुक में गणनाएँ और इंटरैक्टिव दृश्य होते हैं जिन्हें मार्कडाउन पुन: प्रस्तुत नहीं कर सकता। EPUB पैकेज-सापेक्ष लिंक और एंडनोट संरचनाओं का उपयोग कर सकता है।
हर स्रोत ऑब्जेक्ट को मार्कडाउन में बलपूर्वक न डालें। एक जटिल स्प्रेडशीट छोटी व्याख्यात्मक टेबल के साथ स्रोत डेटा के रूप में लिंक करने के लिए बेहतर हो सकती है; एक आर्किटेक्चर डायग्राम को बनाए रखी गई इमेज प्लस टेक्स्ट विवरण की आवश्यकता हो सकती है।
अंतिम रेंडरर में सत्यापित करें
एडिटर पूर्वावलोकन सफ़ाई के लिए उपयोगी है, लेकिन GitHub, एक docs फ्रेमवर्क और एक ज्ञानकोष अलग-अलग एक्सटेंशन का समर्थन कर सकते हैं। दस्तावेज़ को उसके गंतव्य में पूर्वावलोकन या निर्माण करें, लिंक और शैली जाँच चलाएँ, और मूल को हटाने से पहले किसी विषय-विशेषज्ञ समीक्षक से अर्थ की पुष्टि करें।
- [ ] Heading outline reviewed - [ ] Tables and lists render correctly - [ ] Links and image paths resolve - [ ] Sensitive data removed - [ ] Technical facts verified - [ ] Final renderer checked