استخدم هذه القائمة عند مراجعة محتوى التوثيق قبل نشره للمستخدمين.
1. جودة اللغة
| الفحص | المعيار |
|---|
| نبرة الأعمال | استخدم لغة واضحة لمسؤول العميل، وليس لغة تنفيذ تقنية. |
| اتساق المصطلحات | استخدم المصطلحات نفسها للخطر والمشكلة والنتيجة والاستثناء والتقييم والدليل. |
| الجمل القصيرة | فضل التعليمات المباشرة والشرح البسيط. |
| النص الموجه للإجراء | اشرح ما يجب على المستخدم فعله ولماذا. |
| عدم وجود مراجع داخلية | لا تذكر تفاصيل تنفيذ أو مستودعات أو بيئات أو نشر. |
2. جودة العربية
| الفحص | المعيار |
|---|
| عربية سليمة | لا توجد أحرف تالفة أو نص غير مقروء. |
| اتساق المصطلحات | استخدم ترجمات متسقة للحالة والاعتماد والدليل والمالك وسير العمل. |
| نبرة عملية | استخدم عربية مناسبة لمسؤولي الأعمال. |
| الاتجاه | تأكد أن الصفحات العربية تظهر من اليمين إلى اليسار بشكل صحيح. |
| الجداول | تأكد أن الجداول تبقى مقروءة على الشاشات الصغيرة. |
3. جودة لقطات الشاشة
| الفحص | المعيار |
|---|
| اللقطة الصحيحة | يجب أن يظهر في كل موقع توثيق لقطاته الخاصة فقط. |
| الشكل الحالي | يجب أن تطابق اللقطات شكل المنتج الحالي. |
| لا توجد بيانات حساسة | لا تعرض اللقطات بيانات مستخدمين أو عملاء أو معلومات سرية حقيقية. |
| سياق مفيد | يجب أن تدعم اللقطة المهمة المشروحة. |
| نص بديل | يجب أن يكون لكل لقطة نص بديل وصفي. |
4. فحوصات سهولة الوصول
| الفحص | المعيار |
|---|
| العناوين | استخدم ترتيبا واضحا للعناوين حتى يسهل مسح الصفحة. |
| الروابط | يجب أن يوضح نص الرابط وجهته. |
| الجداول | يجب أن تحتوي الجداول على رؤوس واضحة. |
| الصور | يجب أن تحتوي الصور على نص بديل مفيد. |
| الهاتف | يجب أن تبقى الجداول الطويلة قابلة للاستخدام على الشاشات الصغيرة. |
5. قائمة فحص الإصدار
قبل نشر التوثيق:
- افحص الأحرف العربية التالفة.
- ابن كل موقع توثيق خاص بالجهة.
- تأكد من عدم ظهور أسماء أو لقطات تخص جهة أخرى.
- افتح الصفحتين الرئيسيتين بالعربية والإنجليزية.
- افتح قسم أدلة المسؤول الرئيسي.
- افتح لقطات الشاشة وتأكد أنها تعمل.
- راجع روابط فهرس المهام.
- راجع ملاحظات الإصدار من منظور العميل.
- تأكد من عدم وجود محتوى تقني داخلي في صفحات العملاء.