این صفحه بهترین روش‌ها را برای نوشتن پیام‌های خطای عملی توضیح می‌دهد که به کاربر می‌گوید چگونه مشکل را برطرف کند تا بتواند هدف خود را تکمیل کند.
هنگامی که کاربر در حال تعامل با برنامه Google Chat است، مواجه شدن با پیام‌های خطا می‌تواند تجربه ناامیدکننده‌ای باشد، زمانی که خطا قابل اجرا نباشد. به‌عنوان مثال، پیام خطا، An error occurred مفید نیست، زیرا پیام توضیح نمی‌دهد که چه مشکلی رخ داده است، چگونه کاربر می‌تواند مشکل را برطرف کند یا چگونه کاربر می‌تواند کمک دریافت کند. این صفحه نحوه ساختاربندی پیام‌های خطا را توضیح می‌دهد تا با نمایش نمونه‌های عملی و غیرقابل اجرا برای کاربران مفید باشند.
ساختار پیام خطا
یک پیام خطای عملی ساختار زیر را دارد:
- چه چیزی اشتباه پیش رفت. گفتن اینکه چرا برنامه چت نمی تواند یک درخواست را تکمیل کند به کاربر کمک می کند مشکل را حل کند. توضیح اینکه چرا یک خطا رخ داده است باعث ایجاد اعتماد می شود.
- چگونه کاربر می تواند به سمت هدف خود پیش برود. گفتن اینکه چه اشتباهی رخ داده است، هرگز کافی نیست. به کاربران بگویید چگونه می توانند از خطا عبور کرده و هدف خود را تکمیل کنند.
- چگونه می توان کمک گرفت. اگر کاربر همچنان گیر کرده است، به او بگویید چگونه می تواند کمک بیشتری دریافت کند. این می تواند یک فرمان
/helpیا پیوندی به اسناد برنامه چت شما باشد.
پیام خطای مثال: فرمت تاریخ نادرست
در این مثال، کاربر تاریخی را در قالبی وارد کرد که برنامه چت انتظارش را نداشت. آنها November 19, 2021 نوشتند، اما برنامه Chat انتظار دارد 2021-11-19 .
در اینجا یک نسخه قابل اجرا و غیرقابل عمل از پیام خطا است که برنامه Chat با آن پاسخ می دهد:
خطای عملی
کاربر از برنامه چت می خواهد تا جلسه ای را با شخص دیگری برنامه ریزی کند. برنامه چت با یک پیام خطای خوب و قابل اجرا پاسخ می دهد:
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کمک بیشتری ارائه می دهد. اگر کاربران هنوز گیر کرده باشند، می دانند چگونه بیشتر بیاموزند.
خطای غیرقابل عمل
کاربر از برنامه چت می خواهد تا جلسه ای را با شخص دیگری برنامه ریزی کند. برنامه چت با یک پیام خطای غیرمفید و غیرقابل عمل پاسخ می دهد:
Enter the correct date format.
این پیغام خطا به دلایل زیر غیر فعال است:
- نمی گوید که آیا این جلسه را برنامه ریزی کرده است. کاربر ممکن است در برنامه ریزی مجدد جلسه مردد باشد، یا ممکن است تصور کند که جلسه برنامه ریزی شده است.
- به کاربر نمی گوید که چگونه تاریخ را قالب بندی کند. به جای اینکه فرض کنیم کاربران می دانند چگونه تاریخ را قالب بندی کنند، باید بگوییم که انتظار فرمت تاریخ
yyyy-mm-ddدارد. - کمک بیشتری ارائه نمی دهد. وقتی کاربران گیر کرده‌اند و نمی‌دانند چگونه ادامه دهند، ممکن است پیام‌رسانی به برنامه چت را متوقف کنند.
آن را امتحان کنید
اکنون که می دانید چگونه خطاهای قابل اجرا را بنویسید، می توانید در سناریوی زیر تشخیص دهید که کدام یک از این خطاها قابل اجرا هستند:
هنگامی که کاربران با برنامه schedule کلمات کلیدی به برنامه چت پیام می دهند، یک برنامه چت رویدادهای تقویم را ایجاد می کند. برای ایجاد یک رویداد تقویم، برنامه Chat به احراز هویت کاربر نیاز دارد. اگر کاربری احراز هویت نشده باشد، برنامه چت با یک پیام خطا پاسخ می‌دهد.
/signin وارد شوید. برای کسب اطلاعات بیشتر، /help را تایپ کنید.- چه چیزی اشتباه پیش رفت. برنامه چت به احراز هویت نیاز دارد.
- چگونه ادامه دهیم. برای احراز هویت،
/signinتایپ کنید. - چگونه می توان کمک گرفت. اگر کاربر اطلاعات بیشتری می خواهد، می تواند
/helpتایپ کند.