پیام های خطای عملی بنویسید

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

وقتی کاربری با برنامه چت گوگل تعامل دارد، مواجهه با پیام‌های خطا می‌تواند تجربه‌ای ناامیدکننده باشد، به‌ویژه اگر خطا قابل پیگیری نباشد. برای مثال، پیام خطای « An error occurred » مفید نیست زیرا پیام توضیح نمی‌دهد که چه مشکلی پیش آمده، چگونه کاربر می‌تواند مشکل را برطرف کند یا چگونه می‌تواند کمک دریافت کند. این صفحه نحوه ساختاردهی پیام‌های خطا را به گونه‌ای شرح می‌دهد که با نشان دادن مثال‌های قابل پیگیری و غیرقابل پیگیری، برای کاربران مفید باشند.

ساختار پیام خطا

یک پیام خطای قابل پیگیری دارای ساختار زیر است:

• چه مشکلی پیش آمده است. بیان اینکه چرا برنامه چت نمی‌تواند درخواست را تکمیل کند، به کاربر کمک می‌کند تا مشکل را حل کند. توضیح اینکه چرا یک خطا رخ داده است، اعتماد ایجاد می‌کند.
• چگونه کاربر می‌تواند به سمت هدف خود پیش برود. فقط گفتن اینکه چه مشکلی پیش آمده کافی نیست. به کاربران بگویید که چگونه می‌توانند از خطا عبور کرده و به هدف خود برسند.
• چگونه کمک بگیریم. اگر کاربر هنوز گیر کرده است، به او بگویید که چگونه می‌تواند کمک بیشتری دریافت کند. این می‌تواند یک دستور /help یا پیوندی به مستندات برنامه چت شما باشد.

پیام خطای نمونه: قالب تاریخ نادرست

در این مثال، کاربر تاریخی را با فرمتی وارد کرده است که برنامه چت انتظار آن را نداشته است. آنها November 19, 2021 نوشته‌اند، اما برنامه چت انتظار دارد 2021-11-19 .

در اینجا یک نسخه قابل اجرا و یک نسخه غیرقابل اجرا از پیام خطایی که برنامه چت با آن پاسخ می‌دهد، آورده شده است:

خطای قابل پیگیری

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

I don't recognize the date format you entered. Write dates as `yyyy-mm-dd`; for example, `2000-01-31`. For help, type `/help`.

این پیام خطا به دلایل زیر قابل پیگیری است:

• می‌گوید چه مشکلی پیش آمده است. برنامه چت فرمت تاریخ را تشخیص نمی‌دهد.
• نحوه رفع خطا را با بیان قالب تاریخ مورد انتظار به کاربر توضیح می‌دهد و یک تاریخ نمونه ارائه می‌دهد که به افراد کمک می‌کند بفهمند چه چیزی بنویسند.
• با دستور /help slash کمک بیشتری ارائه می‌دهد. اگر کاربران هنوز در جایی گیر کرده‌اند، می‌دانند چگونه اطلاعات بیشتری کسب کنند.

خطای غیرفعال

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

Enter the correct date format.

این پیام خطا به دلایل زیر غیرفعال است:

• نمی‌گوید که آیا جلسه را برنامه‌ریزی کرده است یا خیر. کاربر ممکن است در مورد تغییر زمان جلسه مردد باشد، یا ممکن است فرض کند که جلسه برنامه‌ریزی شده است.
• به کاربر نمی‌گوید که چگونه تاریخ را قالب‌بندی کند. به جای اینکه فرض کند کاربران می‌دانند چگونه تاریخ را قالب‌بندی کنند، باید بگوید که انتظار قالب تاریخ yyyy-mm-dd را دارد.
• کمک بیشتری ارائه نمی‌دهد. وقتی کاربران گیر می‌کنند و نمی‌دانند چگونه ادامه دهند، ممکن است ارسال پیام در برنامه چت را متوقف کنند.

امتحانش کن.

حالا که می‌دانید چگونه خطاهای قابل پیگیری بنویسید، آیا می‌توانید در سناریوی زیر تشخیص دهید که کدام یک از این خطاها قابل پیگیری هستند:

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