Quay màn hình cho người viết tài liệu kỹ thuật

Ảnh chụp màn hình tĩnh và các đoạn văn dài chỉ có tác dụng hạn chế. Người dùng bỏ qua những đoạn văn dài, hiểu sai chú thích và bỏ lỡ các bước quan trọng ẩn trong danh sách được đánh số. Quay màn hình giải quyết những vấn đề này bằng cách chỉ ra chính xác những gì cần làm, theo thứ tự, không có sự mơ hồ.

Hướng dẫn này giải thích cách người viết tài liệu kỹ thuật có thể sử dụng Recorded để tạo ra các video chất lượng tài liệu giúp giảm tải hỗ trợ và cải thiện việc sử dụng sản phẩm.

Tại sao video thuộc về tài liệu kỹ thuật

Tài liệu dựa trên văn bản hoạt động tốt cho tài liệu tham khảo — tài liệu API, tùy chọn cấu hình, giải thích khái niệm. Nhưng đối với nội dung thủ tục (“Tôi làm X như thế nào?”), video thường dễ hiểu hơn và khó bị hiểu sai hơn.

Lợi ích chính cho người viết tài liệu kỹ thuật:

• Ít mơ hồ hơn: Người xem thấy trạng thái UI chính xác, không phải một mô tả gần đúng
• Ít yêu cầu hỗ trợ hơn: Người dùng có thể theo dõi video hiếm khi mở yêu cầu cho cùng một nhiệm vụ
• Onboarding nhanh hơn: Người dùng mới học quy trình phức tạp mà không cần hướng dẫn
• Độc lập với ngôn ngữ: Video được làm tốt vượt qua rào cản ngôn ngữ tốt hơn văn bản được dịch

Lập kế hoạch phiên quay

Video tài liệu tốt bắt đầu trước khi bạn nhấn nút quay.

Trước tiên, viết kịch bản các bước

Viết từng bước như thể bạn đang viết một quy trình được đánh số. Đây sẽ là kịch bản quay của bạn. Nếu một bước khó viết, nó sẽ khó quay — hãy dùng điều đó như một tín hiệu để đơn giản hóa cách tiếp cận.

Chọn chế độ chụp phù hợp

• Chụp cửa sổ: Sử dụng cho hầu hết công việc tài liệu. Nó cô lập ứng dụng khỏi sự lộn xộn của màn hình nền và cung cấp cho người xem một giao diện sạch và tập trung.
• Toàn màn hình: Phù hợp khi bạn cần hiển thị ngữ cảnh giữa nhiều ứng dụng hoặc tương tác ở cấp hệ thống.
• Vùng tùy chỉnh: Hữu ích để chụp một bảng hoặc widget cụ thể trong một ứng dụng lớn hơn.

Quyết định nói gì và hiển thị gì

Không phải mọi thứ đều cần lồng tiếng. Một số hành động tự giải thích trên màn hình. Lập kế hoạch lồng tiếng để thêm ngữ cảnh của tại sao, trong khi video hiển thị như thế nào.

Cài đặt quay cho tài liệu

Sử dụng các cài đặt này cho các bản quay chất lượng tài liệu:

• Độ phân giải: Chụp ở độ phân giải hiển thị gốc. Giảm kích thước khi xuất nếu cần.
• Tốc độ khung hình: 30 fps là lý tưởng — đủ mượt mà cho các tương tác UI mà không làm phình to kích thước tệp.
• Khả năng hiển thị con trỏ: Luôn giữ con trỏ hiển thị. Người xem cần theo dõi nơi bạn đang nhấp.
• Âm thanh hệ thống: Tắt nếu không liên quan. Âm thanh thông báo và tiếng ồn nền làm phân tâm khỏi lời bình.

Chụp hiệu quả

Chậm lại cho các hành động phức tạp

Di chuyển con trỏ một cách có chủ ý, đặc biệt khi thực hiện các tương tác nhiều bước như kéo thả, phím tắt hoặc menu ngữ cảnh. Điều có vẻ chậm trong quá trình quay trông tự nhiên khi phát lại.

Dừng lại trước các hành động quan trọng

Dừng nửa giây trước mỗi hành động quan trọng giúp người xem có thời gian định hướng trước khi có gì đó thay đổi. Điều này đặc biệt hữu ích cho các phím tắt, nơi không có tín hiệu UI nào hiển thị.

Sử dụng chụp cửa sổ để duy trì sự tập trung

Chỉ chụp cửa sổ ứng dụng giữ tài liệu của bạn sạch sẽ. Người xem sẽ không bị phân tâm bởi màn hình nền, các cửa sổ đang mở khác hoặc tab trình duyệt.

Chỉnh sửa cho tài liệu

Cắt xén một cách quyết đoán

Video tài liệu phải ngắn nhất có thể. Xóa:

