DSE 1.0.1
README مركز المساعدة
مرحبًا بك في مركز المساعدة الخاص بـ DSE. يشرح هذا الموضوع كيفية تنظيم نظام المساعدة الداخلي المعتمد على Markdown وكيفية إضافة/تحديث ملفات المساعدة المترجمة.
ما هو نظام المساعدة هذا
يقوم DSE بتحميل موضوعات المساعدة من ملفات Markdown الموجودة داخل مجلد Help بجانب التطبيق. لكل لغة مجلد خاص بها، ويستخدم كل موضوع اسم الملف نفسه عبر جميع اللغات.
- مثال مجلد:
Help/ar - مثال ملف موضوع:
help.quickstart.md
مجلدات اللغات المدعومة (في المشروع الحالي)
en— الإنجليزيةes— الإسبانيةfr— الفرنسيةru— الروسيةar— العربيةzh-Hans— الصينية (المبسطة)
سلوك الرجوع الاحتياطي (Fallback)
عندما لا توجد نسخة مطابقة للغة واجهة المستخدم الحالية، يحاول DSE بالترتيب التالي:
- مجلد الثقافة الكامل (مثل
fr-CAإذا كان موجودًا) - مجلد اللغة ذي الحرفين (
fr) - الإنجليزية (
en)
كيفية إضافة أو تحديث موضوع
- أنشئ/حدّث الملف الإنجليزي أولًا (مثل
Help/en/help.readme.md) - أضف نفس اسم الملف إلى مجلدات اللغات الأخرى
- ترجم المحتوى مع الحفاظ على نفس بنية Markdown
- إذا كان موضوعًا جديدًا ظاهرًا، أضف معرّفه إلى
HelpCenterViewModel._topicIds - أعد بناء التطبيق واختبر مركز المساعدة
إرشادات الكتابة
- ابدأ بعنوان
#(يُستخدم كعنوان الموضوع في القائمة) - اجعل الأقسام قصيرة وعملية
- استخدم القوائم النقطية للخطوات
- استخدم أسماء ومسارات ثابتة حتى تظل الترجمات متطابقة
نصيحة
يمكنك فتح مجلد المساعدة مباشرة من مركز المساعدة باستخدام زر Open Folder ثم تعديل ملفات Markdown وإعادة بناء التطبيق.