Posted by Gần đây, chủ đề UX Writing ngày càng được quan tâm nhiều hơn với vai trò quan trọng trong việc mang lại trải nghiệm tốt nhất cho người dùng khi tiếp nhận thông tin được truyền tải từ Product. Dù gần đây không nhận được nhiều sự chú ý bằng nhưng việc trao đổi và truyền tải thông tin trong nội bộ qua các tài liệu kỹ thuật (technical writing) cũng quan trọng không kém. Vậy Technical Writing là gì?
Technical Writing không chỉ là các tài liệu liên quan đến kỹ thuật như code hoặc manual mà có thể là bất cứ tài liệu nào được sử dụng với mục đích truyền tải thông tin trong nội bộ công ty. Ví dụ, một email nội dung bố cục rõ ràng, gãy gọn hay một thông báo nội bộ công ty có tính truyền tải cao đến đồng nghiệp đều là technical writing. Trong một team IT, thông thường nhiệm vụ của người làm technical writing sẽ là xử lý các nội dung liên quan đến thuật ngữ hoặc giải thích kỹ thuật từ lập trình viên sao cho dễ hiểu, rồi phân phối nó đến người đọc và kiêm luôn vị trí quản lý. Thông thường họ sẽ tham gia từ giai đoạn đầu của dự án để lên kế hoạch cũng như tiến hành việc tài liệu hóa (documentation).
Vậy nên, người viết nội dung kỹ thuật có thể là một nhân viên chuyên đảm nhận viết tài liệu với title Technical Writer hoặc bất kỳ ai tham gia vào việc viết những tài liệu nêu trên. Một Product là thành quả của sự hợp tác giữa nhiều bộ phận khác nhau với chuyên môn khác nhau, nên dù người viết là ai thì technical writing cần đảm bảo khả năng truyền đạt hiệu quả để người đọc dễ hiểu nhất có thể.
Hôm nay tôi sẽ cùng các bạn tìm hiểu 4 nguyên tắc khi thực hành technical writing, cùng những ví dụ trực quan dễ hiểu nhất đi kèm, hi vọng có thể giúp được các bạn mới tiếp cận lĩnh vực này tập luyện viết tốt hơn.
Nguyên tắc 1: Rõ ràng (Clarity)
Một nội dung rõ ràng không sử dụng từ khóa/câu chủ đề mơ hồ. Nội dung phải rõ ràng để độc giả có thể hiểu ngay nội dung kỹ thuật trong một lần đọc mà không bị mơ hồ hay nhầm lẫn. Nếu một nội dung phải khiến độc giả đọc đi đọc lại nhiều lần và gây khó hiểu thì đó là nội dung không rõ ràng.
Nội dung không rõ ràng thường xuất phát từ việc người viét không nắm rõ đối tượng độc giả mình hướng tới. Suy nghĩ “cái này ai cũng biết” rất nguy hiểm vì mỗi người đều có chuyên môn và kiến thức nền khác nhau. Kể cả trao đổi giữa người cùng chuyên môn với nhau như giữa các lập trình viên, thì việc mỗi người có cấp bậc và kinh nghiệm khác nhau cũng tạo nên nhiều khác biệt về kiến thức. Để đảm bảo tính rõ ràng, hãy luôn viết đầy đủ nội dung cần truyền đạt từ A đến Z, đừng giản lược kiến thức mà người viết cho là đơn giản. Thời gian viết ra rõ ràng một lần sẽ ít hơn việc (nhiều) người đọc hỏi lại người viết và người viết giải thích thêm (nhiều) lần nữa.
Nguyên tắc 2: Cô đọng (Conciseness)
Văn bản kỹ thuật cô đọng bao gồm câu chữ gãy gọn, từ ngữ đơn giản và dễ hiểu với mục tiêu giúp người đọc hiểu nhanh, chính xác. Suy nghĩ câu văn phải phức tạp, phải chứa đựng nhiều nội dung thì mới có giá trị là một sai lầm lớn khi viết văn bản kỹ thuật.
Trong các văn bản kỹ thuật, câu đơn là cách có thể truyền tải nội dung cô đọng nhất nhất. Nguyên tắc cô đọng này không những trong văn bản kỹ thuật mà trong văn bản thông thường cũng có thể áp dụng.
Nguyên tắc 3: Chính xác (Accuracy)
Nguyên tắc này yêu cầu truyền đạt thông tin cần thiết đến độc giả một cách chính xác nhất, tuyệt đối không mắc lỗi về kỹ thuật. Một nội dung kỹ thuật có thể thiếu tính minh bạch và tính cô đọng nhưng chỉ cần nội dung đó có tính chính xác thì độc giả dù có tốn thời gian hơn để nghiên cứu nhưng cuối cùng họ vẫn hiểu được. Tuy nhiên nếu nội dung kỹ thuật đưa ra thông tin không chính xác sẽ khiến độc giả không bao giờ hiểu được dù có tốn thời gian bao nhiêu.
Nguyên tắc 4: Nhất quán (Coherence):
Tính nhất quán yêu cầu sự thống nhất trong cách sử dụng thuật ngữ, cụm từ hay văn phong trong văn bản kỹ thuật. Trong các văn bản mang tính sáng tạo (creative writing) chúng ta có thể dùng nhiều từ để diễn tả một sự việc giống nhau nhằm gây hứng thú cho độc giả. Tuy nhiên với technical writing, sự nhất quán là yếu tố bắt buộc vì không thể để bất cứ hiểu lầm nào xảy ra với độc giả được. Đặc biệt việc đề cập một từ trước đó rồi lặp lại nó nhưng bằng một từ khác có thể khiến độc giả bị rối, kết cục khiến hiệu quả của văn bản kỹ thuật bị giảm xuống.
Lời kết:
Trên đây là 4 nguyên tắc cơ bản không chỉ technical writer mà thậm chí các lập trình viên cũng có thể tham khảo để cải thiện hơn chất lượng techincal writing do mình soạn thảo. Tầm quan trọng của khả năng viết văn bản kỹ thuật cũng được công nhận ở môi trường học thuật khi nhiều yêu cầu tốt nghiệp của nhiều đại đại học về kỹ thuật hàng đầu thế giới bao gồm môn về technical writing. Sinh viên cao học tại MIT College of Engineering phải vượt qua kỳ thi GWE (Graduate Writing Exam) về kỹ năng technical writing.