فرص المساهمة في التوثيق

تُعد وثائق Discourse الموقع الرئيسي الذي يمكن للمسؤولين والمشرفين والمستخدمين ومديري الأنظمة (Sysadmins) من خلاله العثور على المساعدة في استخدام Discourse وإدارة مواقعهم.

على الرغم من أن هذه الوثائق شاملة وتغطي جوانب واسعة، إلا أن هناك بعض المجالات الناقصة التي لم يتم توثيقها بعد. وهذا يمثل فرصة رائعة للمجتمع للمشاركة في المساعدة على صقل هذا الجزء المهم من مشروع Discourse.

نود أن نرى المزيد من الأشخاص يشاركون في إنشاء محتوى توثيقي لـ Discourse، ونرغب في جعل هذه العملية سهلة قدر الإمكان لأي شخص. لذلك، فيما يلي قائمة بميزات Discourse أو حالات الاستخدام التي حددناها على أنها تتطلب توثيقًا جديدًا أو محسّنًا.

:notebook_with_decorative_cover: مواقع الوثائق

يمكن لأي شخص يحمل مستوى ثقة 2 أو أعلى إنشاء مواضيع توثيقية جديدة في قسم Wiki - وهو المنزل لجميع محتوى التوثيق الذي يساهم به المجتمع. إذا تم اعتبار موضوع في ويكي المجتمع ذا صلة أو أهمية، فقد يتم نقله إلى قسم Documentation - وهو المنزل لجميع وثائق Discourse الرسمية. يمكنك قراءة سياسة التوثيق لمزيد من التفاصيل حول ذلك.

:gift: شارات لمساهمي التوثيق

سيتم تعيين الشارة البرونزية “Scribe” تلقائيًا لأي شخص ينشئ موضوعًا جديدًا في فئة Wiki

إذا تم اعتبار الموضوع ذا قيمة كافية لنقله إلى فئة التوثيق الرسمية #documentation، فسيقوم شخص ما من فريق Discourse بذلك يدويًا، وسيُنسب الفضل إلى المؤلف الأصلي في محتوى الموضوع، وسينسب لهم الشارة الفضية “Ghostwriter”:

:eyes: التوثيق الذي يحتاج إلى الكتابة

على الرغم من أننا نريد في النهاية رؤية كل جزء من Discourse موثقًا بشكل شامل، إلا أن هذه هي المجالات التي حددنا أنها الأكثر إلحاحًا من حيث الحاجة (تشير العناصر التي تم شطبها إلى مواضيع تمت كتابتها منذ نشر هذا المنشور لأول مرة):

  • درس عام للبدء السريع للمسؤولين
  • إعادة توجيه المواضيع المخصصة
  • شرح لما يمكن أن تفعله مستويات المستخدمين المختلفة
  • خيارات تسجيل الدخول عبر وسائل التواصل الاجتماعي
  • إشعارات المنشورات (الوثائق الرسمية)
  • مزيد من التوثيق حول كيفية عمل مستويات الثقة
  • كيفية كتابة طلب ميزة جيد لـ Discourse (موضوع ويكي)
  • مرجع لكيفية ظهور ميزات Markdown والتنسيق الخاصة بـ Discourse عند تضمينها في رسائل البريد الإلكتروني
  • حالات المستخدمين (موضوع ويكي)
  • شرح للوضع الداكن، وكيفية اختياره، وكيفية تمكين التبديل (موضوع ويكي)
  • توثيق عام يغطي إدارة تفضيلات المستخدمين (موضوع ويكي)
  • وثائق تشرح كيفية عمل الفئات والتسلسل الهرمي في Discourse
  • دليل عام لإعدادات المواضيع
  • دليل عام حول الإضافات - ماهيتها، وكيفية عملها، وكيفية استخدامها
  • صفحات رئيسية مخصصة
  • تغيير الفئات والمواضيع الافتراضية
  • استخدام شبكات الصور في المنشورات (موضوع ويكي)
  • إعدادات موافقة المنشورات (موضوع ويكي)

قد يتطلب بعضها مواضيع متعددة لتوثيقها بشكل فعال.

:pencil2: كيفية كتابة التوثيق

