วิธีเขียนคู่มือผู้ใช้สำหรับซอฟต์แวร์

มักจะเต็มไปด้วยศัพท์แสงตัวย่อและทิศทางที่ต้องใช้ Ph.D เพื่อทำความเข้าใจในบางครั้งคู่มือผู้ใช้ซอฟต์แวร์จะถูกเขียนจากมุมมองของนักพัฒนามากกว่าผู้ใช้ เป็นผลให้คำแนะนำอาจทำให้สมมติฐานเกี่ยวกับระดับทักษะของผู้อ่านที่มักจะไม่ถูกต้อง ขั้นตอนแรกในการเขียนคู่มือผู้ใช้ที่ดีคือการทำให้กระบวนการเขียนจริงอยู่ไกลจากวิศวกรมากที่สุด

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

การทดสอบผู้ใช้

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

ขั้นตอนการสัมภาษณ์

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

ภาพ

คู่มือผู้ใช้ไม่ควรหนักเกินไป ค่อนข้างรวมการใช้กราฟิกและคลิปหน้าจอเสรี คำอธิบายของการกระทำมีความชัดเจนมากขึ้นเมื่อใช้ข้อความเป็นตัวอักษรพร้อมกับคลิปหน้าจอที่แสดงทิศทางนั้นอย่างชัดเจน รวมทั้งมุมมองก่อนและหลังเพื่อแสดงว่าหน้าจอมีลักษณะอย่างไรก่อนที่จะดำเนินการแต่ละครั้งและจะเกิดอะไรขึ้นหลังจากที่มีการดำเนินการแล้ว ยูทิลิตี้การจับภาพหน้าจอที่เรียบง่ายเช่น Snipping Tool ที่รวมอยู่ใน Microsoft Windows ทำงานได้ดีสำหรับการจับภาพเหล่านี้ ตรวจสอบให้แน่ใจว่าได้กำหนดหมายเลขภาพแต่ละภาพและใส่คำอธิบายภาพที่อธิบายสั้น ๆ วางตรงกลางด้านล่างของย่อหน้าที่แนะนำแนวคิดที่ปรากฎในภาพก่อน

การจัดรูปแบบ

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

การกำหนดเวอร์ชันและการติดตาม

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