หน้านี้อธิบายแนวทางปฏิบัติแนะนำในการเขียนข้อความแสดงข้อผิดพลาดที่นำไปใช้ได้จริงซึ่งจะบอกวิธีแก้ไขปัญหาให้ผู้ใช้ทราบเพื่อให้บรรลุเป้าหมายได้
เมื่อผู้ใช้กำลังโต้ตอบกับแอป Google Chat การพบข้อความแสดงข้อผิดพลาดอาจเป็นประสบการณ์ที่น่าหงุดหงิดเมื่อแก้ไขไม่ได้
เช่น ข้อความแสดงข้อผิดพลาด "An error occurred" ไม่เป็นประโยชน์เนื่องจากข้อความไม่ได้อธิบายว่าเกิดข้อผิดพลาดใดขึ้น ผู้ใช้แก้ไขปัญหาได้อย่างไร หรือผู้ใช้สามารถขอรับความช่วยเหลือได้อย่างไร หน้านี้จะอธิบายวิธีจัดโครงสร้างข้อความแสดงข้อผิดพลาดเพื่อให้มีประโยชน์ต่อผู้ใช้ โดยแสดงตัวอย่างที่นำไปใช้ได้จริงและดำเนินการไม่ได้
โครงสร้างข้อความแสดงข้อผิดพลาด
ข้อความแสดงข้อผิดพลาดที่นำไปใช้ได้จริงมีโครงสร้างดังต่อไปนี้
- เกิดข้อผิดพลาด การอธิบายว่าทำไมแอป Chat จึงทำตามคำขอไม่สำเร็จจะช่วยให้ผู้ใช้แก้ไขปัญหาได้ การอธิบายสาเหตุที่เกิดข้อผิดพลาด ทำให้เกิดความน่าเชื่อถือ
- วิธีที่ผู้ใช้จะบรรลุเป้าหมายได้ การพูดระบายแค่ว่า มีอะไรผิดปกติ แจ้งให้ผู้ใช้ทราบว่าจะข้ามข้อผิดพลาด และทำเป้าหมายให้สำเร็จได้อย่างไร
- วิธีรับความช่วยเหลือ หากผู้ใช้ยังติดขัด ให้บอกวิธีขอความช่วยเหลือเพิ่มเติม โดยอาจเป็นคำสั่ง
/helpหรือลิงก์ไปยังเอกสารประกอบสำหรับแอป Chat ของคุณ
ตัวอย่างข้อความแสดงข้อผิดพลาด: รูปแบบวันที่ไม่ถูกต้อง
ในตัวอย่างนี้ ผู้ใช้ป้อนวันที่ในรูปแบบที่แอป Chat ไม่ได้คาดไว้ ผู้เขียนเขียนว่า
November 19, 2021 แต่แอป Chat คาดหวังว่า
2021-11-19
ต่อไปนี้คือข้อความแสดงข้อผิดพลาดในเวอร์ชันที่ดำเนินการได้จริงและใช้งานไม่ได้ ซึ่งแอป Chat จะตอบกลับ
ข้อผิดพลาดที่ดำเนินการได้
ผู้ใช้ขอให้แอป Chat กำหนดเวลาการประชุมกับบุคคลอื่น แอป 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`.
ข้อความแสดงข้อผิดพลาดนี้สามารถแก้ไขได้เนื่องจากสาเหตุต่อไปนี้
- พูดว่าเกิดข้อผิดพลาด แอป Chat ไม่รู้จักรูปแบบวันที่
- อธิบายวิธีแก้ไขข้อผิดพลาดโดยบอกรูปแบบวันที่ที่ต้องการให้ผู้ใช้ทราบ และให้ตัวอย่างวันที่เพื่อช่วยให้ผู้ใช้เข้าใจว่าควรเขียนอะไร
- ให้ความช่วยเหลือเพิ่มเติมด้วยคำสั่งเครื่องหมายทับ
/helpหากผู้ใช้ยังคิดไม่ออก พวกเขาก็รู้วิธีหาข้อมูลเพิ่มเติม
ข้อผิดพลาดที่ไม่สามารถดำเนินการได้
ผู้ใช้ขอให้แอป Chat กำหนดเวลาการประชุมกับบุคคลอื่น แอป Chat จะตอบกลับด้วยข้อความแสดงข้อผิดพลาด ที่ไม่เป็นประโยชน์และไม่สามารถดำเนินการได้ ดังนี้
Enter the correct date format.
ข้อความแสดงข้อผิดพลาดนี้จะดำเนินการไม่ได้เนื่องจากสาเหตุต่อไปนี้
- ไม่ได้ระบุว่ากำหนดการมีการประชุมหรือไม่ ผู้ใช้อาจลังเลที่จะนัดเวลาใหม่ หรืออาจคิดว่าได้นัดหมายการประชุมไว้แล้ว
- ไม่บอกวิธีจัดรูปแบบวันที่แก่ผู้ใช้ แทนที่จะถือว่าผู้ใช้ทราบวิธีจัดรูปแบบวันที่แล้ว ควรระบุให้ทราบว่าควรใช้รูปแบบวันที่
yyyy-mm-dd - ไม่ได้ให้ความช่วยเหลือเพิ่มเติม เมื่อผู้ใช้พบปัญหาและไม่รู้ว่าควรทำอย่างไรต่อ ผู้ใช้อาจหยุดส่งข้อความถึงแอป Chat
ลองเลย
เมื่อทราบวิธีเขียนข้อผิดพลาดที่นำไปใช้ได้จริงแล้ว คุณจะระบุสถานการณ์ต่อไปนี้ได้ด้วยว่าข้อผิดพลาดใดที่นําไปใช้ได้จริง
แอป Chat จะสร้างกิจกรรมในปฏิทินเมื่อผู้ใช้ส่งข้อความถึงแอป Chat ด้วยคีย์เวิร์ด schedule หากต้องการสร้างกิจกรรมในปฏิทิน แอป Chat จะต้องมีการตรวจสอบสิทธิ์ผู้ใช้ หากผู้ใช้ยังไม่ได้รับการตรวจสอบสิทธิ์ แอป Chat จะตอบกลับด้วยข้อความแสดงข้อผิดพลาด
/signin ก่อน ฉันถึงจะนัดประชุมได้ หากต้องการดูข้อมูลเพิ่มเติม ให้พิมพ์ /help- มีบางอย่างผิดปกติ แอป Chat ต้องมีการตรวจสอบสิทธิ์
- วิธีดำเนินการต่อ พิมพ์
/signinเพื่อตรวจสอบสิทธิ์ - วิธีรับความช่วยเหลือ หากผู้ใช้ต้องการข้อมูลเพิ่มเติม ก็สามารถพิมพ์
/helpได้