Mehrdad Esmaeilpour
Mehrdad Esmaeilpour
خواندن ۳ دقیقه·۴ سال پیش

گزارش باگ: آسان‌تر و تمیزتر

گزارش باگ
گزارش باگ


پیدا کردن باگ تو نرم افزار خیلی مهمه اما مهم‌تر از اون سندی هست که بشه از اون برای رفع باگ استفاده کرد. ایجاد ارتباط بین زبان پشتیبان‌های نرم‌افزار و توسعه‌دهندگان معمولا با تجربه‌های ناموفق همراهه. نتیجه؟ باگ‌های مشابهی که مدام به شکل‌های متفاوت گزارش می‌شن و هیچ‌کس تمایلی برای رفع‌شون نداره و اگه تمایل هم داشته باشه نمی‌تونه کاری واسش انجام بده. در نهایت یه نرم‌افزار باقی می‌مونه و کلی پنجره شکسته که همه به وجودشون عادت می‌کنن اما باید راه بهتری وجود داشته باشه. پیدا کردن زبان مشترک نباید اون‌قدرها هم سخت باشه.

گزارش درست باگ به توسعه‌دهنده کمک می‌کنه نقطه شروعی برای پیدا کردن ریشه مشکل داشته باشه و توی دریایی از احتمالات غرق نشه. حالا سوال اینجاست آیا گزارش‌های طولانی با جزییات زیاد موثرترن یا گزارش‌های کوتاه با نکات کلیدی؟ برای گزارش‌نویسی اصل معروف KISS (Keep it simple, stupid) رو بخاطر داشته باشید.

یادتون باشه تو گزارش باگ فقط یک هدف وجود داره و اونم اینه که شما یه باگ پیدا کردید و حالا باید اون رو تو یه بسته‌بندی قابل قبول ارائه بدید. این بسته بندی چه ویژگی‌هایی داره؟ فکر کنید گزارش باگ مثل یک توییت‌ه.

کوتاه، کامل و هدفمند باشید

گزارش باگ نباید همزمان به بیشتر یه مشکل اختصاص پیدا کنه. اگه بیشتر از یه مشکل وجود داره باید به ازای هر کدوم گزارش جداگانه‌ای ارائه بشه.

ویژگی‌های گزارش باگ

عنوان

عنوان باگ باید توضیح مختصری درباره محتوای باگ بده. به عنوان یه نکته کلیدی بهتره عنوان رو بعد از تکمیل گزارش بازبینی و احتمالا تغییرش بدید.

محیط نرم‌افزار

محیط هر نرم‌افزار می‌تونه بسته به جنس نرم‌افزار متنوع باشه. در مورد محیط تا جایی که می‌تونید جزییات رو بگین. بعضی از ویژگی‌های محیط که به صورت عمومی می‌تونن اطلاعات خوبی در اختیار توسعه دهنده بذارن اینا هستن. این ویژگی‌ها می‌تونن بیشتر یا کمتر از این‌ها هم باشن.

  • دستگاه: شامل سخت افزار و مدل
  • سیستم‌عامل: نوع و ورژن سیستم‌عامل
  • ورژن نرم‌افزار: اگه نسخه‌های متفاوتی از نرم‌افزار وجود داره لازمه که ببینید آیا باگ تو ورژن‌های جدیدتر رفع شده یا نه.
  • نرخ وقوع مجدد: احتمال دوباره اتفاق افتادن باگ چقدره؟ نسبت اتفاق افتادن باگ به تعداد تست‌ها رو به دست بیارین.

گام‌های بازتولید

چه گام‌هایی برای بازتولید باگ تو نرم‌افزار مورد نیازه. این بخش از گزارش اهمیت زیادی داره و خطای محیط یا کاربر رو از باگ تفکیک می‌کنه. گام‌های بازتولید باید هدفمند در خصوص باگ باشن. مثلا اگه باگی بعد از لاگین کردن کاربر و تو بخش گزارش‌گیری اتفاق میفته نیازی نیست یکی از گام‌ها لاگین کردن به نرم‌افزار باشه. گام‌های بازتولید رو بعد از ثبت دوباره خودتون مرحله به مرحله اجرا کنید و از درست‌ بودن‌شون مطمئن بشید.

نتیجه مورد انتظار

وقتی گام‌های بازتولید اجرا می‌شن انتظار داریم نرم‌افزار چه عملکردی داشته باشه؟

نتیجه به دست آمده

نتیجه گام‌های بازتولید چی هست؟ آیا نرم‌افزار متوقف شده؟ آیا اتفاقی نیفتاده یا چیزی خلاف اون‌چه انتظار داشتیم به وجود اومده؟ تو این مرحله باید از کلی‌گویی پرهیز کنیم. هرچه دقیق‌تر و هدفمندتر بهتر.

مدرک تصویری

آیا امکان تهیه اسکرین‌شات، متن خطا، لاگ و یا هر مدرک دیگه‌ای که بشه اون رو به گزارش پیوست کرد وجود داره؟ اگه آره حتما از مدارک تصویری استفاده کنید.

اولویت

اولویتی که برای رفع این باگ وجود داره چقدره؟ باگ‌هایی که باعث اختلال تو عملکرد کلی سیستم میشن باید به سرعت رفع بشن و اولویت بالایی دارن. باگ‌هایی که باعث بد شدن تجربه‌کاربری می‌شن اما بدون رفع اون‌ها عملکرد کلی سیستم زیرسوال نمیره اولویت متوسط دارن و بقیه باگ‌ها اولویتشون پایین هست.


تست نرم افزارگزارش باگباگ نرم افزاربرنامه نویسیمهندسی نرم افزار
مهندس نرم افزار، نویسنده، شاعر و خیال پرداز
شاید از این پست‌ها خوشتان بیاید