10 điều răn về technical writing dành cho lập trình viên

<p>- Không lược bỏ các thành phần câu bắt buộc<br /> - Giữ sự tương ứng giữa các thành phần câu<br /> - Sử dụng trợ từ đúng cách<br /> - Hạn chế dùng thể bị động/thể sai khiến<br /> - Hạn chế phủ định kép<br /> - Sử dụng cách diễn đạt rõ ràng<br /> - Phân biệt thứ tự và danh sách<br /> - Tận dụng lối viết gạch đầu dòng<br /> - Kiểm tra chính tả/khoảng trắng<br /> - Kiểm tra cách viết từ vay mượn</p>

[xguru]

<p>- 4 nguyên tắc lớn của technical writing https://vi.news.hada.io/topic?id=5409<br /> - Kỹ thuật biên tập lại - cách lập trình viên viết tài liệu kỹ thuật https://vi.news.hada.io/topic?id=5446</p&gt;

[hongminhee]

<p>Với lập trình viên, về cơ bản chỉ cần chú ý đến quy tắc phiên âm từ mượn của tiếng Anh, nhưng nếu ghi nhớ rằng quy tắc phiên âm từ mượn trong tiếng Hàn không dựa trên chính tả mà dựa trên cách phát âm thực tế, và vì tiếng Anh không phản ánh phát âm một cách chuẩn xác qua chính tả nên cần nhìn vào ký hiệu phát âm chứ không phải cách viết của từ để chuyển sang, thì sẽ ít mắc lỗi hơn.<br /> <br /> Nếu không chắc, hãy 1) thử tra nguyên từ tiếng Anh đó trong từ điển tiếng Hàn, nếu có thì dùng cách ghi ở đó, và 2) nếu không có thì tra từ đó trong từ điển tiếng Anh, xem Ký hiệu Ngữ âm Quốc tế (IPA) rồi suy ra cách ghi. Tuy nhiên, quy định về phiên âm từ mượn đối với tiếng Anh lấy phát âm Anh-Anh làm chuẩn, nên đôi khi cũng xuất hiện những cách ghi khá bất ngờ.<br /> <br /> Nếu không phải tiếng Anh thì dùng những công cụ như Hangulize(https://hangulize.org/) sẽ tiện hơn, nhưng vì chính tả tiếng Anh quá lộn xộn nên khó xử lý máy móc theo kiểu đó, và nghe nói nhất định phải cần đến từ điển. (Với các từ mới chẳng hạn, đôi khi chúng chưa được đưa vào từ điển, nên có trường hợp phải kiểm tra xem mọi người thực sự phát âm từ đó như thế nào trên những nơi như YouTube.)</p>