التوثيق
DOCS هو مكتبة المعرفة في نظام Portal البيئي — مستودع مركزي لجميع معلومات النظام. كل دليل، كل تعليمات، كل مرجع موجود هنا.
ما هو DOCS؟
DOCS هو مكتبة المعرفة لمنصة Portal — نظام توثيق مركزي مبني على Nextra، أحد أحدث أطر عمل التوثيق المتاحة في السوق اليوم.
إنه المصدر الوحيد للحقيقة لجميع معلومات النظام. هنا ستجد أدلة المستخدم، والوثائق التقنية، ومراجع API، والتعليمات التفصيلية لكل تطبيق في النظام البيئي — من المصادقة إلى ملف المستخدم وملف المنظمة.
منصة معرفة قوية
تدعم جميع الوثائق المحتوى متعدد اللغات والبحث والتنسيق الحديث. معلوماتك متاحة دائمًا وسهلة العثور عليها.
لماذا Nextra؟
Nextra هو إطار عمل توثيق حديث يعتمد على Next.js يوفر:
| الميزة | الوصف |
|---|---|
| بحث سريع | بحث فوري عبر جميع الوثائق |
| متعدد اللغات | دعم 4 لغات جاهزة |
| دعم MDX | مكونات تفاعلية في التوثيق |
| محسّن لـ SEO | تحسين تلقائي لمحركات البحث |
كيف ننظم المعلومات
التنقل
هيكل بديهي
- الوثائق منظمة حسب التطبيقات والأقسام
- التنقل الشجري للحركة السريعة
- مسارات التنقل لفهم الموقع الحالي
- جدول محتويات تلقائي في كل صفحة
يعكس هيكل التوثيق هيكل النظام نفسه، مما يجعل اكتشاف المعلومات منطقيًا إلى أقصى حد.
أنواع التوثيق
يحتوي DOCS على عدة أنواع من التوثيق لأغراض مختلفة:
| النوع | الغرض |
|---|---|
| أدلة المستخدم | تعليمات للمستخدمين النهائيين |
| التوثيق التقني | معلومات تفصيلية للمطورين |
| مراجع API | توثيق لواجهات برمجة التطبيقات والتكامل |
| أدلة المسؤول | تعليمات للتكوين والإدارة |
ميزات التوثيق
مكونات تفاعلية
يستخدم التوثيق مكونات حديثة لفهم أفضل للمعلومات: كتل تنبيه، علامات تبويب، أقسام قابلة للطي، وأكثر من ذلك بكثير.
أمثلة التعليمات البرمجية
تمييز بناء الجملة لأكثر من 100 لغة برمجة، نسخ الكود بنقرة واحدة، أمثلة مع شروحات.
تصميم متجاوب
يبدو التوثيق رائعًا على أي جهاز — من الهواتف المحمولة إلى الشاشات العريضة.
السمة الداكنة
التبديل بين السمات الفاتحة والداكنة للقراءة المريحة في أي وقت من اليوم.
الأسئلة الشائعة
كيف أجد المعلومات التي أحتاجها؟
استخدم البحث (Ctrl+K أو Cmd+K) للبحث الفوري عبر جميع الوثائق. يمكنك أيضًا استخدام التنقل الشجري على اليسار أو بطاقات التنقل في الصفحات الرئيسية للأقسام.
بأي لغات متوفر التوثيق؟
جميع الوثائق متاحة بأربع لغات: الروسية والإنجليزية والتاغالوغية والعربية. يقع مبدل اللغة في الزاوية العلوية اليمنى. يتم حفظ اختيارك تلقائيًا.
كيف أقترح تحسينات على التوثيق؟
إذا لاحظت خطأً أو أردت اقتراح تحسين، اتصل بالدعم أو تواصل مع فريق التطوير. نحن نقدر التعليقات ونحسّن التوثيق باستمرار.
هل يتم تحديث التوثيق تلقائيًا؟
نعم. يتم تحديث التوثيق مع كل إصدار للنظام. تنعكس جميع التغييرات في الوظائف فورًا في أقسام التوثيق المقابلة بجميع اللغات.