Giới thiệu về các phương pháp trong Technical Writing

Ở Briswell, giao tiếp là hoạt động công việc diễn ra thường xuyên, dù là bằng lời nói hay trên văn bản. Chính vì vậy mà chúng mình cũng không ít lần hiểu lầm hoặc gặp khó khăn trong việc truyền đạt và hiểu được điều đối phương muốn nói. Để khắc phục điều này, chúng mình đã cùng nhau tham gia một môn học có tên là Technical Writing.

Technical Writing là gì nhỉ? Đây là cách viết truyền tải chính xác và rõ ràng các nội dung mang tính chuyên môn hoặc thông tin mang tính kỹ thuật đến với một đối tượng người đọc nhất định. Để dễ hình dung hơn, một ví dụ trong đời sống hằng ngày của chúng ta có sử dụng phương pháp viết này chính là các bản hướng dẫn sử dụng được đính kèm khi mua tủ lạnh, máy giặt,… mà đôi khi chúng ta thường quăng vào một góc. Nghe có vẻ khô khan và cũng khá hợp lý khi chúng bị “quăng vào một góc” nhỉ. 

Tuy ban đầu mình cũng đã có cùng tâm thế đó nhưng sau khi học xong môn học này, mình đã bỏ túi được một vài phương pháp mà mình nghĩ là có thể cải thiện được khả năng giao tiếp của bản thân. Vì vậy, trước khi quyết định xem có nên “quăng vào một góc” không thì hãy điểm qua một vài phương pháp cùng mình nhé.

1. Phương pháp điều chỉnh tài liệu cho phù hợp với người đọc

Mỗi người đều có những trải nghiệm, kiến thức khác nhau nên cách tiếp nhận đối với cùng một vấn đề cũng khác nhau. Ví dụ khi nói về nguyên nhân gây lỗi với một người không có nền tảng IT, lập trình viên giải thích như sau: 

     ・Chmod là 755 nên hiện tại người dùng này không thể tạo được thư mục.

Lúc này, người không có nền tảng về IT sẽ không hiểu được chmod là gì, 755 là gì, tại sao 755 lại có liên quan đến việc tạo thư mục? Vì vậy, để đối phương có thể dễ dàng tiếp thu thì có thể giải thích lại như sau:

     ・Vì hệ thống đang được phân quyền sao cho ai là chủ sở hữu của thư mục nào thì mới có khả năng tạo tệp tin trong thư mục đó, và người dùng hiện tại không phải là chủ sở hữu của thư mục nên không có quyền tạo thư mục con trong đó.

Câu trên mặc dù được diễn giải dài hơn nhưng nó giúp cho người không có kiến thức về IT cũng có thể hình dung được nguyên nhân lỗi. Vì vậy khi giao tiếp, chúng ta cần phải xem đối phương đã nắm bắt được những thông tin gì và chưa nắm bắt được những thông tin gì, từ đó có cách trình bày phù hợp.

2. Phương pháp dùng thuật ngữ nhất quán

Ví dụ để mô tả chức năng của một màn hình, tài liệu viết như sau: 

     ・Hệ thống sẽ lấy tập tin được lưu trong thư mục upload_file_2024 và hiển thị lên màn hình. Khi người dùng muốn tải lên tập tin mới thì lưu tập tin này trong directory upload_file_2024.

Đọc đoạn văn trên bạn có bị bối rối liệu “thư mục upload_file_2024” và “directory upload_file_2024” có phải là cùng một thư mục hay không? Đó là do đoạn văn trên đã mắc lỗi dùng thuật ngữ không nhất quán. Có thể sửa lại như sau:

     ・Hệ thống sẽ lấy tập tin được lưu trong thư mục upload_file_2024 và hiển thị lên màn hình. Khi người dùng muốn tải lên tập tin mới thì cũng lưu tập tin này trong thư mục upload_file_2024.

Đoạn văn trên vì dùng cùng một thuật ngữ là “thư mục” nên người đọc có thể hiểu được rằng nơi để lấy tệp tin và nơi lưu tệp tin đều là “upload_file_2024”. Vì vậy, khi trình bày một thông tin nào đó, bạn cần kiểm tra xem các thuật ngữ được diễn đạt trong đó đã nhất quán chưa. Việc sử dụng thuật ngữ nhất quán không chỉ giúp người đọc nắm bắt được nội dung tốt hơn mà còn giúp tăng độ tin cậy cho thông tin muốn truyền đạt.

3. Phương pháp lược bỏ các từ ngữ không cần thiết

Khi nói, bạn có thường hay thêm những từ ngữ thể hiện cảm xúc hay các từ đồng nghĩa lặp đi lặp lại hay không? Trong đối thoại hằng ngày thì việc bộc lộ cảm xúc giúp cho câu chuyện trở nên sinh động hơn, nhưng khi cần bàn bạc, thảo luận về một vấn đề gì đó thì cần diễn đạt ý bản thân muốn truyền đạt một cách đúng, đủ và ngắn gọn nhất có thể. Chẳng hạn khi nói: 

     ・Việc sửa lỗi thật sự rất chậm và tốn thời gian nên đã gây ra nhiều thiệt hại cho khách hàng.

Ở đây chỉ cần nói:

     ・Vì việc sửa lỗi mất thời gian nên đã gây ra nhiều thiệt hại cho khách hàng.

Mặc dù không cần thêm ý “thật sự rất chậm” nhưng người đọc cũng có thể hiểu được việc sửa lỗi đã tốn thời gian đúng không nào? Việc diễn đạt ngắn gọn giúp người đọc có thể nắm bắt được trọng tâm câu chuyện và tăng tính dễ hiểu cho văn bản đấy nhé.

Trên đây mình đã trình bày ba phương pháp mà mình cảm thấy hữu ích trong Technical Writing. Sau khi đọc xong các bạn có muốn tiếp tục tìm hiểu thêm về phương pháp này không nào? Nếu hứng thú thì các bạn hãy tham khảo tài liệu đầy đủ đã được Briswell biên soạn ở link dưới đây nhé!

Training Technical Writing – Công ty Briswell Việt Nam – Speaker Deck

Nguồn tham khảo:

Technical Writing Courses