كتابة توثيق فعال لـ Discourse

أهلاً سيمون! :blob_wave:

كنت سأرى كيف سيسير الأمر، ولكن نعم أنا على نفس المنوال، أحاول تجنب الاختصارات.

هاهاها، نعم… لن أستخدم أيًا من هذه الكلمات في المستندات، لئلا أكشف عن :face_with_monocle:.

بالتأكيد: Example Domains

هذه هي النقطة التي جئت لمناقشتها! :smiley:

لقد كان لدينا الكثير من النقاش حول هذا الأمر، وكنت سعيدًا برؤية هذا مدرجًا في دليل الأسلوب افتراضيًا.

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

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

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

أيضًا، إذا أنتجنا وثائق خارج Discourse (تكامل أو إنتاج من تعليقات الكود أو أي شيء آخر)، فإن وجود “مستخدم وثائق” من المحتمل أن يكون أسهل كتفصيل تنفيذي. :thinking:

لا أعتقد أن هذا الدليل سيمنع الناس من إدخال صوتهم وشخصيتهم، واستضافة المناقشة. ولكن سيكون من الرائع إذا ساعد المزيد من الأشخاص على ممارسة التوثيق، الذين لولا ذلك لما فعلوا (ومن ثم يمكننا دفعهم ليكونوا أكثر شخصية!) :smiley:

3 إعجابات