تتضمن وثائق المطور عادةً وصفًا في كل ملف. يمكن أن تصبح هذه الأوصاف قديمة، مما يؤدي إلى الارتباك وتقديم معلومات غير صحيحة. لمنع ذلك، يمكنك أتمتة اكتشاف الأوصاف القديمة في وثائقك باستخدام القليل من الذكاء الاصطناعي وGenAIScript.

تخفيض السعر والأمر الأمامي

تستخدم العديد من أنظمة التوثيق تنسيق تخفيض السعر لكتابة الوثائق ورأس "frontmatter" لتخزين البيانات الوصفية. فيما يلي مثال لملف تخفيض السعر مع المادة الأمامية:

---
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.`

يعمل في كود Visual Studio

بمجرد حفظ هذا البرنامج النصي في مساحة العمل الخاصة بك، ستتمكن من تنفيذه على ملف أو مجلد من خلال قائمة السياق
عن طريق تحديد تشغيل GenAIScript....

الأتمتة

يمكنك تشغيل هذه الأداة تلقائيًا على ملفات الوثائق الخاصة بك لتحديد الأوصاف القديمة باستخدام CLI.

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

يمكن دمج هذا البرنامج النصي في مسار CI/CD الخاص بك لأتمتة عملية الكشف.