دليل صيانة التوثيق¶

يحدد هذا الدليل إجراءات الصيانة المستمرة لنظام معرفة برينسايت لضمان بقاء التوثيق محدثاً ومتوافقاً وقيماً.

جدول المحتويات¶

1. جدول التحديث المنتظم
2. عملية مراجعة المحتوى
3. جمع الملاحظات
4. مساهمات المجتمع
5. إدارة الإصدارات
6. ضمان الجودة

جدول التحديث المنتظم¶

المراجعات الفصلية (كل 3 أشهر)¶

إجراء مراجعات شاملة لجميع التوثيق:

مجال الرعاية الصحية¶

• مراجعة آخر تحديثات نفيس وتغييرات API
• تحديث متطلبات الامتثال لنظام حماية البيانات الشخصية
• التحقق من مواصفات ملف FHIR R4
• التحقق من اللوائح الصحية الجديدة في المملكة العربية السعودية
• تحديث أنواع رفض المطالبات وإجراءات المعالجة
• مراجعة إرشادات التكامل مع شركات التأمين (بوبا، التعاونية، إلخ)

مجال الأعمال¶

• تحديث تحليل السوق والمشهد التنافسي
• تحديث النماذج المالية واستراتيجيات التسعير
• مراجعة اتفاقيات الشراكة وإرشادات الموردين
• تحديث قوالب المناقصات وأدلة الاستجابة
• التحقق من الامتثال لإرشادات العلامة التجارية

المجال التقني¶

• تحديث توثيق البنية التحتية (Cloudflare، Coolify)
• مراجعة بروتوكولات الأمان والامتثال
• تحديث توثيق API
• التحقق من التقنيات المتقادمة
• تحديث إجراءات DevOps وسير عمل CI/CD

التطوير الشخصي¶

• إضافة تأملات ورؤى جديدة
• تحديث مصادر التعلم
• تحديث تقنيات الإنتاجية

التحديثات الشهرية¶

التركيز على المحتوى ذي الأولوية العالية:

1. الأسبوع 1: اللوائح الصحية والامتثال
2. التحقق من إعلانات نفيس
3. مراجعة تحديثات نظام حماية البيانات الشخصية

4. مراقبة إرشادات مجلس الضمان الصحي

5. الأسبوع 2: التوثيق التقني

6. تحديث مراجع API
7. التحقق من تصحيحات الأمان

8. مراجعة إجراءات المراقبة والتنبيه

9. الأسبوع 3: تحديثات الأعمال

10. تحديث التسعير والتعبئة
11. تحديث دراسات الحالة

12. مراجعة تموضع السوق

13. الأسبوع 4: ملاحظات المجتمع

14. معالجة مشكلات GitHub
15. مراجعة بيانات التحليلات
16. تنفيذ التحسينات المقترحة

المهام الأسبوعية¶

• مراقبة مشكلات ومناقشات GitHub
• مراجعة طلبات السحب
• التحقق من حالة البناء وإصلاح أي فشل
• تحديث CHANGELOG.md بالتغييرات الأخيرة

عملية مراجعة المحتوى¶

قائمة المراجعة¶

لكل صفحة قيد المراجعة:

الدقة¶

• جميع المعلومات محدثة وصحيحة
• الروابط الخارجية صالحة ويمكن الوصول إليها
• أمثلة الكود تعمل كما هو متوقع
• لقطات الشاشة تعكس الواجهة الحالية
• أرقام الإصدارات محدثة

الاكتمال¶

• جميع الأقسام مكتوبة بالكامل (لا توجد مهام معلقة)
• المراجع المتقاطعة كاملة
• الموضوعات ذات الصلة مرتبطة
• الأمثلة تغطي حالات الاستخدام الشائعة
• النسختان الإنجليزية والعربية متزامنتان

الجودة¶

• المحتوى واضح ومنظم جيداً
• الدقة التقنية تم التحقق منها
• القواعد والإملاء صحيحان
• التنسيق متسق
• الصور لها نص بديل

الامتثال¶

• يلبي معايير WCAG 2.2 المستوى AA
• يتبع إرشادات العلامة التجارية
• يحترم متطلبات الخصوصية (نظام حماية البيانات الشخصية)
• لا توجد معلومات حساسة مكشوفة
• الإسناد المناسب للمحتوى الخارجي

جمع الملاحظات¶

آليات ملاحظات المستخدم¶

1. ملاحظات على مستوى الصفحة¶

تكوين في قوالب الصفحة (عند تمكين التحليلات):

# في قسم extra في mkdocs.yml (عندما تكون جاهزاً للتنفيذ)
analytics:
  feedback:
    title: هل كانت هذه الصفحة مفيدة؟
    ratings:
      - icon: material/emoticon-happy-outline
        name: كانت هذه الصفحة مفيدة
        data: 1
        note: شكراً على ملاحظاتك!
      - icon: material/emoticon-sad-outline
        name: يمكن تحسين هذه الصفحة
        data: 0
        note: شكراً! يرجى إنشاء مشكلة مع الاقتراحات.

2. مشكلات GitHub¶

إنشاء قوالب مشكلات لأنواع مختلفة من الملاحظات.

3. نموذج الملاحظات¶

إنشاء صفحة ملاحظات مخصصة لتسهيل التواصل مع المستخدمين.

مساهمات المجتمع¶

تشجيع المساهمات¶

1. دليل مساهمة واضح (في CONTRIBUTING.md)
2. تعليمات إعداد بسيطة
3. مدونة السلوك
4. إرشادات الأسلوب

5. عملية المراجعة

6. مشكلات جيدة للبداية

7. good-first-issue
8. help-wanted

9. documentation

10. التقدير

11. إدراج المساهمين في CHANGELOG.md
12. الاعتراف في رسائل الالتزام
13. إبراز المساهمات المهمة

إدارة الإصدارات¶

استخدام Mike للإصدارات¶

Mike مكون في mkdocs.yml ويمكّن إدارة الإصدارات:

# نشر إصدار جديد
mike deploy 2024.1 latest --update-aliases

# تعيين الإصدار الافتراضي
mike set-default latest

# نشر إصدار مستقر
mike deploy 2024.1 stable --update-aliases

# سرد جميع الإصدارات
mike list

استراتيجية الإصدارات¶

1. الأحدث - إصدار التطوير الحالي
2. المستقر - إصدار جاهز للإنتاج
3. الأرشيف - الإصدارات التاريخية

ضمان الجودة¶

قائمة التحقق قبل الإصدار¶

قبل نشر إصدارات جديدة:

البناء والاختبار¶

• البناء النظيف ينجح: mkdocs build
• لا توجد روابط داخلية مكسورة
• الروابط الخارجية صالحة
• وظيفة البحث تعمل
• متجاوب مع الجوال
• تخطيط RTL صحيح للعربية

جودة المحتوى¶

• جميع الصفحات لها أوصاف ميتا
• الصور لها نص بديل
• أمثلة الكود تم اختبارها
• المخططات محدثة
• المراجع المتقاطعة صحيحة

إمكانية الوصول¶

• نتيجة Lighthouse 95+
• تقارير WAVE لا أخطاء
• التنقل بلوحة المفاتيح يعمل
• متوافق مع قارئات الشاشة
• تباين الألوان متوافق مع WCAG AA

تذكر: التوثيق نظام حي. الصيانة المنتظمة تضمن بقاءه المورد القيم الذي تعتمد عليه فرق وشركاء برينسايت.

OID: 1.3.6.1.4.1.61026