التوثيق

التوثيق — مدير المؤسسة

نظرة عامة

لدى Survanta تجربتان للتوثيق لا ينبغي الخلط بينهما. التوثيق العام هو فهرس التوثيق في الموقع وصفحات /docs/{spaceCode}/{slug}، ويقتصر على المساحات النشطة الظاهرة على الموقع والصفحات المنشورة. أما HELP السياقية في لوحة التحكم فتحل المتحكم/الإجراء الحالي عبر تعيين مسار مساعدة نشط، ويمكنها قراءة محتوى dashboard-help الداخلي بعد عكس تفويض الصفحة المستهدفة.

تصفح التوثيق

1. افتح التوثيق لتصفح توثيق الموقع العام.
2. يعرض الفهرس العام المساحات النشطة المحددة للظهور على الموقع وصفحاتها المنشورة فقط.
3. انقر زر HELP السياقي في صفحة لوحة التحكم للحصول على إرشاد داخلي خاص بالمسار عند وجود تعيين.
4. تعيد HELP التحقق من تفويض الصفحة المستهدفة؛ فتعيد ممنوع أو غير موجود بدلاً من كشف صفحة غير مصرح بها أو غير معينة.

تبديل اللغة

يحترم عارض التوثيق إعداد لغتك الحالية. استخدم تبديل اللغة للتنقل بين الإصدارات العربية والإنجليزية لأي صفحة.

ما يشمله التوثيق

تتضمن وثائق Survanta إرشادات حول:

• مدير المنصة: إدارة المؤسسات والمستخدمين والخطط والفوترة والتكاملات والموقع.
• مدير المؤسسة: إدارة المستخدمين والصلاحيات والتخزين وطلبات الفوترة وعملاء التكامل.
• API الجوال: كيفية مصادقة الباحثين والمستخدمين عبر الجوال وإكمال الاستبيانات.
• مستخدم الموقع: كيفية التسجيل وإدارة الطلبات واستخدام منشئ الخطة المخصصة.
• الأمان: نموذج الصلاحيات وعزل المؤسسة والتوكنات وسلامة الملفات.
• الفوترة: الخطط والفواتير وإدارة الاشتراك وطلبات زيادة الحدود.
• الأسئلة الشائعة: الأسئلة الشائعة مجمّعة حسب نوع المستخدم.

التوثيق الداخلي فقط

المساحات الداخلية، وبخاصة dashboard-help، ليست من محتوى التوثيق العام. تقرأ HELP السياقية صفحتها الداخلية المعينة دون اشتراط النشر، لكنها لا تزال تتطلب هوية لوحة تحكم وتفويضاً معكوساً للهدف. يؤدي غياب التعيين إلى عدم عرض زر HELP؛ وظهور الزر ليس بحد ذاته ضابط تفويض.

التغذية الراجعة

إذا وجدت توثيقاً غير واضح أو تنقصه المعلومات، تواصل مع مدير المنصة لطلب تحديث. تُدار صفحات التوثيق من قِبل مديري المنصة من قسم إدارة التوثيق على جانب المنصة.