الخطوات التالية لتحسين وثائقنا

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

نهدف إلى أن تندرج جميع الوثائق تحت إحدى الفئات التالية:

  • #documentation:users - الاستخدام العام الشائع
  • #documentation:moderators - الإشراف على مجتمع
  • #documentation:theme-developers - تطوير السمات ومكونات السمات
  • #documentation:admins - إدارة موقع Discourse
  • #documentation:devs - تطوير ميزات Discourse أو الإضافات أو التكاملات
  • #documentation:sysadmin - إدارة النظام المستضاف ذاتيًا

نخطط لإزالة #documentation:faq و #documentation:tips-and-tricks في نهاية هذا (لكننا بدأنا في وضع علامات على بعض الموضوعات في الفئات الجديدة بعلامة #tips-and-tricks).

نهدف أيضًا إلى وضع علامات على الوثائق بإحدى هذه العلامات التصنيفية المستعارة من divio وفقًا لهذا المنشور السابق:

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

بعض التغييرات الشائعة التي أجريناها على الموضوعات الفردية حتى الآن (لقد أنجزنا حوالي 50٪ الآن).

  • نقل الأشياء من #documentation:admins إلى #documentation:sysadmin عندما تتطلب الوصول إلى وحدة التحكم.
  • تقسيم موضوعات #documentation:faq إلى موضوعات لـ #documentation:admins وموضوعات لـ #documentation:users.
  • نقل الموضوعات من #documentation:devs إلى #documentation:theme-developers عندما تكون خاصة بتطوير السمات أو مكونات السمات.
  • تحديث عناوين الموضوعات لتكون أكثر اتساقًا
    • استخدام صيغة الأمر لعناوين الموضوعات (وإزالة “كيفية” من العنوان).
    • استخدام أحرف العاصمة العادية للجمل
  • تنسيق المحتوى بعناوين تبدأ من H2
    (ذات صلة: لقد قمنا أيضًا بتمكين جدول المحتويات لجميع موضوعات الوثائق)

في بعض الحالات، نجري بعض التغييرات على المحتوى نفسه، لكن التعمق ليس هدفنا الفوري. في مرحلة لاحقة، نود القيام بأشياء مثل:

  • دمج المحتوى من الردود في الوثائق نفسها
  • حذف جميع الردود
  • تكوين الموضوعات لحذف الردود بعد شهر أو شهرين

بعد ذلك، سنقدم إرشادات محدثة حول المساهمة في وثائق جديدة والحفاظ على الوثائق الحالية وتحديث الموضوعات التالية:

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


نعتقد أيضًا أنه قد تكون هناك فرصة هنا لإنشاء مساحة منفصلة للأشخاص للقيام بالمزيد من “العرض والتقديم” على غرار بعض المحتوى الذي كان #documentation:tips-and-tricks. قد يتيح إنشاء مساحة للموضوعات مثل هذه خارج الوثائق مجالًا أكبر لإجراء مناقشات حولها بين الأقران. ولكن على غرار ما نفعله الآن مع الوثائق، ربما يكون من المفيد وجود مساحات منفصلة لمسؤولي النظام والمديرين والمطورين لهذه المناقشات. ما رأيك؟

14 إعجابًا

ملاحظة سريعة فقط بأن المرور الكامل لإعادة تصنيف المواد في Documentation وفقًا للخطة المذكورة أعلاه قد اكتمل الآن.

إذا كانت لديك أي ملاحظات أو أسئلة حول ما تم إنجازه حتى الآن، فلا تتردد في مشاركتها هنا.

ليس لدينا أي خطوات تالية فورية مخطط لها بخلاف ذلك بعد، ولكننا نستكشف بعض الأفكار.

5 إعجابات