اکثر اوقات هنگامی که با یک خطا یا مشکل مواجه می شوید برای حل کردن مشکل خود به انجمن ها یا سایت های (Q&A) پرس و پاسخ مراجعه می کنید تا کاربران آن ها بتوانند به حل مشکل شما کمک کنند. به همین جهت در این مقاله نحوه صحیح بیان کردن سوال و گزارش خطا را بررسی خواهیم کرد.

تحقیق و جستجو

قبل از این که سوال خود را در انجمن مطرح کنید ، به تحقیق و جستجو بپردازید.

جستجو: این امکان وجود دارد که کاربر دیگری سوالی شبیه به سوال شما را مطرح کرده باشد و جواب آن سوال می تواند مشکل شما را حل کند.

تحقیق: برای مطرح کرد یک سوال خوب باید بدانیم که چه چیزی را باید برای کاربران شرح دهیم تا بتوانند سریع تر مشکل شما را حل کنند.

عنوان مختصری که مشکل را مشخص کند

عنوان یک سوال اولین چیزی است که کاربران آن را مشاهده می کنند و اگر عنوان شما مناسب نباشید به آن مراجعه نمی کنند.

نکاتی که در نوشتن عنوان  باید رعایت کنید:

1) املا صحیح و نقطه گذاری

2) ننوشتن جملات انگلیسی به فارسی

3)مختصر و مفید

مثالی از عنوان ها:

نادرست: مشکل در برنامه

درست: چه فرقی بین دو شی List و Ilist وجود دارد؟

نادرست: کارنکردن کلید ارسال

درست: چگونه میتوان به ASP.NET Core مهاجرت کرد؟

نادرست: کار با JSON در سی شارپ

درست: نحوه برقراری رابطه چند به چند در Entity Framework 

متن سوال

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

گزارش خطا

هنگام وقوع خطا باید جزئییات آن را به اشتراک بگذارید، این جزئییات شامل، پیام خطا، Stack Trace و نسخه ابزاری که از آن استفاده می کنیم. 

به عنوان مثال زمانی که کد های شما یک Exception صادر می کند، میتوان در پنجره ای که نرم افزار به شما نشان می دهد جزئییات زیادی از خطا را دریافت کنید.

چند نکته حائز اهمیت

1) نسخه IDE یا نرم افزار، به عنوان مثال : (Visaul Studio 2017 (15.3

2)نسخه فریم ورک، به عنوان مثال: Entity Framework 6.1.2, Automaper 5.0.1

3)نسخه سیستم عامل، Windows 10 , Ubuntu 16.04

علت مهم بودن شماره نسخه 

این امکان وجود دارد که در نسخه های بعدی آن نرم افزار یا فریم ورک مشکل مطرح شده توسط شما رفع شده باشد، اصولا در پروژه ها Open Source با ایجاد یک Issues میتوان مشکل خود را در مخزن آن بیان کنید تا توسعه دهندگان آن را رفع کنند.

نکات پایانی

 پس از این که سوال خود را وارد کردید یک بار آن را مرور کرده تا غلط املایی در آن وجود نداشته باشد. امیدوارم مقاله برای شما مفید واقع شده باشد، لطف نظر خود را در رابط با این موضوع بیان کنید.

 برای مطالعه بیشتر میتوان از لینک های زیر استفاده کنید:

1) ?How do I ask a good question

2) ?How to Ask Good Coding Questions That Get Great Answers

3) ?How to Ask Programming Questions