เนื้อหา

• ที่จะก้าว
• ส่วนที่ 1 จาก 4: การวางแผนคู่มือการใช้งานของคุณ
• ส่วนที่ 2 จาก 4: ฝังข้อมูลที่จำเป็น
• ส่วนที่ 3 ของ 4: อธิบายการบำรุงรักษาผลิตภัณฑ์
• ส่วนที่ 4 ของ 4: เขียนคู่มือที่อ่านได้
• เคล็ดลับ

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

ที่จะก้าว

ส่วนที่ 1 จาก 4: การวางแผนคู่มือการใช้งานของคุณ

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

ส่วนที่ 2 จาก 4: ฝังข้อมูลที่จำเป็น

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

ส่วนที่ 3 ของ 4: อธิบายการบำรุงรักษาผลิตภัณฑ์

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

ส่วนที่ 4 ของ 4: เขียนคู่มือที่อ่านได้

1. อ่านคู่มือผู้ใช้อื่น ๆ ก่อนที่จะเขียนคู่มือสำหรับผลิตภัณฑ์ของคุณเองโปรดดูคู่มือผู้ใช้ที่มีประสิทธิภาพอื่น ๆ ใส่ใจกับโครงสร้างการเลือกใช้คำและโครงสร้างประโยค แบรนด์หลัก ๆ เช่น Apple, Google และ Microsoft จัดทำคู่มือผู้ใช้ที่มีประสิทธิภาพและรัดกุมซึ่งจะช่วยให้คุณจัดทำคู่มือผู้ใช้ที่มีความรอบคอบมากขึ้น
   • อย่าเพิ่งอ่าน ทั้งหมด คู่มือผู้ใช้ อ่านคู่มือสำหรับผลิตภัณฑ์ที่คล้ายคลึงกันที่คุณขาย ตัวอย่างเช่นหากคุณขายผลิตภัณฑ์สำหรับเด็กโปรดอ่านคู่มือสำหรับเด็กไม่ใช่คู่มือทางเทคนิค
2. เลือกมาตรฐานของคุณ การกำหนดมาตรฐานการสะกดคำการเลือกคำและการใช้ถ้อยคำจะทำให้คู่มือผู้ใช้ใช้งานง่ายขึ้น นอกจากนี้ Chicago Manual of Style และ Microsoft Manual of Style ยังสามารถเป็นคำแนะนำเกี่ยวกับสไตล์ที่เป็นประโยชน์เมื่อเขียนคู่มือสำหรับเจ้าของของคุณ ตรวจสอบทั้งสองอย่างเพื่อดูว่าเหมาะกับคู่มือของคุณหรือไม่
   • ตัวอย่างเช่นแทนที่จะใช้ทั้ง "สวิตช์เปิดปิด" และ "ปุ่มเปิด / ปิด" ในคู่มือของคุณให้เลือกหนึ่งในสองคำและปฏิบัติตาม
3. ใช้เสียงที่ใช้งานอยู่ เสียงที่ใช้งานเป็นวิธีการเขียนที่อธิบายสิ่งต่างๆจากมุมมองของผู้ใช้ เข้าใจง่ายกว่าอีกทางเลือกหนึ่งคือ passive voice ซึ่งไม่ได้กำหนดหัวเรื่องไว้
   • ลองใช้แอป Hemingway (www.hemmingwayapp.com) เพื่อระบุข้อความแฝงในงานเขียนของคุณ
   • ศึกษาประโยคตัวอย่างสองประโยคนี้ประโยคแรกใช้งานอยู่และประโยคที่สองเป็นแบบพาสซีฟ:
     • คุณต้องเปิดหีบห่ออย่างช้าๆและระมัดระวัง
     • ควรเปิดหีบห่ออย่างช้าๆและระมัดระวัง
4. เขียนคำแนะนำที่มีหมายเลขกำกับ คำแนะนำที่เรียงตามลำดับตัวเลขช่วยให้ผู้อ่านสามารถโฟกัสไปที่กระบวนการใช้เชื่อมต่อหรือสร้างผลิตภัณฑ์ที่เป็นปัญหาได้ดีขึ้น แทนที่จะเขียนย่อหน้ายาว ๆ แบบละเอียดหรือชุดของย่อหน้าที่ไม่มีตัวเลขให้เขียนคู่มือผู้ใช้ของคุณด้วยขั้นตอนที่เรียบง่ายและชัดเจน
5. เริ่มต้นแต่ละขั้นตอนด้วยความจำเป็น ความจำเป็นคือคำกริยาที่มุ่งเน้นการกระทำ เมื่อเริ่มต้นแต่ละขั้นตอนด้วยคำกริยาคุณจะให้คำแนะนำแก่ผู้อ่านเกี่ยวกับการดำเนินการที่จำเป็นในการทำขั้นตอนให้เสร็จสมบูรณ์ ตัวอย่างเช่นขึ้นอยู่กับผลิตภัณฑ์ที่คุณกำลังเขียนถึงคุณสามารถเริ่มขั้นตอนของคุณด้วยคำสั่งเช่น "Connect", "Confirm" หรือ "Slide" อย่างไรก็ตามอย่าเริ่มขั้นตอนของคุณด้วยการตอบสนองจากระบบ
   • ตัวอย่างเช่นหากหน้าจอเปลี่ยนเป็นสีน้ำเงินและเริ่มกะพริบอย่าเริ่มขั้นตอนด้วย: "หน้าจอจะกะพริบและเปลี่ยนเป็นสีน้ำเงิน" ลอง: "กดปุ่มโฮมค้างไว้ หน้าจอจะกะพริบและเปลี่ยนเป็นสีน้ำเงิน "
