วิดีโอหรือเอกสาร: เมื่อไหร่ควรอัดหน้าจอ เมื่อไหร่ควรเขียน

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

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

คู่มือนี้ให้วิธีตัดสินใจที่ทำซ้ำได้ ใช้เวลาราวสามสิบวินาที ก่อนลงมือ

แบบทดสอบสามสิบวินาที

ถามสามคำถามเกี่ยวกับสิ่งที่คุณกำลังจะบันทึกไว้

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

ได้คำตอบฝั่ง “วิดีโอ” สองข้อ ให้อัด ได้ฝั่ง “ข้อความ” สองข้อ ให้เขียน ถ้าก้ำกึ่ง แปลว่าคุณน่าจะต้องใช้ทั้งคู่ ซึ่งง่ายกว่าที่คิด และจะอธิบายด้านล่าง

เมื่อวิดีโอชนะ

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

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

การรายงานบั๊กและการทำซ้ำปัญหา วิดีโอแสดงลำดับที่แน่นอน จังหวะที่แน่นอน และสถานะที่แน่นอน ตัดวงจร “ผมทำซ้ำไม่ได้” ออกไปทั้งหมด

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

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

การสื่อสารน้ำเสียง ฟีดแบ็ก การตัดสินใจที่มีความละเอียดอ่อน และอะไรก็ตามที่อาจอ่านแล้วรู้สึกห้วน จะสื่อสารได้ดีกว่ามากเมื่อมีเสียงและใบหน้าประกอบ

เมื่อข้อความชนะ

เอกสารอ้างอิง ค่าคอนฟิก พารามิเตอร์ API คีย์ลัด รหัสข้อผิดพลาด ทุกอย่างที่คนเปิดหาไม่ใช่เรียนรู้

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

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

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

งานกฎหมาย งานคอมไพลแอนซ์ และทุกอย่างที่ต้องใช้ถ้อยคำแม่นยำ ถ้าความแม่นยำสำคัญกว่าความเข้าใจง่าย ให้เขียน ตรวจทาน และทำเวอร์ชัน

เนื้อหาที่ต้องแปลจำนวนมาก ข้อความแปลเป็นสิบสี่ภาษาได้ในต้นทุนต่ำ การอัดเสียงบรรยายใหม่ไม่ใช่แบบนั้น

รูปแบบที่ทีมส่วนใหญ่ต้องการจริง ๆ

เอกสารที่ดีที่สุดมักไม่ใช่อย่างใดอย่างหนึ่ง แต่เป็นวิดีโอสั้นที่มีโครงเป็นข้อความ

รูปแบบที่ใช้ได้จริง:

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

คนที่ต้องการภาพรวมก็ดู คนที่ต้องการค่าหนึ่งค่าก็กวาดตาอ่าน ไม่มีฝ่ายไหนเสียเปรียบ

ทำวิดีโอให้สั้นพอที่จะยังถูกต้องอยู่เสมอ

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

กฎที่ทำให้คลังวิดีโอดูแลรักษาได้:

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

ลดต้นทุนของการอัด

การตัดสินใจว่า “เขียนเอาดีกว่า” ส่วนใหญ่แปลว่า “การอัดรู้สึกเหมือนงานโปรดักชัน” การลดต้นทุนนี้เปลี่ยนสมการของทั้งทีม

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

นโยบายทีมแบบง่าย

ถ้าอยากจบการถกเถียงนี้ ให้เขียนไว้สี่บรรทัด

1. ข้อมูลอ้างอิงและการตั้งค่า → ข้อความ เสมอ
2. เวิร์กโฟลว์ เดโม และฟีดแบ็ก → วิดีโอ ไม่เกินห้านาที
3. อะไรก็ตามที่ใช้ระหว่างทำงาน → เช็กลิสต์ที่เป็นข้อความ พร้อมวิดีโอภาพรวมเป็นตัวเลือกเสริม
4. อะไรก็ตามที่เปลี่ยนบ่อยกว่าไตรมาสละครั้ง → ข้อความ ยกเว้นภาพคือหัวใจของเรื่อง

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

บทสรุป

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