• Những khoảng dừng dài chờ UI phản hồi
• Những lúc bạn điều hướng ra khỏi khu vực liên quan
• Các lần thử lặp lại một hành động

Thêm hiệu ứng thu phóng trên các phần tử UI nhỏ

Nhiều tình huống tài liệu liên quan đến các nút nhỏ, biểu tượng hoặc trường văn bản. Sử dụng hiệu ứng thu phóng của Recorded để kéo người xem vào gần hơn tại thời điểm tương tác — sau đó thu nhỏ để hiển thị kết quả.

Thực hành tốt nhất cho thu phóng tài liệu:

• Thu phóng trước khi nhấp, không phải sau
• Giữ thu phóng đủ lâu để người xem đọc bất kỳ nhãn hoặc văn bản nào
• Quay lại chế độ xem bình thường để hiển thị kết quả đầy đủ của hành động

Sử dụng tô sáng con trỏ

Bật tô sáng con trỏ để làm rõ các điểm nhấp. Một xung hình ảnh khi nhấp xóa bỏ mọi nghi ngờ về những gì đã được chọn. Điều này đặc biệt hữu ích cho các hành động trong giao diện dày đặc.

Tập trung mỗi video vào một nhiệm vụ

Chống lại sự cám dỗ kết hợp nhiều quy trình vào một video dài. Video ngắn, tập trung vào nhiệm vụ dễ tìm, chia sẻ và duy trì hơn khi UI sản phẩm thay đổi.

Tích hợp video vào tài liệu của bạn

Ghép video với các bước được viết

Video và văn bản bổ sung cho nhau. Giữ các bước được viết trong tài liệu của bạn cho những người dùng thích lướt qua. Nhúng video trực tiếp trên hoặc dưới quy trình cho những người dùng thích xem.

Sử dụng tên tệp và tiêu đề mô tả

Đặt tên tệp video và tiêu đề nhúng để phản ánh nhiệm vụ cụ thể: create-api-key.mp4, không phải tutorial-video-3.mp4. Điều này làm cho thư viện tài liệu của bạn có thể duy trì ở quy mô lớn.

Định dạng xuất cho các trang tài liệu

Để nhúng vào các nền tảng tài liệu (Confluence, Notion, GitBook, ReadMe):

• MP4 (H.264): Khả năng tương thích tốt nhất trên các nền tảng và trình duyệt
• Độ phân giải: 1280×720 hoặc 1920×1080 tùy thuộc vào mật độ nội dung
• Kích thước tệp: Giữ dưới 50 MB mỗi video nếu có thể — tệp lớn làm chậm tải trang

Tạo thư viện video

Duy trì một thư mục có cấu trúc của tất cả các video tài liệu của bạn bên cạnh các tệp nguồn. Điều này giúp dễ dàng xác định và quay lại nội dung lỗi thời khi sản phẩm phát hành các thay đổi UI.

Bảo trì: Giữ video cập nhật

Video tài liệu có vòng đời. Các bản cập nhật UI làm cho chúng lỗi thời nhanh hơn nội dung viết. Giảm thiểu điều này bằng cách:

• Quay lại khi có bản phát hành UI lớn: Ưu tiên bất kỳ video nào hiển thị điều hướng đã thay đổi hoặc màn hình được thiết kế lại
• Thêm ngày “xác minh lần cuối” vào mô tả: Cho người dùng biết nội dung có bao nhiêu thời hạn
• Giữ bản quay ngắn: Video ngắn hơn rẻ hơn để quay lại so với hướng dẫn dài

Danh sách kiểm tra video tài liệu

Trước khi xuất bản bất kỳ bản quay tài liệu nào:

• Tất cả các bước đều hiển thị và được sắp xếp rõ ràng
• Con trỏ hiển thị mọi lúc
• Hiệu ứng thu phóng được áp dụng cho các phần tử UI nhỏ hoặc quan trọng
• Đã xóa các khoảng dừng không cần thiết
• Âm thanh rõ ràng và không có tiếng ồn nền
• Thời lượng video ngắn nhất có thể
• Xuất ở định dạng MP4 với độ phân giải phù hợp
• Video được ghép với các bước viết trong tài liệu

Kết luận

Quay màn hình là một trong những công cụ ít được sử dụng nhất trong bộ công cụ của người viết tài liệu kỹ thuật. Khi được sử dụng cùng với các quy trình được viết tốt, chúng giảm sự mơ hồ, cải thiện niềm tin của người dùng và giảm khối lượng hỗ trợ cho các nhiệm vụ được đề cập.

Bắt đầu với các yêu cầu hỗ trợ phổ biến nhất của bạn — các vấn đề mà người dùng nêu ra thường xuyên nhất là chính xác nơi mà một bản quay rõ ràng, tập trung sẽ có tác động lớn nhất.