Các nguyên tắc để hoàn thiện technical writing gọn gàng, rõ ràng

1. Viết bằng văn phong hội thoại hằng ngày thay vì giọng điệu quá kiểu cách.

2. Đọc thành tiếng bài viết và kiểm tra xem nó có nghe như lời của người thật hay không.

3. Luôn cân nhắc mối quan tâm của người dùng, đặc điểm của họ, trình độ học vấn và kinh nghiệm, thời gian và địa điểm họ đọc bài, cũng như môi trường làm việc của họ.

4. Chọn lọc và cung cấp những thông tin mà người dùng có thể thắc mắc và thực sự cần.

5. Hãy tính đến việc không phải mọi người dùng đều hiểu sản phẩm và công nghệ liên quan ở mức như chuyên gia.

6. Ngay cả sau khi đã xuất bản, hãy kịp thời phản ánh các thay đổi về thuật ngữ, cách sử dụng và tính năng.

7. Không dùng tính từ bổ nghĩa không cần thiết, tiểu từ không cần thiết và trợ động từ dư thừa.

8. Không dùng cấu trúc bị động kép.
   Ví dụ: 잡혀지다 (→ 잡히다), 쓰여지다 (→ 쓰이다), 읽혀지다 (→ 읽히다), 보여지다 (→ 보이다), 잊혀지다 (→ 잊히다), 찢겨지다 (→ 찢기다)

9. Không gắn hậu tố số nhiều vào từ đứng sau 여러/많은/다양한/모든.

10. Nếu bắt buộc phải dùng thuật ngữ chuyên môn, hãy giải thích thuật ngữ đó ngay trong bài viết.

11. Khi viết cho những người làm trong một ngành hoặc nghề cụ thể, hãy dùng thuật ngữ của chính ngành hoặc nghề đó.

12. Sau khi hoàn thành bài viết và nghỉ ngơi một chút, hãy đọc lại nó.

13. Nếu bạn viết bài trên desktop, hãy đọc lại trên smartphone hoặc tablet PC. In ra giấy để đọc cũng tốt.

14. Đọc thành tiếng bài viết và kiểm tra xem nó nghe như thế nào.

15. Sửa những câu khó nói hoặc nghe gượng gạo.

16. Hỏi reviewer những điều như “nội dung bài có dễ hiểu không”, “mạch bài có ổn không”, “có gì cần bổ sung không”. Bạn cũng có thể đặt câu hỏi cụ thể về những phần cần feedback.

17. Nếu bài viết đề cập đến một tính năng cụ thể, hãy kiểm tra xem tính năng đó có hoạt động đúng như bài mô tả hay không.

18. Xác nhận rằng “tên tính năng, tên menu hoặc nội dung trên màn hình có khớp với nội dung bài viết hay không”.

19. Dùng công cụ kiểm tra chính tả để rà lỗi gõ sai và lỗi khoảng trắng.
    Công cụ gợi ý: trình kiểm tra chính tả của Đại học Quốc gia Pusan, trình kiểm tra chính tả Daum

20. Xem các ví dụ trong quy tắc phiên âm từ mượn của Viện Quốc ngữ Quốc gia để kiểm tra lỗi ghi từ ngoại lai.

[princox]

Lỗi trong cách phiên âm từ ngoại lai thực sự là một vấn đề khá lớn,,
method, angel là những từ lẽ ra trong nhiều trường hợp phải được viết là mesodeu, einjeol.

Vấn đề là “cách viết sai” lại được dùng nhiều hơn, thậm chí còn SEO tốt nữa.. đúng là một tình huống vô lý.

Rốt cuộc đâu mới là đáp án đúng đây..? hu hu hu

[roxie]

Mình nghĩ vấn đề nằm ở cách ghi không phản ánh được thực tế.

[ah2dius]

https://meetup.nhncloud.com/posts/355

Dù có thể không phải là đáp án đúng tuyệt đối, nhưng cũng rất đáng để tham khảo ~

[princox]

Đúng thì mỗi cái lần lượt được ghi là "method" và "Angel". Ngoài ra, trong trường hợp object, phía MS cũng đang thuần hóa thành "đối tượng" nữa..

Quả thật technical writing rất khó.

[pugh123]

Cảm ơn vì nội dung hay.