Thường chứa đầy biệt ngữ, từ viết tắt và hướng yêu cầu bằng tiến sĩ để hiểu, hướng dẫn sử dụng phần mềm đôi khi được viết theo quan điểm của nhà phát triển thay vì người dùng. Do đó, hướng dẫn có thể đưa ra các giả định về mức độ kỹ năng của người đọc thường không chính xác. Bước đầu tiên trong việc viết một hướng dẫn sử dụng tốt là để có được quá trình viết thực tế càng xa các kỹ sư càng tốt.
Nhà phát triển phần mềm biết nhiều hơn bất kỳ ai làm cho phần mềm hoạt động, nhưng điều đó không có nghĩa là nhà phát triển nên viết hướng dẫn. Trái lại, đó là một bất lợi rõ rệt. Quan trọng hơn sự hiểu biết sâu sắc về hoạt động bên trong của phần mềm là sự hiểu biết người dùng cuối sẽ là ai, trình độ học vấn của anh ta và người dùng cuối đó sẽ sử dụng phần mềm như thế nào. Trong hầu hết các trường hợp, người dùng cuối không cần biết các điểm lập trình tốt hơn và hoạt động của phần mềm - họ chỉ cần biết cách sử dụng nó để làm cho công việc của họ dễ dàng hơn.
Kiểm tra người dùng
Hướng dẫn sử dụng nên chủ yếu theo định hướng nhiệm vụ, thay vì mô tả nhiều. Vì hướng dẫn được viết để giúp người dùng hiểu cách thực hiện các tác vụ cụ thể, người viết cần phải hiểu rõ về các tác vụ đó, và do đó, trải qua từng bước riêng biệt của từng tính năng là vô cùng cần thiết. Người viết không nhất thiết phải biết chương trình được tạo ra như thế nào từ quan điểm thiết kế hoặc phát triển, nhưng điều cần thiết là phải có kiến thức làm việc mạnh mẽ về tất cả các tính năng của nó. Trong khi thực hiện từng tác vụ, hãy dành thời gian để ghi lại từng bước, bao gồm các lần nhấp, menu thả xuống và các hành động khác.
Quy trình phỏng vấn
Mặc dù nhà phát triển không nên là người viết hướng dẫn, cô ấy vẫn sẽ là một tài nguyên quý giá cho nhà văn, và trước khi bắt đầu viết, hãy lên kế hoạch cho một cuộc họp khởi động giữa nhà văn, nhà phát triển và kỹ sư và người dùng cuối tiềm năng để giúp thông báo cho tác phẩm của nhà văn ngay từ đầu. Các cuộc phỏng vấn với các chuyên gia và kỹ sư vấn đề nên được ghi lại, với bảng điểm được thực hiện để tham khảo sau này.
Hình ảnh
Hướng dẫn sử dụng không nên quá nặng văn bản. Thay vào đó, kết hợp sử dụng tự do đồ họa và clip màn hình. Mô tả một hành động rõ ràng hơn nhiều với các hướng dựa trên văn bản kèm theo một clip màn hình minh họa rõ ràng cho hướng đó. Bao gồm cả chế độ xem trước và sau, để hiển thị màn hình trông như thế nào trước khi thực hiện từng hành động và những gì xảy ra sau khi hành động được thực hiện. Một tiện ích chụp màn hình đơn giản như Snipping Tool có trong Microsoft Windows hoạt động tốt để chụp những hình ảnh này. Hãy chắc chắn đánh số từng hình ảnh và bao gồm chú thích mô tả ngắn gọn về nó. Trung tâm nó ngay bên dưới đoạn đầu tiên giới thiệu khái niệm được mô tả trong hình ảnh.
Định dạng
Giao tiếp rõ ràng trong một tài liệu kỹ thuật đòi hỏi phải lập kế hoạch và tuân thủ cẩn thận các tiêu chuẩn trong suốt hướng dẫn. Các tiêu chuẩn trong cả trình bày, ngôn ngữ và danh pháp giúp tránh nhầm lẫn. Các mẫu có sẵn và có thể là điểm khởi đầu tốt cho tính đồng nhất, mặc dù chúng chắc chắn có thể được điều chỉnh để phù hợp với từng tình huống. Sử dụng lề một inch với một cột duy nhất phù hợp nhất với nhu cầu thêm đồ họa; cài đặt hai cột có thể xuất hiện quá đông và có thể khiến vị trí của hình ảnh trở nên khó hiểu.
Phiên bản và theo dõi
Hơn bất kỳ loại tài liệu nào khác, hướng dẫn sử dụng phần mềm có thể trải qua nhiều lần lặp trước khi hoàn thành và có thể sẽ trải qua quá trình xem xét bởi nhiều bên liên quan. Sử dụng tính năng Theo dõi Thay đổi trên Microsoft Word là một cách dễ dàng để theo dõi từng nhận xét và thay đổi của từng cá nhân. Tạo nhiều phiên bản sau mỗi chu kỳ xem xét, mỗi phiên bản có một tên tệp khác nhau, cũng giúp xử lý và đảm bảo tất cả các bên liên quan đều hài lòng với kết quả cuối cùng.