6. กำหนดคำศัพท์ที่คุณจะใช้ หากคุณกำลังเขียนคู่มือโยโย่ผู้ชมของคุณส่วนใหญ่จะเป็นเด็กเล็ก ใช้คำศัพท์และคำศัพท์ง่ายๆเพื่ออธิบายว่าโยโย่ทำงานอย่างไร เมื่อคุณเขียนคู่มือการใช้กล้องจุลทรรศน์อิเล็กตรอนแบบส่องกราดผู้ชมของคุณประกอบด้วยนักวิทยาศาสตร์ที่มีทักษะสูงซึ่งสามารถเข้าใจข้อมูลโดยละเอียดได้ดังนั้นอย่าอายที่จะใช้คำศัพท์เฉพาะทางหรือคำอธิบายที่เหมาะสม
   • โดยทั่วไปคุณพยายามหลีกเลี่ยงศัพท์แสงและภาษาเชิงเทคนิค
   • เพื่อให้มีประสิทธิภาพสำหรับฐานผู้ใช้ที่กว้างที่สุดให้พยายามเขียนในระดับประถมศึกษาปีที่หกถึงเจ็ด
7. เมื่อจัดส่งผลิตภัณฑ์ไปต่างประเทศตรวจสอบให้แน่ใจว่าคำแปลของคุณถูกต้อง จ้างนักแปลเพื่อแปลคู่มือผู้ใช้ของคุณเป็นภาษาแม่ของประเทศที่คุณจัดส่งผลิตภัณฑ์ไป คุณยังสามารถใช้โปรแกรมแปลภาษาออนไลน์ได้ แต่ขอให้เจ้าของภาษาอ่านคำแปลและตรวจสอบข้อผิดพลาด
   • หากผู้ชมของคุณมีกลุ่มภาษาหลายกลุ่มโปรดรวมคำแปลของคู่มือผู้ใช้ในแต่ละภาษาที่เกี่ยวข้อง
   • นักแปลต้องคุ้นเคยกับผลิตภัณฑ์เนื่องจากอาจมีคำที่แตกต่างกันในภาษาเป้าหมายสำหรับคำศัพท์เฉพาะที่ไม่ใช่การแปลแบบคำต่อคำ
8. เขียนเป็นประโยคสั้น ๆ แทนที่จะใช้ย่อหน้ายาวสองสามย่อหน้าคุณใช้ย่อหน้าสั้น ๆ จำนวนมาก มองหาตัวแบ่งตรรกะในแต่ละส่วนและแยกย่อยข้อมูลที่เป็นประโยชน์ในส่วนหนึ่งหรือสองประโยค เช่นเดียวกับที่ระดับประโยค ใช้ประโยคของคุณให้สั้นและเรียบง่ายแทนที่จะยาวและละเอียด
   • หากขั้นตอนยาวเกินไปให้แบ่งเป็นขั้นตอนย่อย ๆ วิธีนี้จะไม่ลดจำนวนคำ แต่การแบ่งบรรทัดจะทำให้อ่านง่ายขึ้น
9. ตรวจสอบข้อผิดพลาดในคู่มือ คู่มืออาจสูญเสียความน่าเชื่อถือเนื่องจากข้อผิดพลาดด้านไวยากรณ์และการสะกดคำ ให้เพื่อนร่วมงานหรือนักเขียนด้านเทคนิคแก้ไขและพิสูจน์อักษรคู่มือด้วย นอกเหนือจากการสะกดคำและไวยากรณ์แล้วผู้พิสูจน์อักษรควรให้ความสำคัญกับสิ่งต่อไปนี้:
   • กรรมวาจก
   • ภาษาที่ไม่ชัดเจนหรือสับสน
   • โครงสร้างประโยคห่อ
   • ย่อหน้าที่ยาวเกินไป

เคล็ดลับ

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