การบันทึกหน้าจอสำหรับนักเขียนเทคนิค

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

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

ทำไมวิดีโอจึงควรอยู่ในเอกสารทางเทคนิค

เอกสารที่ใช้ข้อความทำงานได้ดีสำหรับเนื้อหาอ้างอิง เช่น API อ้างอิง ตัวเลือกการกำหนดค่า คำอธิบายเชิงแนวคิด แต่สำหรับเนื้อหาเชิงขั้นตอน (“ฉันทำ X ได้อย่างไร?”) วิดีโอมักเข้าใจได้เร็วกว่าและยากต่อการตีความผิด

ประโยชน์หลักสำหรับนักเขียนเทคนิค:

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

การวางแผนเซสชันการบันทึก

วิดีโอเอกสารที่ดีเริ่มต้นก่อนที่คุณจะกดบันทึก

เขียนสคริปต์ขั้นตอนก่อน

เขียนทุกขั้นตอนราวกับว่าคุณกำลังเขียนขั้นตอนที่มีหมายเลข นี่จะกลายเป็นสคริปต์การบันทึกของคุณ หากขั้นตอนเขียนได้ยาก ก็จะบันทึกได้ยากเช่นกัน ใช้สิ่งนั้นเป็นสัญญาณในการลดความซับซ้อนของแนวทาง

เลือกโหมดการจับภาพที่เหมาะสม

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

ตัดสินใจว่าจะพูดอะไรและจะแสดงอะไร

ไม่ใช่ทุกอย่างต้องการคำบรรยาย การกระทำบางอย่างอธิบายตัวเองบนหน้าจอ วางแผนคำบรรยายของคุณเพื่อเพิ่มบริบทของ ทำไม ในขณะที่วิดีโอแสดง อย่างไร

การตั้งค่าการบันทึกสำหรับเอกสาร

ใช้การตั้งค่าเหล่านี้สำหรับการบันทึกคุณภาพเอกสาร:

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

การจับภาพอย่างมีประสิทธิภาพ

ชะลอความเร็วสำหรับการกระทำที่ซับซ้อน

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

หยุดชั่วคราวก่อนการกระทำสำคัญ

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

ใช้การจับภาพหน้าต่างเพื่อความเน้น

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

การตัดต่อสำหรับเอกสาร

ตัดอย่างเข้มข้น

วิดีโอเอกสารควรสั้นที่สุดเท่าที่จะเป็นไปได้ ลบออก:

• การหยุดชั่วคราวยาวขณะรอ UI ตอบสนอง
• ช่วงเวลาที่คุณนำทางออกจากพื้นที่ที่เกี่ยวข้อง
• ความพยายามซ้ำในการกระทำหนึ่ง

เพิ่มเอฟเฟกต์ซูมบนองค์ประกอบ UI ขนาดเล็ก

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

แนวทางปฏิบัติที่ดีที่สุดสำหรับการซูมเอกสาร:

• ซูมเข้า ก่อน คลิก ไม่ใช่หลัง
• คงการซูมไว้นานพอให้ผู้ชมอ่านป้ายหรือข้อความ
• กลับสู่มุมมองปกติเพื่อแสดงผลลัพธ์ทั้งหมดของการกระทำ

ใช้การเน้นเคอร์เซอร์

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

เน้นวิดีโอแต่ละรายการที่งานเดียว

ต้านทานการรวมขั้นตอนหลายขั้นตอนในวิดีโอยาวหนึ่งรายการ วิดีโอสั้นที่เน้นงานง่ายต่อการค้นหา แบ่งปัน และดูแลรักษาเมื่อ UI ผลิตภัณฑ์เปลี่ยนแปลง

การรวมวิดีโอเข้ากับเอกสาร

จับคู่วิดีโอกับขั้นตอนที่เขียน

วิดีโอและข้อความเสริมซึ่งกันและกัน คงขั้นตอนที่เขียนไว้ในเอกสารสำหรับผู้ใช้ที่ต้องการสแกน ฝังวิดีโอไว้เหนือหรือใต้ขั้นตอนสำหรับผู้ใช้ที่ต้องการดู

ใช้ชื่อไฟล์และชื่อเรื่องที่อธิบาย

ตั้งชื่อไฟล์วิดีโอและชื่อที่ฝังเพื่อสะท้อนงานเฉพาะ: create-api-key.mp4 ไม่ใช่ tutorial-video-3.mp4 สิ่งนี้ทำให้ไลบรารีเอกสารของคุณดูแลรักษาได้ในระดับใหญ่

รูปแบบการส่งออกสำหรับไซต์เอกสาร

สำหรับการฝังในแพลตฟอร์มเอกสาร (Confluence, Notion, GitBook, ReadMe):

• MP4 (H.264): ความเข้ากันได้ที่ดีที่สุดบนแพลตฟอร์มและเบราว์เซอร์
• ความละเอียด: 1280×720 หรือ 1920×1080 ขึ้นอยู่กับความหนาแน่นของเนื้อหา
• ขนาดไฟล์: คงให้ต่ำกว่า 50 MB ต่อวิดีโอหากเป็นไปได้ ไฟล์ขนาดใหญ่ทำให้การโหลดหน้าช้าลง

สร้างไลบรารีวิดีโอ

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

การบำรุงรักษา: คงวิดีโอให้ทันสมัย

วิดีโอเอกสารมีอายุการใช้งาน การอัปเดต UI ทำให้ล้าสมัยเร็วกว่าเนื้อหาที่เขียน บรรเทาสิ่งนี้โดย:

• บันทึกใหม่เมื่อมีการเปิดตัว UI หลัก: ให้ความสำคัญกับวิดีโอที่แสดงการนำทางที่เปลี่ยนแปลงหรือหน้าจอที่ออกแบบใหม่
• เพิ่มวันที่ “ตรวจสอบล่าสุด” ในคำอธิบาย: บอกผู้ใช้ว่าเนื้อหาทันสมัยเพียงใด
• คงการบันทึกให้สั้น: วิดีโอสั้นกว่าใช้ต้นทุนในการบันทึกใหม่น้อยกว่า

รายการตรวจสอบวิดีโอเอกสาร

ก่อนเผยแพร่การบันทึกเอกสารใดๆ:

• ขั้นตอนทั้งหมดมองเห็นได้และเรียงลำดับชัดเจน
• เคอร์เซอร์มองเห็นได้ตลอดเวลา
• ใช้เอฟเฟกต์ซูมกับองค์ประกอบ UI เล็กหรือสำคัญ
• ลบการหยุดชั่วคราวที่ไม่จำเป็นออก
• เสียงชัดเจนและไม่มีเสียงพื้นหลัง
• ความยาววิดีโอสั้นที่สุดเท่าที่งานอนุญาต
• ส่งออกในรูปแบบ MP4 ที่ความละเอียดที่เหมาะสม
• จับคู่วิดีโอกับขั้นตอนที่เขียนในเอกสาร

บทสรุป

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

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