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

<p>- Biên tập lại: khi viết, suy nghĩ nhiều lần để sửa chữa và gọt giũa câu chữ. Hoặc chính công việc đó<br /> - Lý do cần biên tập lại<br /> - Mẹo biên tập lại<br /> → Làm cho bài viết của mình trở nên xa lạ: đọc thành tiếng, đọc lại sau một thời gian, in ra giấy để đọc<br /> → Peer review <br /> → Sử dụng checklist <br /> → Mẹo chỉnh sửa câu văn để tăng khả năng đọc hiểu <br /> ① Sắp xếp và chỉnh sửa thành câu ngắn<br /> ② Xóa các biểu đạt không cần thiết<br /> ③ Biến đổi thành một bài viết có tính logic</p>

[budlebee]

<p>Tôi nhớ đến các nguyên tắc viết của Stephen King. Dù là tiểu thuyết nên cũng có những điểm khác với technical writing, nhưng nếu viết ra theo những gì tôi nghĩ đến thì:<br /> <br /> - Sử dụng những câu ngắn và đơn giản.<br /> - Tôi viết bản nháp đầu tiên xong rồi cất vào ngăn kéo, 6 tháng sau lấy ra đọc lại.<br /> - Bản chỉnh sửa sẽ lược bớt 10% so với bản nháp đầu tiên. <br /> - Đọc to bài viết lên sẽ giúp phát hiện những chỗ câu văn còn gượng gạo. <br /> - Xác định cụ thể đối tượng sẽ đọc bài viết rồi mới viết. Trong trường hợp của tôi thì đó là vợ tôi. </p>

[xguru]

<p>Dạo này các anh chị technical writing của Kakao Enterprise viết rất nhiều bài hay. Rất đáng để đăng ký theo dõi blog!</p>