ไม่ว่านักประดิษฐ์ โปรแกรมเมอร์ หรือนักหาเหตุผลจะมีความเฉลียวฉลาดเพียงใด บางครั้งการสร้างสรรค์ของเขาก็ไม่อาจนำไปใช้ตามวัตถุประสงค์ที่ตั้งใจไว้ได้ เหตุผลก็คือการร่างคู่มือการใช้งานที่ไม่ถูกต้องหรือขาดหายไปโดยสมบูรณ์ แต่แม้แต่นักประดิษฐ์ที่เฉลียวฉลาดในบางครั้งก็เขียนคำสั่งดังกล่าว ซึ่งนอกจากจะไม่มีใครสามารถอ่านเอกสารเหล่านี้ได้ ดังนั้นคุณจะจัดทำเอกสารที่จำเป็นอย่างถูกต้องได้อย่างไร?
มันจำเป็น
- - ความรู้หนึ่งร้อยเปอร์เซ็นต์เกี่ยวกับอุปกรณ์หรือผลิตภัณฑ์ซอฟต์แวร์ที่ใช้เขียนคู่มือ
- - ความรู้ด้านภาษาศาสตร์
- - ทักษะการเขียน.
คำแนะนำ
ขั้นตอนที่ 1
คู่มือผู้ใช้หรือกล่าวอีกนัยหนึ่งคือคู่มือการใช้งานเป็นเอกสารที่ออกแบบมาเพื่อให้ความช่วยเหลือในการใช้ระบบบางอย่างแก่ผู้ใช้ ในการรวบรวมคู่มือผู้ใช้คุณจำเป็นต้องรู้ระบบที่อธิบายไว้หนึ่งร้อยเปอร์เซ็นต์ แต่มองผ่านสายตาของนักเรียนที่โง่เขลา สมมติว่าคู่มือผู้ใช้เขียนขึ้นสำหรับยูทิลิตี้ซอฟต์แวร์ที่ยังไม่มีแอนะล็อก ลองนึกภาพว่านี่เป็นครั้งแรกที่คุณใช้โปรแกรมนี้ คุณจะเริ่มต้นที่ไหน สิ่งแรกที่ต้องรู้คืออะไร? จัดระเบียบความรู้นี้เป็นหมวดหมู่ที่สำคัญ
ขั้นตอนที่ 2
โดยการแบ่งข้อมูลทั้งหมดเกี่ยวกับการสร้างของคุณออกเป็นกลุ่ม คุณได้ร่างแผนสำหรับการเขียนคู่มือผู้ใช้ เริ่มอธิบายงานในโปรแกรมของคุณตั้งแต่ต้น โดยทิ้งรายละเอียดที่ยากที่สุดไว้เป็นลำดับสุดท้าย เช่น การตั้งโปรแกรมคุณสมบัติใหม่ หรือการจัดการกับข้อผิดพลาดร้ายแรง ในขั้นตอนนี้ คุณควรเตรียมเนื้อหาของคู่มือผู้ใช้ให้พร้อม - หนึ่งในส่วนที่จำเป็นของเอกสารนี้
ขั้นตอนที่ 3
หากคู่มือที่คุณกำลังสร้างมีไว้สำหรับใช้ในบริษัทขนาดใหญ่ คุณควรให้ความสนใจกับมาตรฐานขององค์กรที่นำมาใช้ที่นั่น ตัวอย่างเช่น ในบริษัทรัสเซียหลายแห่ง คู่มือผู้ใช้จะไม่ได้รับการยอมรับหากไม่มีการสนับสนุนที่มีภาพประกอบ กล่าวคือ รูปภาพที่อธิบายสิ่งที่เขียน นอกจากเนื้อหาแล้ว คู่มือผู้ใช้ควรมีส่วนบังคับอื่นๆ: - คำอธิบายประกอบ กล่าวคือ คำอธิบายวัตถุประสงค์ทั่วไปของคู่มือและผลิตภัณฑ์ที่อธิบายไว้ - บทนำซึ่งอธิบายเอกสารที่เกี่ยวข้องกับคู่มือผู้ใช้และวิธีการ วิธีใช้คู่มือ - ส่วนที่อธิบายการใช้ผลิตภัณฑ์ในขั้นตอนต่างๆ ของการใช้งาน เช่น ขั้นตอนแรก การซ่อมแซมหรือบำรุงรักษา - หัวข้อคำถามและคำตอบที่พบบ่อย - อภิธานศัพท์หรือดัชนีหัวเรื่อง
ขั้นตอนที่ 4
โดยปกติ นักเขียนด้านเทคนิคจะมีส่วนร่วมในการจัดทำคู่มือผู้ใช้ ซึ่งเป็นบุคคลที่มีความรู้ที่จำเป็นทั้งหมดทั้งในภาษาและในผลิตภัณฑ์ที่อธิบายไว้ ในฐานะนักเขียนด้านเทคนิคที่ไม่มีการฝึกอบรม มีกฎสองสามข้อที่ต้องคำนึงถึง ประการแรก คุณต้องไม่ใช้ข้อกำหนดพิเศษที่ผู้ใช้ทั่วไปไม่เข้าใจ ประการที่สอง แต่ละคำที่ใช้ต้องมีรายละเอียดและอธิบาย ประการที่สาม คุณต้องเขียนให้ชัดเจนและรัดกุมที่สุด สุดท้ายนี้ นักเขียนทางเทคนิคจะต้องสามารถมองข้อความของตนเองผ่านสายตาของผู้ใช้ทั่วไปได้ เพื่อที่จะมองเห็นข้อบกพร่องของข้อความของตนเอง
ขั้นตอนที่ 5
เป็นการดีที่จะทดสอบข้อความที่เสร็จแล้วของคู่มือผู้ใช้ในทางปฏิบัติโดยเสนอให้กับบุคคลที่ไม่มีส่วนเกี่ยวข้องกับผลิตภัณฑ์ที่อธิบายไว้ ด้วยความพยายามร่วมกัน จึงสามารถขจัดข้อบกพร่องและข้อผิดพลาดทั้งหมดของเอกสารได้