डेवलपर दस्तावेज़ में आमतौर पर प्रत्येक फ़ाइल में एक विवरण शामिल होता है। यह विवरण पुराना हो सकता है, जिससे भ्रम और गलत जानकारी पैदा हो सकती है। इसे रोकने के लिए, आप थोड़े से AI और GenAIScript का उपयोग करके अपने दस्तावेज़ में पुराने विवरणों का पता लगाना स्वचालित कर सकते हैं।

मार्कडाउन और फ्रंटमैटर

कई दस्तावेज़ प्रणालियाँ दस्तावेज़ लिखने के लिए मार्कडाउन प्रारूप और मेटाडेटा संग्रहीत करने के लिए 'फ्रंटमैटर' हेडर का उपयोग करती हैं। यहां फ्रंटमैटर वाली मार्कडाउन फ़ाइल का एक उदाहरण दिया गया है:

---
title: "My Document"
description: "This is a sample document."
---

# My Document

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

लक्ष्य एक ऐसी स्क्रिप्ट बनाना है जो यह पता लगाए कि फ्रंटमैटर में विवरण फ़ील्ड पुराना हो गया है।

लिपि

GenAIScript फाइलों पर चलने के लिए है और एक विशेष वेरिएबल env.files प्रदान करता है जिसमें विश्लेषण की जाने वाली फाइलों की सूची होती है। आप def फ़ंक्शन का उपयोग करके संदर्भ में फ़ाइलों को शामिल करने के लिए इस वेरिएबल का उपयोग कर सकते हैं। बड़ी फ़ाइलों पर सामग्री के विस्फोट से बचने के लिए हम प्रत्येक फ़ाइल को 2000 टोकन तक सीमित करते हैं।

// Define the file to be analyzed
def("DOCS", env.files, { endsWith: ".md", maxTokens: 2000 })

अगला चरण स्क्रिप्ट को एक कार्य देना है। इस मामले में यह जांचने के लिए कि फ्रंटमैटर में सामग्री और विवरण फ़ील्ड मेल खाते हैं।

// Analyze the content to detect outdated descriptions
$`Check if the 'description' field in the front matter in DOCS is outdated.`

अंत में, हम प्रत्येक पुराने विवरण के लिए एक त्रुटि बनाने के लिए अंतर्निहित डायग्नोस्टिक्स जेनरेशन सुविधा का लाभ उठाते हैं।

// enable diagnostics generation
$`Generate an error for each outdated description.`

विजुअल स्टूडियो कोड में चल रहा है

एक बार जब आप इस स्क्रिप्ट को अपने कार्यक्षेत्र में सहेज लेते हैं, तो आप इसे संदर्भ मेनू के माध्यम से किसी फ़ाइल या फ़ोल्डर पर निष्पादित करने में सक्षम होंगे
GenAIScript चलाएँ... का चयन करके।

स्वचालन

आप सीएलआई का उपयोग करके पुराने विवरणों की पहचान करने के लिए इस टूल को अपनी दस्तावेज़ फ़ाइलों पर स्वचालित रूप से चला सकते हैं।

npx --yes genaiscript run detect-outdated-descriptions **/*.md

पता लगाने की प्रक्रिया को स्वचालित करने के लिए इस स्क्रिप्ट को आपकी सीआई/सीडी पाइपलाइन में एकीकृत किया जा सकता है।