แม้ว่าผู้ใช้คอมพิวเตอร์จำนวนมากมักละเลย แต่ไฟล์วิธีใช้ให้ข้อมูลสำคัญเกี่ยวกับวิธีใช้ซอฟต์แวร์แอปพลิเคชันที่เกี่ยวข้อง โดยการคลิก "วิธีใช้" ผู้ใช้สามารถดูภาพรวมของคุณสมบัติของโปรแกรม คำอธิบายหน้าจอที่เขาหรือเธอกำลังดู คำแนะนำเกี่ยวกับวิธีใช้โปรแกรมเพื่อทำงานที่กำหนด หรืออ่านรายการคำถามที่พบบ่อยเกี่ยวกับ โปรแกรมและคำตอบ การเขียนไฟล์วิธีใช้ต้องใช้ทั้งความสามารถในการทำงานกับแอปพลิเคชันซอฟต์แวร์และความสามารถในการอธิบายสิ่งต่างๆ ในลักษณะที่ผู้ใช้จะเข้าใจได้
ขั้นตอน
ขั้นตอนที่ 1 รับสำเนาซอฟต์แวร์ที่คุณต้องการจัดทำเอกสาร
หากเป็นไปได้ คุณควรได้รับสำเนาข้อกำหนดที่เป็นลายลักษณ์อักษรสำหรับโปรแกรมด้วย แม้ว่านักพัฒนาซอฟต์แวร์บางรายจะใช้งานไม่ได้ก็ตาม ในบางกรณี โปรแกรมเมอร์จะเบี่ยงเบนไปจากข้อกำหนด โดยขึ้นอยู่กับเวลาในการพัฒนาที่สั้นหรือไม่สามารถเขียนโค้ดคุณลักษณะบางอย่างได้
ขั้นตอนที่ 2 รับเครื่องมือสร้างความช่วยเหลือ
แม้ว่าจะสามารถสร้างไฟล์วิธีใช้ด้วยมือได้ โดยใช้ไฟล์รูปแบบข้อความ (.rtf) แต่ผู้เขียนไฟล์วิธีใช้ส่วนใหญ่ใช้แอปพลิเคชันซอฟต์แวร์เพื่อเขียนไฟล์วิธีใช้ เช่น RoboHelp, Help and Manual, Doc-To -Help, MadCap Flare หรือ HelpLogix เครื่องมือช่วยเขียนส่วนใหญ่ประกอบด้วยโปรแกรมแก้ไขข้อความหรือทำงานกับโปรแกรมประมวลผลคำ เช่น Microsoft Word และมีส่วนต่อประสานกับผู้ใช้ที่ช่วยให้ผู้เขียนความช่วยเหลือเห็นว่าไฟล์วิธีใช้จะมีลักษณะอย่างไรในขณะที่เขียนในขณะที่เขียนโค้ดคอมพิวเตอร์เบื้องหลัง เพื่อให้ไฟล์ช่วยเหลือทำงาน เครื่องมือสร้างความช่วยเหลือบางอย่างยังรวมถึงโปรแกรมแก้ไขกราฟิกสำหรับสร้างภาพหน้าจอเพื่อรวมไว้ในไฟล์วิธีใช้
มีรูปแบบไฟล์วิธีใช้หลายแบบ: รูปแบบที่พบบ่อยที่สุดคือวิธีใช้ HTML ซึ่งใช้โดยแอปพลิเคชันที่ทำงานใน Windows (รูปแบบที่เก่ากว่าคือ WinHelp ไม่ได้รับการสนับสนุนอีกต่อไป) Apple และ Unix ต่างก็มีรูปแบบของตนเอง เช่นเดียวกับ Sun Microsystems ด้วย JavaHelp แอปพลิเคชันซอฟต์แวร์ที่ออกแบบมาให้ทำงานภายใต้ระบบปฏิบัติการหลายระบบอาจใช้ระบบช่วยเหลือข้ามแพลตฟอร์มที่ทำงานในเว็บเบราว์เซอร์ของผู้ใช้ เครื่องมือสร้างความช่วยเหลือที่คุณใช้ควรสนับสนุนรูปแบบความช่วยเหลือที่คุณจะสร้างไฟล์วิธีใช้
ขั้นตอนที่ 3 สร้างไฟล์โครงการช่วยเหลือ
เครื่องมือสร้างความช่วยเหลือของคุณจะสร้างไฟล์โครงการช่วยเหลือให้กับคุณ โดยอิงตามชื่อไฟล์ที่คุณระบุและข้อมูลอื่นๆ ไฟล์โปรเจ็กต์หลักประกอบด้วยข้อมูลเกี่ยวกับไฟล์อื่นๆ ซึ่งรวมถึงไฟล์เนื้อหา ไฟล์ดัชนี ไฟล์รูปภาพอย่างน้อยหนึ่งไฟล์ และไฟล์อื่นๆ
- ไฟล์เนื้อหามีข้อความในไฟล์วิธีใช้ที่อธิบายวิธีการทำงานของแอปพลิเคชันซอฟต์แวร์ที่คุณกำลังจัดทำเอกสาร โดยปกติข้อความจะแบ่งออกเป็นหัวข้อที่ครอบคลุมหน้าจอ คุณลักษณะ หรือขั้นตอนเฉพาะ
- ไฟล์ดัชนีคือรายการหัวข้อของไฟล์วิธีใช้ ใช้เพื่อสร้างสารบัญที่ผู้ใช้สามารถใช้เพื่อเลือกหัวข้อที่จะดู รวมทั้งดัชนีที่ค้นหาได้ภายในไฟล์วิธีใช้
- ไฟล์รูปภาพคือไฟล์กราฟิกของหน้าจอโปรแกรมหรือบางส่วนของหน้าจอที่แสดงอยู่ในไฟล์วิธีใช้ เพื่อเพิ่มความสามารถของผู้ใช้ในการทำความเข้าใจว่าข้อความในไฟล์วิธีใช้อ้างถึงอะไร
ขั้นตอนที่ 4 ปรับขนาดของหน้าต่างวิธีใช้
เว้นแต่ว่าคุณกำลังเขียนไฟล์วิธีใช้เพื่อให้ปรากฏในเว็บเบราว์เซอร์ของผู้ใช้ ไฟล์วิธีใช้จะปรากฏในหน้าต่างของตัวเอง เครื่องมือสร้างความช่วยเหลือของคุณจะช่วยให้คุณปรับขนาดแนวนอนและแนวตั้งของหน้าต่างให้เป็นขนาดที่ผู้ใช้จะอ่านไฟล์วิธีใช้ได้โดยไม่รบกวนการทำงานของแอปพลิเคชัน หน้าต่างวิธีใช้หลักมักจะอยู่ในรูปแบบสามบานหน้าต่าง โดยมีสารบัญทางด้านซ้ายและหัวข้อที่เลือกอยู่ทางด้านขวา
นอกจากนี้ ไฟล์วิธีใช้ยังสามารถมีหน้าต่างรองที่อธิบายคุณลักษณะเฉพาะโดยละเอียดและปรับขนาดหน้าต่างป๊อปอัปโดยอัตโนมัติซึ่งจะให้คำอธิบายสั้นๆ เกี่ยวกับคุณลักษณะต่างๆ นอกเหนือจากหน้าต่างหลัก ไฟล์วิธีใช้ยังสามารถรวมข้อความที่ฝังไว้ซึ่งปรากฏเฉพาะเมื่อมีการเน้นข้อความหรือปุ่มเท่านั้น
ขั้นตอนที่ 5. เขียนหัวข้อวิธีใช้
ในการดำเนินการนี้ คุณจะต้องตรวจสอบข้อกำหนดหรือตัวโปรแกรมเองเพื่อสร้างหัวข้อเพื่อบันทึกหน้าจอและคุณสมบัติของโปรแกรม เมื่อคุณสร้างแต่ละหัวข้อ เครื่องมือสร้างวิธีใช้ของคุณจะเพิ่มลงในสารบัญและดัชนีของไฟล์วิธีใช้
- แม้ว่าคุณสามารถสร้างสารบัญได้ในขณะเดินทาง แต่การมีแผนจะจัดระเบียบบางอย่างก็ช่วยได้ คุณสามารถจัดระเบียบสารบัญรอบหน้าจอของโปรแกรม คุณลักษณะของโปรแกรม วิธีใช้งาน หรือการผสมผสานบางส่วนได้
- ขณะที่คุณเขียนหัวข้อ ให้พิจารณาข้อมูลอื่นๆ ในไฟล์วิธีใช้ที่ผู้ใช้ต้องการเข้าถึงอย่างรวดเร็ว คุณสามารถสร้างการข้ามหรือไฮเปอร์ลิงก์ในข้อความไฟล์วิธีใช้ที่เชื่อมต่อกับหัวข้อที่มีข้อมูลนั้น
ขั้นตอนที่ 6 รวมภาพหน้าจอ หากจำเป็น
ฟีเจอร์ของโปรแกรมจำนวนมากได้รับการอธิบายได้ดีที่สุดด้วยการผสมผสานระหว่างข้อความและกราฟิก คุณสามารถสร้างภาพหน้าจอด้วยแอปพลิเคชันที่มาพร้อมกับเครื่องมือสร้างความช่วยเหลือของคุณ หรือด้วยแอปพลิเคชันแยกต่างหาก เช่น Microsoft Paint, Paint Shop Pro หรือ SnagIt
- ควรจัดวางข้อความและภาพหน้าจอไว้ด้วยกันในหัวข้อเพื่อให้ผู้ใช้สามารถดูภาพหน้าจอและข้อความสนับสนุนได้โดยไม่ต้องเลื่อนดูเกินควร ในหลายกรณี คุณจะต้องแสดงส่วนหนึ่งของหน้าจอโปรแกรมแทนที่จะเป็นทั้งหน้าจอ หรือแสดงภาพหน้าจอในขนาดที่เล็กกว่าต้นฉบับ แอปพลิเคชันภาพหน้าจอของคุณควรปรับขนาดภาพหน้าจอได้โดยไม่เบลอหรือสูญเสียรายละเอียด
- หากคุณคาดว่าจะมีการเปลี่ยนแปลงอินเทอร์เฟซผู้ใช้ระหว่างเวอร์ชันทดสอบและเวอร์ชันสุดท้ายของโปรแกรม คุณอาจต้องการระงับการสร้างภาพหน้าจอจนกว่าคุณจะมีเวอร์ชันสุดท้ายของโปรแกรมที่จะใช้งานได้
ขั้นตอนที่ 7 สร้างไฟล์แผนที่ หากจำเป็น
บางโปรแกรมมีปุ่ม "วิธีใช้" เพื่อให้ผู้ใช้คลิกและแสดงหัวข้อในไฟล์วิธีใช้ที่อธิบายวิธีการทำงานของหน้าจอโดยเฉพาะ การแสดงหัวข้อในลักษณะนี้เรียกว่าวิธีใช้ตามบริบท และจำเป็นต้องสร้างไฟล์แผนที่สำหรับโปรแกรมเมอร์เพื่อเชื่อมโยงปุ่ม "วิธีใช้" กับหัวข้อเฉพาะในไฟล์วิธีใช้ของคุณ เครื่องมือสร้างความช่วยเหลือสามารถสร้างให้คุณ หรือโปรแกรมเมอร์สามารถเขียนโค้ดและมอบให้คุณเพื่อรวมไว้ในไฟล์วิธีใช้
ขั้นตอนที่ 8 รวบรวมไฟล์ช่วยเหลือ
การคอมไพล์จะสร้างไฟล์วิธีใช้จริงที่จะรวมอยู่ในโปรแกรม สำหรับรูปแบบวิธีใช้ส่วนใหญ่ จะรวมไฟล์ส่วนประกอบทั้งหมดที่สร้างขึ้นเมื่อคุณสร้างไฟล์วิธีใช้ แม้ว่ารูปแบบวิธีใช้ที่ไม่ได้คอมไพล์บางรูปแบบจะต้องการไฟล์หัวข้อวิธีใช้แต่ละรายการเพื่อรวมไว้ในโปรแกรม
ขั้นตอนที่ 9 ทดสอบไฟล์ช่วยเหลือ
เมื่อคุณรวบรวมไฟล์วิธีใช้แล้ว คุณต้องทดสอบเพื่อให้แน่ใจว่าไฮเปอร์ลิงก์ทั้งหมดเชื่อมต่อกับหัวข้อที่ควรจะเป็น และกราฟิกทั้งหมดแสดงอย่างถูกต้อง ไฟล์วิธีใช้ยังต้องได้รับการทดสอบเพื่อให้แน่ใจว่าเนื้อหาถูกต้องและเหมาะสมกับผู้ใช้และอยู่ในรูปแบบที่สอดคล้องกัน คุณจะต้องตรวจสอบไฟล์วิธีใช้ด้วยตนเองและให้ผู้ที่ทดสอบแอปพลิเคชันตรวจสอบด้วย
สำหรับโปรเจ็กต์ไฟล์วิธีใช้ที่ใหญ่ขึ้น การคอมไพล์และการทดสอบเป็นกระบวนการที่ต่อเนื่อง คุณจะต้องคอมไพล์ไฟล์วิธีใช้และตรวจสอบงานของคุณหลายๆ ครั้งก่อนที่จะสร้างเวอร์ชันสุดท้าย
ขั้นตอนที่ 10. มอบไฟล์ช่วยเหลือให้กับผู้พัฒนาเพื่อรวมเข้ากับโปรแกรม
ทั้งนี้ขึ้นอยู่กับลักษณะของโครงการและรูปแบบไฟล์วิธีใช้ คุณอาจต้องจัดเตรียมไฟล์หลายไฟล์ให้นักพัฒนา รวมถึงไฟล์แผนที่หากมีหัวข้อที่ไวต่อบริบท
