مفتش توثيق AWS

يحلل المفتش توثيق AWS عبر الخدمات ويركّز على الدقة والكمال والتناسق. يقُبل مدخلات مثل service_name وdoc_version وregion وdoc_source_url، ثم يطبق مجموعة من ضوابط الجودة استناداً إلى صفحات المراجع العامة لـ AWS وملاحظات الإصدار. المستخدمون المستهدفون هم مطورو API والكتاب التقنيون وفِرق حوكمة التوثيق الذين يجب عليهم التأكد من بقاء المراجع الخاصة بالخدمات متسقة أثناء الإصدارات السريعة.
الضوابط الأساسية تشمل مواءمة المصطلحات، اتساق تسمية المعاملات، أنواع البيانات والوحدات، وجود الأقسام المطلوبة، والتحقق من الروابط المتقاطعة إلى صفحات المراجع لـ AWS. تقارن تقارير الاختلاف بين الإصدارات الإضافات أو الحذف بين الإصدارات. التقييم يتم بشكل حاسم لعمليات التحقق الأساسية، ويمكن أن يعتمد تقييم ML اختيارياً على قابلية القراءة وتحولات المصطلحات. سير العمل: إدخال المدخلات، اختيار نطاق التحليل (أساسي مقابل متقدم)، تشغيل التحليل، مراجعة التقرير المنسق وتصدير JSON أو Markdown لفِرق العمل اللاحقة. المخرجات تشمل قائمة النتائج، مقترحات الإصلاح، درجة الامتثال وملخص التغييرات. تعطي الأولوية للمشكلات عالية التأثير مثل تعريفات المعاملات غير الواضحة وملاحظات الأمان المفقودة. الجمهور المستهدف: مديري المنتجات ومطورو API والكتاب الفنيون الذين يحتاجون جودة توثيق قابلة لإعادة الإنتاج والتدقيق. الميزات الفريدة تشمل الاتساق عبر الخدمات بناءً على الإصدار، سجلات تدقيق قابلة للتصدير وتعيين مباشر إلى مستندات AWS الكلاسيكية. يركّز على منطق المجال ومخرجات قابلة للإجراء دون واجهة مستخدم.