إنتقل إلى المحتوى الرئيسي

حوكمة التوثيق

هذا المستند يحدد كيف نحافظ على خدمة التوثيق المنشورة تحت apps/docs كمصدر موثوق وآمن.

مبادئ أساسية​

  • خدمة التوثيق المنشورة تعامل كخدمة عامة حتى لو احتوت أقساماً داخلية
  • لا يجوز نشر أسرار أو كلمات مرور أو بيانات seed قابلة للاستخدام
  • الكود الحالي في المستودع هو المرجع النهائي عند تعارضه مع نص قديم في التوثيق
  • التوثيق جزء من التغيير نفسه، وليس عملاً مؤجلاً

المصدر المعتمد​

الصفحات العامة​

  • معلومات الدعم العامة: src/data/publicDocsMetadata.ts
  • روابط المنتجات العامة: src/data/publicDocsMetadata.ts
  • حالة توفر التطبيقات العامة: src/data/publicDocsMetadata.ts

الصفحات التقنية​

  • قاعدة البيانات: infrastructure/supabase/migrations/
  • عقود API: apps/*/src/app/api/
  • سياسات المصادقة: الخدمات والمسارات الحالية، ثم الوثائق الموافقة لها

سياسة اللغات​

  • العربية هي اللغة الوحيدة المنشورة والمدعومة حالياً
  • لا يعاد تفعيل الإنجليزية إلا بعد وجود شجرة ترجمة حقيقية تحت apps/docs/i18n/

معيار حداثة المحتوى​

الصفحات عالية الخطورة يجب أن تحتوي:

  • last_verified
  • status
  • source_of_truth
  • audience
  • owner
  • surfaces

تمييز الحالات​

  • current: صفحة موثقة ومراجعة مقابل الواقع الحالي
  • historical: صفحة أو تقرير تاريخي لا يجب قراءته كحالة النظام الحالية
  • archived: صفحة محفوظة للرجوع فقط ويجب عدم اعتمادها كسلوك حي

مكافحة التقادم​

أي تغيير مهم في هذه المسارات يجب أن يتبعه تحديث توثيق موافق:

  • apps/customer
  • apps/dashboard
  • apps/admin
  • apps/mobile/customer
  • apps/mobile/driver
  • packages
  • infrastructure/supabase/migrations

ويجب تشغيل:

pnpm --filter @shambus/docs quality