doc-sync
التحقق من تطابق وثائق IdeaVim مع تغييرات الكود
غالبًا ما تنحرف الوثائق بعد تحديثات الكود وتنشئ أمثلة مكسورة للمستخدمين. توفر هذه المهارة سير عمل منظم لمقارنة الوثائق مقابل الكود العامل وتحديد الاختلافات.
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "doc-sync". تحقق من README.md بحثًا عن أمثلة التعيينات القديمة
النتيجة المتوقعة:
- تم العثور على مثالين مع معلمات مزالة في قسم التعيينات
- يجب أن يشير README.md إلى اسم MappingScope الجديد بدلاً من الاسم القديم
- لم يتم اكتشاف مشاكل أخرى في ملف README
استخدام "doc-sync". تحقق من doc/ideavim-api.md بعد الإصدار 2.0
النتيجة المتوقعة:
- تم تحديد 5 توقيعات API تغيرت في الإصدار 2.0
- تحتاج 3 أسماء معلمات في الأمثلة إلى التحديث لتطابق التوقيعات الجديدة
- كتلة كود واحدة تستخدم طريقة مهملة تمت إزالتها
استخدام "doc-sync". تحقق مما إذا كان CONTRIBUTING.md يطابق سير عمل git الحالي
النتيجة المتوقعة:
- تطابق جميع أوامر git في CONTRIBUTING.md مع سير عمل الفرع الحالي
- لم يتم العثور على أي اختلافات بين الخطوات الموثقة وسلوك git الفعلي
التدقيق الأمني
آمنAll 35 static findings are FALSE POSITIVES. The static analyzer misidentified markdown documentation text as security threats. SKILL.md is pure documentation containing workflow instructions and example bash commands shown as documentation - no executable code exists. The skill-report.json already correctly assessed this as safe with no risk factors.
عوامل الخطر
🌐 الوصول إلى الشبكة (1)
📁 الوصول إلى نظام الملفات (1)
⚙️ الأوامر الخارجية (18)
درجة الجودة
ماذا يمكنك بناءه
تدقيق ما بعد الإصدار
تأكيد أن الوثائق تعكس التغييرات الأخيرة في واجهة برمجة التطبيقات بعد اكتمال دورة الإصدار.
مراجعة الوثائق قبل طلب السحب
التحقق من صحة الأمثلة وأسماء المعلمات قبل تقديم تغييرات تحديث الوثائق.
تصنيف التراجع
التحقق مما إذا كانت مشكلات الوثائق المُبلَّغ عنها تتوافق مع تغييرات حقيقية في واجهة برمجة التطبيقات في الكود.
جرّب هذه الموجهات
تحقق من doc/ideavim-mappings.md مقابل الكود الحالي واكتب أي عدم تطابق تم العثور عليه.
غيرت MappingScope.kt. حدد الوثائق المتأثرة واقترح تحديثات محددة.
راجع جميع الملفات في doc/ بحثًا عن أمثلة قديمة وخلص إلى النتائج في تقرير.
تحقق من صحة جميع الأمثلة التي تستخدم map() و nmap() و vmap() مقابل توقيعات API الحالية في الكود.
أفضل الممارسات
- ابدأ بتنفيذ عامل لتأسيس الحقيقة الأساسية قبل مقارنة الوثائق
- عند التحقق من انحراف الوثائق، أعطِ الأولوية للعناصر المزالة أو المعادة تسمية واجهة برمجة التطبيقات
- احافظ على تحديثات طفيفة ومتوافقة مع أسلوب ومصطلحات الوثائق الموجودة
تجنب
- تحديث الصياغة عندما يكون السلوك الأساسي لا يزال دقيقًا
- تخطي التحقق من المعلمات المسماة في أمثلة الكود
- الافتراض أن الوثائق صحيحة دون التحقق من التنفيذ العامل