วิธีการเขียนคู่มือผู้ใช้ที่ยอดเยี่ยมสำหรับเกือบทุกอย่าง

สารบัญ:

Anonim

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

รายการที่คุณจะต้อง

  • Microsoft Word หรือโปรแกรมประมวลผลคำอื่น ๆ

  • การสะสมภาพตัดปะหรือภาพถ่ายดิจิทัล

  • ซอฟต์แวร์เขียนหน้าเว็บอย่างง่าย

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

จัดระเบียบชัดเจนและรัดกุม คาดหวังและอธิบายไม่เพียง แต่สิ่งที่ผู้ใช้ผลิตภัณฑ์จะทำ แต่ยังต้องทำอะไร คุณต้องเขียนด้วยตาต่อทั้งสอง

เริ่มต้นที่จุดเริ่มต้นแฉเฉพาะข้อมูลที่จำเป็นในแบบตรรกะ เขียนด้วยเสียงที่ใช้งานไม่ใช่แบบพาสซีฟ เก็บสำเนาของคุณไว้โดยไม่ใช้คำที่ไม่เกี่ยวข้อง ทำให้มันง่ายและมีระเบียบ

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

เตือนผู้อ่านว่าจะไม่ทำอะไรเป็นระยะ ๆ สิ่งนี้จะช่วยลดความคับข้องใจเมื่อเรียนรู้ผลิตภัณฑ์หรือแอปพลิเคชันใหม่

จัดหาแหล่งข้อมูลอื่นให้ผู้อ่านสามารถใช้เพื่อเสริมคำแนะนำของคุณ

เคล็ดลับ

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

การเตือน

อย่าสันนิษฐานว่าผู้อ่านคุ้นเคยกับผลิตภัณฑ์ เขียนคำแนะนำแต่ละรายการราวกับว่าไม่เคยเห็นมาก่อน