Tản mạn: Kỹ sư và viết lách (1)

Là một kỹ sư công nghệ (software engineer), ắt hẳn ai cũng đã từng 😒, đang 😐, và sẽ 😟 phải viết những tài liệu kỹ thuật (technical docs) phục vụ cho công việc. Trong bài viết này, mình sẽ tâm tình cùng bạn những suy nghĩ cá nhân về việc viết lách liên quan đến công việc của một kỹ sư.

1 Thứ nhất, tại sao kỹ sư cần phải viết lách?

“Mình thích thì mình viết thôi!”. Ai nói được câu này cho 10 điểm về chỗ liền. Nếu bạn nói “thích viết blog” thì mình sẽ gật đầu tấm tắc khen, còn nếu bạn nói là thích viết technical docs thì hẳn bạn đã ở một đẳng cấp nào đó khác (mình) rồi.

Viết, nói chung, là một hình thức giao tiếp, truyền đạt thông tin. Viết technical docs là để truyền đạt thông tin về một chủ đề kỹ thuật nào đó. Dĩ nhiên còn nhiều hình thức truyền đạt thông tin khác như thuyết trình, đồ hoạ thông tin (infographic), mần Vlog… Nhưng hình thức viết (tức, dưới dạng văn bản) tỏ ra rất thông dụng trong công việc của kỹ sư, bởi:

• Có tính tái sử dụng cao.
• Có thể dễ dàng reference đến (còn lời nói thì gió bay mà). Thật ra đây là hệ quả của tính tái sử dụng.
• Có thể chỉnh sửa theo thời gian (nếu cần thiết). So với thuyết trình và Vlog, thì đây quả là một lợi thế lớn.
• …

2 Khi mình nói với sếp và đồng nghiệp rằng mình thích viết, câu này cắt nghĩa ra như sau:

• Mình thích chia sẻ ý tưởng, thông tin, và suy nghĩ với người khác. Và…
• Mình cảm thấy thoải mái nhất khi chia sẻ những ý tưởng, thông tin, và suy nghĩ này bằng hình thức viết.

Thiệt, viết xàm xàm, tản mạn kiểu vầy thì mình thấy còn dễ chịu. Còn viết những tài liệu kỹ thuật thì mình chỉ thấy cực thôi 😂… Đôi khi mình thấy viết tản mạn vầy thôi mà đã phải vò đầu bứt tai rồi. Phải chi mà mình đẹp trai hơn một chút, nói chuyện lưu loát hơn một chút thì mình đã mần Vlog nói nhăng nói cuội cho rồi, đâu phải ngồi đây gõ một chữ rồi xoá hai chữ như bây giờ.

3 Viết tài liệu kỹ thuật… cũng chẳng qua là một dạng viết lách. Cho nên nó cũng theo một vài mô tuýp chung và đòi hỏi một số kỹ năng viết nói chung. Ví dụ, cần xác định viết về chủ đề gì, độc giả là ai… Từ đó mới có bố cục và cách viết phù hợp.

Trong quá trình làm việc, sau nhiều lần viết docs này docs nọ, mình đúc kết một điều tâm đắc. Đó là, ngoài việc xác định chủ đề, độc giả, bước tiếp theo là xác định thể loại tài liệu. Các thể loại tài liệu thông dụng mà mình hay gặp phải là:

• Documentation
• Project plans/roadmaps
• Instructions & procedures (thường là how-to articles)
• Style guides
• Reports (báo cáo)
• Proposals (đề xuất)
• Announcements (thông báo)
• …

Việc xác định thể loại tài liệu giúp chúng ta định hướng bố cục bài viết rất nhiều. Chẳng hạn:

• Đối với những thông báo của team đến các kỹ sư từ các tech families khác về một thay đổi nào đó, sau khi đọc nội dung thay đổi, người ta thường quan tâm là “tui có cần phải mần gì hông?”. Cho nên, nếu thông báo đó được viết bởi mình thì sẽ luôn có một mục là “Action Required”. Khi mình đọc thông báo của người ta mình cũng thường kiếm cái mục này mà đọc.
• Đối với proposals (đề xuất), thường thì mình sẽ viết theo cấu trúc problems & solutions. Còn documentation thì chỉ thuần tuý là ghi chú lại một quy trình hoặc một chức năng nào đó, nên không bố cục theo kiểu problems & solutions.
• Đối với how-to articles, mình thường cố gắng viết kiểu chỉ dẫn từng bước (step-by-step instructions). Kiểu như: “Bước 1: muốn luyện bộ kiếm pháp này, khổ chủ phải tự cung 👻”.

4 Viết tài liệu kỹ thuật không có giống IELTS writing. Đừng có lấy mindset IELTS ra mà viết nhé. Đây không phải là dịp để bạn phô trương vốn từ vựng học thuật và thi triển các cấu trúc ngữ pháp phức tạp. Đối với mình, một tài liệu kỹ thuật tốt là một tài liệu được trình bày một cách khoa học và dễ hiểu. Viết càng dễ hiểu, dễ đọc càng tốt. Mình nhớ có vài lần viết documentation, được Technical Writer review, chỉnh sửa. Sau hồi thấy bản sửa mấy cái câu kép dài dài của mình viết thành 2 câu đơn hết. Mà công nhận là sau khi sửa đọc dễ hơn nhiều 😄. Lesson learned!

5 Viết già, viết riết rồi quen thôi. Như mình không có khiếu viết lách thì tốn nhiều thời gian và công sức hơn thôi (chứ có khiếu thì đã thích cmn rồi 😐). Có mấy cái tasks nọ cần phải viết code và viết documentation. Mình viết code một ngày xong, còn viết documentation thì mất… 2-3 ngày 😞.

Ấy mới thấy việc diễn giải suy nghĩ của mình (một cách logic) ra chữ viết nó khó nhường nào. Cơ mà “what doesn’t kill you makes you stronger”. Bằng việc viết ra, suy nghĩ của bạn sẽ trở nên logic hơn, hiểu biết của bạn sẽ được củng cố hơn. (Mình đang tự an ủi vậy, để mai mốt còn chịu khó viết. Ai có bằng chứng phủ nhận luận điểm trên thì cứ làm thinh nha 😂)

…

Tản mạn đêm khuya đến đây thôi. Bye!