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