Lorawan-stack: قالب العدد للأسئلة

لذا فإن "الإجراء" هو أننا نقوم بتحديث الوثائق مباشرة (إذا كان هذا هو التغيير الوحيد) بالإشارة إلى هذه المشكلة وفتح واحدة أخرى إذا أدى ذلك إلى إصلاح الأخطاء / طلب الميزة؟

بالضبط. يجب أن تكون نتيجة مشكلة "السؤال" عادةً تغييرًا في وثائقنا ، أو إضافة إلى الأسئلة الشائعة.

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

توافق ولكن هذا يجب أن ينطبق أيضًا على المنتدى و Slack.

في الأساس ، يجب أن تكون جميع المعلومات في وثائق الريبو ، إذا كانت بعض المعلومات مرجعية في المنتدى أو المشكلات أو فترة الركود ، فعندئذٍ فشلنا في عمل وثائق.
سؤال أو قضية أثيرت في Slack ، يجب على المنتدى تعويض التغيير في المستند ما لم يتم بذل أي جهد للبحث عن المعلومات.

بدلاً من وجود قائمة "هل بحثت هناك" ، أود إضافة رابط إلى استعلام على github / doc (بمجرد أن يكون البحث ضمنيًا). قد يكون البحث عن معلومات في مشكلات github مملاً ولا يجب أن يحتوي المنتدى على معلومات / شرح لا يحتويه المستند. سيساعدك الارتباط باستعلام تم إنشاؤه بالفعل (مثل البحث عن الأخطاء). يمكن أيضًا تصور إضافة قسم معرفة الأخطاء إلى المستندات.

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

أوافق تمامًا على أنه يجب علينا مراقبة المنتدى و Slack بشكل أفضل وتحويل الأسئلة (الجيدة) إلى تحسينات في التوثيق (على الأقل لفئة v3 وقناة lorawan-stack ). Sypheos كيف ترى هذا العمل في الممارسة؟

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

انا اعتقد انها فكرة جيدة. دعنا نحافظ على نطاق هذه المشكلة ونموذج الإصدار سؤالًا جديدًا حقًا.

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

لقالب السؤال imo:
ما الذي تبحث عنه / لتفعله؟
اين نظرت
_إضافة أي صفحة ويب ، أو مشكلات ، أو استعلام جديد عن Github ، أو المستندات ، أو المنتدى مرحب به _
لماذا لم تكن مرضية؟
_404 غير موجود هو إجابة شرعية.

التسمية: سؤال

إذا لم تكن هناك موارد للإجابة على السؤال ، فافتح مشكلة "طلب توثيق".

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

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

باختصار ، دعنا نفكر في ؛

• عدم السماح بالأسئلة على الإطلاق ، فقط مشكلات "طلب التوثيق". لا تزال الأسئلة صالحة ، ولكن فقط إذا لم يتم توثيقها بالفعل وإلا فلن يكون طلب توثيق صالحًا وقمنا بإغلاقه
• قم بتوجيه الأسئلة إلى المستندات (عندما تكون لدينا) والمنتديات

طلب التوثيق هو في الواقع "أسئلة" لأنهم كانوا يبحثون عن شيء لكن لم يتمكنوا من العثور عليه. في البداية لديهم سؤال يحتاج إلى إجابة.
للذهاب في هذا الاتجاه سيكون من المنطقي رفض أي طلب توثيق وأسئلة عبر مشكلات على github.

إذا أراد شخص ما طرح سؤال ، فسيذهب إلى Slack أو المنتدى حيث يمكن لشخص ما للفريق الأساسي أو المشرف أن يحول سؤاله في مشكلة توثيق العلاقات العامة / الخطأ / مشكلة طلب الميزة.

القرار: سنذهب مع https://github.com/TheThingsNetwork/lorawan-stack/issues/890#issuecomment -507324845. قالب الأسئلة الذي يوجه إلى المنتدى ، ونموذج طلب التوثيق