من أجل ضمان فعالية وثائق Discourse إلى أقصى حد، لدينا دليل أسلوب لكيفية كتابة هذا المحتوى. بينما سيكون من المفيد للجميع اتباع الدليل، إذا كنت تساهم في #wiki، فلا مشكلة إذا لم تلتزم به تمامًا. سيتم تحديث أي مواضيع يتم نقلها إلى Documentation بواسطة موظفي Discourse لتتوافق مع دليل الأسلوب حسب الحاجة.

:bulb: مهتم؟

انضم إلى Wiki وابدأ في التوثيق اليوم. إذا كنت ترغب في مناقشة أي من هذا، فلا تتردد في الرد على هذا الموضوع للتحدث عنه.

12 إعجابًا

ماذا عن المواضيع الموجودة؟ مثل على سبيل المثال

4 إعجابات

الوثائق الحالية تتحدث عن كيفية طلب ميزات جديدة، ولكن ليس عن كيفية تنسيق طلب جيد لجعله أكثر فعالية. حاليًا، نربط بـ هذه الصفحة، ولكن سيكون من الجيد لو كان لدينا هذا النوع من المحتوى على Meta بدلاً من ذلك.

ملاحظة جيدة! سأقوم بإزالة ذلك من القائمة في هذا الموضوع :slight_smile:

3 إعجابات

يوجد هذا الموضوع الذي يغطي طلبات الميزات بالفعل

ما لم يكن بحاجة إلى أن يبدو مثل هذا ولكن لطلب ميزة؟ :point_down: :eyes:

4 إعجابات

هل هذا يعني إشعار الموظفين أم شيء مختلف؟

إعجاب واحد (1)

أفترض أن هذه ملاحظة نشر لأنها في العنوان

ملاحظات الموظفين هي نفسها تقريبًا على ما أعتقد؟

3 إعجابات

نعم هذا ما نبحث عنه هناك :slight_smile:

كما أشار @ondrej، فإن إشعارات المشاركات هي ما هو موضح في هذا الإعلان. لدينا موضوع الإعلان هذا، ولكن ليس لدينا وثائق فعلية عنه.

4 إعجابات

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

  • قوالب منتديات الدعم
  • قوالب منصات التعلم

يمكن لهذه المواضيع أن تستضيف بواسطة ديسكورس، كوميونيكي (؟) إلخ. مع المكونات الإضافية الموصى بها ومكونات الثيم وما إلى ذلك. بالإضافة إلى منشور للاستضافة الذاتية.
ستركز القوالب المستضافة على المكونات الإضافية وتشير إلى الخطط المطلوبة لمكون إضافي معين للاستخدام.
مع النصائح والحيل وحتى توجيه الأشخاص إلى Marketplace إذا احتاجوا إلى تخطيط مخصص، أو مكون إضافي، إلخ.

3 إعجابات

تم الإنشاء:

7 إعجابات

رأيت ذلك :ابتسامة: من الرائع رؤية هذه الأشياء قادمة!

8 إعجابات

أعمل على وضع الظلام.

5 إعجابات

تم إنشاء هذه الأدلة بالفعل ولكن لم يتم التحقق منها بعد:

هذه الصفحة ضبابية بعض الشيء. هل تشير إلى محتوى الصفحة الرئيسية المخصص؟ إذا كان الأمر كذلك، فربما Add custom content that only appears on your homepage. بخلاف ذلك… لم تتم كتابتها بعد.

إعجابَين (2)

شكرًا على التواصل مرة أخرى هنا - لقد قمت بتحديث OP بهذه الروابط.

[اقتباس=“NateDhaliwal، مشاركة:22، موضوع:326614”]
هذه الصورة غير واضحة بعض الشيء. هل تشير إلى محتوى الصفحة الرئيسية المخصصة؟

[/اقتباس]

هذه مسألة نيتشية نسبياً وتشير إلى إنشاء صفحة رئيسية مخصصة، لذلك فهي ليست شيئًا يستخدمه معظم مسؤولي Discourse. إنها ليست ميزة أساسية، لأنها ليست مكتملة تمامًا في هذه المرحلة.

إعجابَين (2)