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