วิธีเขียนคู่มือให้คนอ่านเข้าใจได้ตั้งแต่ครั้งแรก

อ่าน 1 นาที

ลูกค้าส่งข้อความหาฝ่ายสนับสนุน พนักงานใหม่ถามคำถามเดิมซ้ำ ๆ และงานที่ทำ “ตามคู่มือ” ก็ยังผิดพลาด ส่วนใหญ่แล้วต้นเหตุคือตัวคู่มือเอง ซึ่งเขียนโดยคนที่รู้งานนั้นดีเกินกว่าจะมองเห็นว่ามือใหม่หลงทางตรงไหน ต่อไปนี้คือเจ็ดกฎที่ทำให้คู่มือใช้ได้ผลตั้งแต่ครั้งแรก ไม่ว่าจะเป็นคู่มือผู้ใช้ บทความในศูนย์ช่วยเหลือ หรือขั้นตอนการปฏิบัติงาน

7 กฎเขียนคู่มือให้เข้าใจง่าย

1. หนึ่งงานต่อหนึ่งคู่มือ

“วิธีตั้งค่าบัญชีของคุณ” กว้างเกินไป “วิธีเปลี่ยนรหัสผ่าน” และ “วิธีเพิ่มสมาชิกในทีม” คือคู่มือสองฉบับแยกกัน ผู้อ่านมองหางานเดียว พบ ทำตาม แล้วก็ไป

2. เริ่มจากผลลัพธ์และสิ่งที่ต้องมี

ในสองบรรทัดแรก บอกว่าผู้อ่านจะทำอะไรสำเร็จ และต้องมีอะไรก่อนเริ่ม เช่น สิทธิ์การเข้าถึง ไฟล์ รหัสผ่าน หรือเวลาสิบนาที ไม่มีอะไรน่าหงุดหงิดไปกว่าการพบในขั้นตอนที่ 7 ว่าต้องมีบางอย่างตั้งแต่แรก

3. ขั้นตอนมีหมายเลข หนึ่งการกระทำต่อขั้นตอน

แต่ละขั้นตอนคือการกระทำเดียว และขึ้นต้นด้วยคำกริยา เช่น “เปิดการตั้งค่า” “คลิกบันทึก” ถ้าขั้นตอนใดมีคำว่า “แล้วจึง” อยู่ข้างใน นั่นคือสองขั้นตอน หมายเลขช่วยให้ผู้อ่านไม่หลงว่าทำถึงไหนแล้ว และช่วยให้ฝ่ายสนับสนุนบอกได้ว่า “ดูขั้นตอนที่ 4”

4. ใช้คำของผู้อ่าน ไม่ใช่คำของคุณ

เขียนชื่อปุ่มและเมนูให้ตรงกับที่ผู้อ่านเห็นบนหน้าจอทุกตัวอักษร หลีกเลี่ยงศัพท์เฉพาะภายในองค์กรและตัวย่อ หากเลี่ยงไม่ได้ ให้อธิบายเมื่อใช้ครั้งแรก

5. บอกว่าควรเกิดอะไรขึ้น

หลังขั้นตอนสำคัญ ให้บรรยายผลลัพธ์ เช่น “ข้อความสีเขียวปรากฏขึ้น: บันทึกแล้ว” ผู้อ่านจะรู้ว่ามาถูกทาง และสังเกตได้ทันทีเมื่อมีอะไรผิดพลาด

6. คำเตือนต้องมาก่อนขั้นตอน ไม่ใช่หลัง

“ก่อนคลิกลบ ให้ส่งออกข้อมูลของคุณก่อน ข้อมูลที่ถูกลบแล้วจะกู้คืนไม่ได้” คำเตือนที่วางไว้หลังขั้นตอนมาถึงช้าเกินไป

7. ทดสอบกับคนที่ไม่เคยทำ

ให้คู่มือกับคนที่ไม่เคยทำงานนั้นมาก่อน แล้วสังเกตโดยไม่ช่วย ทุกจุดที่เขาลังเล ถาม หรือทำผิด คือจุดที่ต้องเขียนใหม่ การทดสอบห้านาทีพบปัญหาได้มากกว่าการอ่านทวนหนึ่งชั่วโมง

รูปภาพและโครงสร้าง

  • ภาพหน้าจอ สำหรับขั้นตอนบนหน้าจอ โดยทำเครื่องหมายที่ปุ่มที่ถูกต้อง และอัปเดตเมื่อหน้าตาโปรแกรมเปลี่ยน
  • หัวข้อ สำหรับขั้นตอนที่ยาว เพื่อให้ผู้อ่านข้ามไปยังส่วนที่ต้องการได้
  • ส่วน “ถ้าเกิดปัญหา” ไว้ท้ายคู่มือสำหรับปัญหาที่พบบ่อย เช่น “หากไม่ได้รับอีเมล ให้ตรวจสอบโฟลเดอร์สแปม”

สรุป

หนึ่งงาน บอกผลลัพธ์และสิ่งที่ต้องมีก่อน ขั้นตอนมีหมายเลขและทำทีละอย่าง ใช้คำของผู้อ่าน บอกผลที่ควรเกิด เตือนให้ทันเวลา และทดสอบกับคนจริง หากต้องการคู่มือ ชุดบทความช่วยเหลือ หรือขั้นตอนการปฏิบัติงาน ก็สั่งเขียนคู่มือผู้ใช้และ SOPได้เลย เพียงอธิบายสินค้าหรือกระบวนการ แล้วรับคู่มือที่ชัดเจนและมีโครงสร้าง การชำระเงินจะถูกปล่อยหลังจากคุณยอมรับงานแล้วเท่านั้น