- Nên có nhiều hình ảnh minh họa trực quan.
- Dễ dàng cung cấp cho người mới một cái nhìn tổng thể.
- Nên làm phần mềm đơn giản để người dùng có thể hiểu được cách sử dụng mà không cần đọc documents.
- Nên liệt kê theo step by step.
12 Nguyên tắc khi viết tài liệu kỹ thuật
- Xác định bạn đang viết cho ai?
- Xác định thông tin cần thiết?
- Xác định làm sao để giải quyết vấn đề của người dùng và phong cách để mình áp dụng?
- Xác định giá trị có thể chuyển giao tạo ra?
- Xác định công cụ để tạo ra nội dung?
- Xác định kênh thông tin mà mình sẽ sử dụng?
- Viết tài liệu
- Sử dụng hình ảnh và video một cách thích hợp
- Công khai một bản đầu tiên
- Thu thập góp ý và cải thiện
- Lặp lại