เคล็ดลับ 9 ข้อสำหรับเอกสารผู้ใช้ที่ยอดเยี่ยม (พร้อมตัวอย่าง)

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

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

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

นั่นคือสิ่งที่โพสต์บล็อกนี้เข้ามา! ผม

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

เริ่มต้นด้วยแผน

เช่นเดียวกับหลายๆ อย่างในชีวิต การเริ่มต้นกับแผนเป็นวิธีที่ดีที่สุด และการสร้างเอกสารสำหรับผู้ใช้ก็ไม่ต่างกัน นั่นเป็นเหตุผลที่คุณจะต้องแน่ใจว่าคุณถามตัวเอง (และอาจเป็นผู้ที่ขอเอกสาร) หลายๆ คำถามก่อนที่จะเริ่ม

1. พิจารณาผู้ฟังของคุณ

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

2. ประเมินและรักษาเป้าหมายสุดท้ายของคุณไว้ในใจ

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

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

3. ตรวจสอบให้แน่ใจว่าเอกสารผู้ใช้ของคุณหาได้ง่าย

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

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

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

เขียนได้กระชับ กระชับ

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

4. เขียนชื่อบรรยายและคำบรรยาย

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

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

5. ทำให้ง่ายต่อการเรียกดู

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

IBM ทำงานได้ดีในการทำให้เนื้อหาความช่วยเหลือง่ายต่อการเรียกดูโดยการจัดสารบัญที่สะอาดและให้หัวข้อที่เกี่ยวข้อง

6. ทำให้ค้นหาได้ง่าย

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

ฐานความรู้เชิงลึกของ Hubspot ทำให้การบริการตนเองเป็นเรื่องง่ายสำหรับลูกค้า

ใช้ภาพเพื่อปรับปรุงความเข้าใจ

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

7. ใช้ภาพหน้าจอที่มีคำอธิบายประกอบ

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

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

หากคุณรู้สึกมีแรงบันดาลใจ คุณยังสามารถลองใช้ Snagit's Step Tool ซึ่งช่วยให้คุณระบุส่วนต่างๆ ของรูปภาพโดยวางคำบรรยายภาพตามลำดับเมื่อคุณชี้และคลิก ทุกครั้งที่คุณคลิกเพื่อเพิ่มขั้นตอนอื่น ตัวเลขจะเลื่อนไปข้างหน้าโดยอัตโนมัติ

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

8. ใช้ประโยชน์จากวิดีโอเพื่อแสดงไม่บอก

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

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

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

9. แสดงตัวอย่างและผลลัพธ์สุดท้าย

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

เอกสารสำหรับผู้ใช้ที่ยอดเยี่ยมทำให้ผู้ใช้ปลายทางค้นหาคำตอบสำหรับคำถามได้ง่าย ซึ่งทำให้ผู้ใช้พึงพอใจและพึงพอใจ

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