Cho dù một nhà phát minh, lập trình viên hay nhà hợp lý hóa tài tình đến đâu, đôi khi những sáng tạo của anh ta không thể được sử dụng cho mục đích đã định. Lý do cho điều này là hướng dẫn sử dụng được soạn thảo không chính xác hoặc hoàn toàn không có. Nhưng ngay cả những nhà phát minh tài tình đôi khi cũng viết những chỉ dẫn đến nỗi ngoài những chuyên gia hẹp, không ai có thể đọc được những giấy tờ này. Vì vậy, làm thế nào để bạn vẽ đúng một tài liệu cần thiết như vậy?
Nó là cần thiết
- - một trăm phần trăm hiểu biết về thiết bị hoặc sản phẩm phần mềm mà sách hướng dẫn đang được viết;
- - kiến thức trong lĩnh vực ngôn ngữ học;
- - kỹ năng viết.
Hướng dẫn
Bước 1
Hướng dẫn sử dụng hay nói cách khác là hướng dẫn vận hành là tài liệu được thiết kế để hỗ trợ người dùng sử dụng một hệ thống nhất định. Để biên dịch sách hướng dẫn sử dụng, bạn cần phải biết hệ thống được mô tả một trăm phần trăm, nhưng hãy nhìn nó qua con mắt của một sinh viên dốt nát. Giả sử một hướng dẫn sử dụng được viết cho một tiện ích phần mềm chưa có phần mềm tương tự. Hãy tưởng tượng đây là lần đầu tiên bạn sử dụng chương trình này. Bạn bắt đầu từ đâu? Điều đầu tiên cần biết là gì? Sắp xếp kiến thức này thành các loại có tầm quan trọng.
Bước 2
Bằng cách chia tất cả thông tin liên quan đến sáng tạo của bạn thành các nhóm, bạn đã vạch ra một kế hoạch để viết hướng dẫn sử dụng. Bắt đầu mô tả công việc trong chương trình của bạn từ đầu, để lại những chi tiết khó cuối cùng, chẳng hạn như lập trình lại các tính năng hoặc xử lý các lỗi nghiêm trọng. Ở giai đoạn này, bạn nên chuẩn bị sẵn nội dung của hướng dẫn sử dụng - một trong những phần bắt buộc của tài liệu này.
Bước 3
Nếu sách hướng dẫn bạn đang tạo nhằm mục đích sử dụng cho một công ty lớn, thì bạn nên chú ý đến các tiêu chuẩn công ty được áp dụng ở đó. Ví dụ, ở nhiều công ty Nga, hướng dẫn sử dụng không được chấp nhận nếu không có hỗ trợ minh họa, hay nói cách khác là hình ảnh giải thích những gì được viết. Ngoài nội dung, hướng dẫn sử dụng phải có các phần bắt buộc khác: - Chú thích, nghĩa là giải thích về các mục tiêu chung của hướng dẫn sử dụng và sản phẩm được mô tả; - phần giới thiệu mô tả các tài liệu liên quan đến hướng dẫn sử dụng và cách sử dụng sổ tay hướng dẫn; - các phần giải thích việc sử dụng sản phẩm trong các giai đoạn sử dụng khác nhau, ví dụ, các bước đầu tiên, sửa chữa hoặc bảo trì; - phần các câu hỏi thường gặp và câu trả lời cho chúng; - bảng thuật ngữ hoặc chỉ mục chủ đề.
Bước 4
Thông thường, một người viết kỹ thuật tham gia vào việc tạo ra hướng dẫn sử dụng - một người có tất cả các kiến thức cần thiết cả về ngôn ngữ và sản phẩm được mô tả. Là một nhà văn kỹ thuật mà không được đào tạo, có một số quy tắc cần ghi nhớ. Thứ nhất, bạn không được lạm dụng các thuật ngữ đặc biệt mà người dùng bình thường không thể hiểu được. Thứ hai, mỗi thuật ngữ được sử dụng phải được chi tiết và giải thích. Thứ ba, bạn cần viết rõ ràng và ngắn gọn nhất có thể. Cuối cùng, một người viết kỹ thuật phải có khả năng nhìn vào văn bản của chính họ thông qua con mắt của một người dùng bình thường để thấy được những thiếu sót trong văn bản của chính họ.
Bước 5
Việc kiểm tra nội dung hoàn chỉnh của hướng dẫn sử dụng trên thực tế là rất tốt bằng cách đưa nó cho một người không liên quan gì đến sản phẩm được mô tả. Bằng những nỗ lực chung, có thể loại bỏ tất cả những thiếu sót và cạm bẫy của tài liệu.
