จัดคู่มือตามงาน ไม่ใช่จัดตามโครงเมนู
ผู้อ่านเปิดคู่มือเพราะต้องการผลลัพธ์ เช่น สร้างคำขอหรือแก้ข้อมูลบัญชี ไม่ได้ต้องการอ่านคำอธิบายทุกเมนู เริ่มแต่ละคู่มือด้วยเป้าหมาย กลุ่มผู้ใช้ สิทธิ์ที่ต้องมี และสิ่งที่ต้องเตรียม
หนึ่งหน้าควรมี Primary Task เดียว ถ้างานต่อเนื่องมีเจ้าของหรือผลลัพธ์ใหม่ ให้แยกคู่มือแล้วทำ Related Link ซึ่งช่วยทั้งการค้นหาและการดูแลเนื้อหา
ทุกขั้นบอกการกระทำและผลที่ควรเห็น
เขียนให้ผู้อ่านรู้ว่าต้องเลือกอะไร กรอกอะไร และจะเห็นอะไรหลังทำ เช่น เลือก ส่งคำขอ แล้วระบบแสดงเลขอ้างอิง แทนคำว่า ดำเนินการตามขั้นตอนบนหน้าจอ ซึ่งไม่ได้ช่วยตรวจว่าทำสำเร็จ
ใช้ชื่อปุ่มและฟิลด์ตามหน้าจอจริง แต่ไม่พึ่งตำแหน่งอย่างเดียว เพราะ Layout เปลี่ยนตามอุปกรณ์ได้ ถ้าข้อความบน UI เปลี่ยน ควรมีเจ้าของอัปเดตคู่มือ
- บอกจุดเริ่ม
- บอกการกระทำหนึ่งชุด
- บอกผลที่ตรวจได้
- บอกทางเลือกเมื่อผลไม่ตรง
ใช้ภาพเฉพาะเมื่อภาพลดความกำกวม
ภาพเหมาะกับหน้าจอที่มีตัวเลือกคล้ายกันหรือจำเป็นต้องชี้ตำแหน่ง แต่ไม่ควรแทนคำอธิบายทั้งหมด ครอบเฉพาะบริเวณที่เกี่ยวข้อง ปกปิดข้อมูลส่วนตัว และเพิ่ม Alt Text ที่บอกหน้าที่ของภาพ
อย่าใส่ข้อความสำคัญไว้ในภาพเพียงอย่างเดียว ผู้อ่านบนมือถือและผู้ใช้ Screen Reader ต้องเข้าถึงชื่อ ขั้นตอน คำเตือน และผลลัพธ์ผ่าน HTML ได้
รองรับข้อผิดพลาดและวางแผนดูแล
เพิ่มสาขาสำหรับข้อผิดพลาดที่พบบ่อยด้วยข้อความตรงกับระบบ บอกสิ่งที่ผู้ใช้แก้เองได้และข้อมูลที่ต้องส่ง Support โดยไม่ขอรหัสผ่าน OTP หรือข้อมูลลับ
กำหนด Author, วันที่เผยแพร่, วันที่อัปเดต และ Related Content จากข้อมูลจริง ทบทวนคู่มือเมื่อ Product เปลี่ยน ไม่ใช่เปลี่ยน timestamp อัตโนมัติเพื่อให้ดูใหม่
- ทดสอบด้วยบัญชีสิทธิ์เดียวกับผู้อ่าน
- ตรวจลิงก์และภาพหลัง Release
- เก็บ Feedback ที่ระบุขั้นตอน
- เลิกเผยแพร่คู่มือที่ไม่ตรงระบบแล้ว