Nếu bạn bị buộc tội viết một tài liệu được cho là hướng dẫn người khác cách làm một cái gì đó, thì cách làm ngày nay ít nhiều sẽ ném các phương thức cũ ra khỏi cửa sổ.
1. Tiêu đề bom lớn
Bạn sẽ nhận thấy các tiêu đề trên PCMech, chẳng hạn như tiêu đề ngay trên câu này, là rất lớn. Điều này là do họ dễ dàng nhìn thấy, đọc và biết bạn đang ở đâu trong tài liệu.
2. Ít từ
Nhầm đường:
Tài liệu sau đây giải thích cách sử dụng và vận hành Fanny Whacker 2000.
Đúng cách:
Hướng dẫn cách sử dụng Fanny Whacker 2000
Luôn nhớ cụm từ này khi viết tài liệu: NHẬN ĐIỂM NHƯ NHANH CHÓNG NHƯ VẬY.
3. Bỏ qua các tài liệu tham khảo vô dụng
Nếu tham chiếu không liên quan gì đến hướng dẫn cốt lõi về những gì bạn đang cố gắng mô tả, chẳng hạn như:
Để biết thêm thông tin về Twanny Twannyler của Fanny Whacker 2000, vui lòng xem tài liệu FU, tiểu mục ID10T.
Không nên làm điều đó.
4. Ngày tháng. Luôn luôn.
Ngày mà tài liệu được viết nên ở trong phần chân trang của mỗi trang. Nếu đó là một tài liệu điện tử, ngày được hiển thị hai lần. Một lần khi bắt đầu, một lần ở cuối.
Bạn có thể viết cái này là "Sửa đổi lần cuối (chèn ngày ở đây)".
5. Cảnh báo phải luôn được đăng trước thời điểm không quay lại
Nếu có một cái gì đó trong tài liệu của bạn có khả năng làm hỏng / phá hủy / xóa sạch thứ gì đó nếu được thực hiện không chính xác, thông tin này sẽ được đặt trực tiếp sau hướng dẫn đã nói, trong tầm nhìn rõ ràng (có nghĩa là trên cùng một trang) và có dấu.
Thí dụ:
Bước 5. Làm sạch Fanny Whacker 2000
Mái chèo của FW2000 nên được làm sạch nhẹ nhàng bằng vải mềm không mài mòn.
CẢNH BÁO: Chỉ sử dụng dung môi không có amoniac để ngăn FW2000 phát nổ và dẫn đến cái chết không kịp thời của bạn.
Trên một lưu ý cuối cùng, tài liệu tốt không phải là siêu mô tả về mọi điều có thể tưởng tượng được. Đọc tài liệu của bạn và tự hỏi, nó có hướng dẫn đúng không? Nếu câu trả lời là có, câu hỏi tiếp theo là, nó có hướng dẫn nhanh không? Nếu có, tài liệu là tốt.
