Hướng dẫn sử dụng là sổ tay ở định dạng giấy hoặc điện tử (PDF hoặc XPS) cung cấp các hướng dẫn về quy trình hoặc cách sử dụng một thứ gì đó. Mặc dù “hướng dẫn sử dụng” thường được kết hợp với hướng dẫn ứng dụng máy tính, hướng dẫn sử dụng cũng được cung cấp cùng với máy tính và các thiết bị điện tử khác như TV, dàn âm thanh, hệ thống điện thoại, máy nghe nhạc MP3, và các thiết bị gia dụng và sân vườn. Hướng dẫn sử dụng tốt sẽ giáo dục người dùng về các tính năng của sản phẩm đồng thời dạy họ cách sử dụng các tính năng đó một cách hiệu quả. Hướng dẫn sử dụng được cấu trúc theo cách dễ đọc và dễ tham khảo. Dưới đây là một số bước bạn cần xem xét khi phát triển nội dung hiệu quả và thiết kế bố cục hướng dẫn sử dụng.
Bươc chân
Phần 1/3: Tạo Hướng dẫn Sử dụng Thích hợp
Bước 1. Quyết định ai sẽ sử dụng hướng dẫn
Để viết một hướng dẫn sử dụng tốt, bạn cần phát triển hồ sơ người dùng, chính thức bằng cách tạo hồ sơ bằng văn bản hoặc không chính thức bằng cách dành thời gian để đưa ra các giả định hợp lý về đặc điểm của người dùng. Những hồ sơ như vậy hữu ích khi bạn là thành viên của nhóm viết hướng dẫn sử dụng và khi làm việc trên sản phẩm dự kiến từ khái niệm đến hình thức cuối cùng. Hãy xem xét các yếu tố sau khi tạo hồ sơ người dùng:
- Vị trí của người dùng sẽ sử dụng hướng dẫn, ví dụ như tại nhà, trong văn phòng, tại nơi làm việc từ xa hoặc trên ô tô. Yếu tố này không chỉ quyết định nội dung mà còn cả phong cách viết mà người hướng dẫn sẽ áp dụng.
- Người dùng sẽ sử dụng hướng dẫn như thế nào. Nếu họ hiếm khi sử dụng nó hoặc chỉ cần nó để tìm kiếm thông tin, tốt nhất là hướng dẫn được thực hiện dưới dạng tài liệu tham khảo. Mặt khác, nếu người dùng sẽ sử dụng thường xuyên trong thời gian đầu, phần tài liệu tham khảo nên đi kèm với phần “Cách bắt đầu” và hướng dẫn về các chức năng phổ biến nhất mà sản phẩm sẽ thực hiện.
- Người dùng có bao nhiêu trải nghiệm với sản phẩm hoặc mặt hàng tương tự. Nếu sản phẩm mới hoặc rất khác với các sản phẩm tương tự, bạn phải kèm theo giải thích về sự khác biệt của sản phẩm với những sản phẩm khác và hướng dẫn cách sử dụng. Nếu sản phẩm liên quan đến thứ gì đó mà người dùng thường cảm thấy khó khăn, chẳng hạn như ứng dụng máy tính, bạn phải cung cấp thông tin và chi tiết phù hợp một cách dễ hiểu.
Bước 2. Tạo một hướng dẫn phù hợp với nhu cầu của người dùng theo cách mà họ có thể hiểu được
Nếu người dùng không phải là những người hiểu biết về kỹ thuật, có lẽ tốt nhất nên tránh sử dụng ngôn ngữ kỹ thuật cao và cung cấp các giải thích rõ ràng và đơn giản. Văn bản cũng phải được tổ chức theo cách giống với cách người dùng nghĩ. Liệt kê các tính năng của sản phẩm được nhóm theo chức năng thường có ý nghĩa hơn so với các tính năng được sử dụng thường xuyên nhất.
Đôi khi việc sử dụng các thuật ngữ kỹ thuật là không thể tránh khỏi, ví dụ như đối với các ứng dụng biểu đồ bao gồm biểu đồ Fibonacci cùng với biểu đồ hình tròn và biểu đồ thanh phổ biến hơn. Trong trường hợp như thế này, sẽ tốt hơn nếu bạn xác định các điều khoản và cung cấp thông tin, ví dụ giải thích về biểu đồ Fibonacci là gì và nó được sử dụng như thế nào trong phân tích tài chính
Bước 3. Mô tả vấn đề mà người dùng đang cố gắng giải quyết, sau đó đưa ra giải pháp cho vấn đề đó
Đưa ra các tính năng như giải pháp cho các vấn đề thông thường là tốt khi quảng cáo một sản phẩm, nhưng một khi khách hàng đã sở hữu sản phẩm, họ cần phải hiểu cách sử dụng nó. Xác định vấn đề mà người dùng sẽ gặp phải, mô tả nó trong hướng dẫn sử dụng, sau đó là hướng dẫn giải quyết nó.
Nếu vấn đề phức tạp, hãy chia nó thành nhiều phần nhỏ hơn. Viết ra từng phần với hướng dẫn về cách giải quyết hoặc đối phó với nó, sau đó nối tiếp nhau theo thứ tự. Chia nhỏ thông tin theo cách này được gọi là phương pháp phân cụm hoặc phân tách
Phần 2/3: Thành phần Hướng dẫn Sử dụng
Bước 1. Tạo trang bìa và trang tiêu đề thích hợp
Bạn sẽ cần bìa cho bất kỳ hướng dẫn sử dụng nào không phải là thẻ tham khảo và trang tiêu đề cho hướng dẫn bao gồm nhiều hơn một tờ giấy gấp (dài 4 trang trở lên).
- Nếu hướng dẫn được bảo vệ bởi bản quyền, thông báo bản quyền phải được đính kèm trên bìa trước và bìa sau, cũng như trên trang tiêu đề.
- Nếu có các điều khoản và điều kiện để sử dụng hướng dẫn và các sản phẩm đi kèm với nó, vui lòng đưa chúng vào mặt trong của bìa trước.
Bước 2. Đặt một tham chiếu đến tài liệu liên quan trong phần giới thiệu
Nếu có nhiều hơn một hướng dẫn sử dụng, vui lòng tham khảo tài liệu khác, bao gồm cả số phiên bản chính xác, tại đây. Lời nói đầu cũng là nơi để đặt phần “Cách sử dụng Hướng dẫn này” nếu có.
Bước 3. Bao gồm mục lục nếu tài liệu hướng dẫn dài hơn 10 trang
Bước 4. Đặt các hướng dẫn / thủ tục và tài liệu tham khảo trên phần nội dung của hướng dẫn
Trong hầu hết các trường hợp, cả quy trình và tài liệu tham khảo đều phải có phần riêng. Tuy nhiên, bạn có thể yêu cầu người dùng tham khảo nội dung cụ thể trong một phần và phân biệt nội dung đó với các phần khác. Bằng cách này, người dùng có thể nhanh chóng tìm thấy thông tin mà họ đang tìm kiếm.
- Các thủ tục nên được viết theo một cấu trúc nhất quán trong suốt các hướng dẫn trong sách hướng dẫn. Bắt đầu với tổng quan về chức năng của sản phẩm, sau đó giải thích những gì người dùng nên làm và những kết quả mà họ sẽ nhận được hoặc nhìn thấy. Các bước phải được đánh số và bắt đầu bằng một động từ hành động, cũng như cách các bước được viết trong mỗi phần của bài viết này.
- Tài liệu tham khảo có thể bao gồm danh sách kiểm tra, mẹo khắc phục sự cố và các câu hỏi thường gặp. Một bảng thuật ngữ và chỉ mục có thể được thêm vào cuối hướng dẫn, mặc dù bảng chú giải thuật ngữ thường dùng có thể được cung cấp ở phần đầu. Chỉ mục có thể được bỏ qua nếu hướng dẫn có ít hơn 20 trang.
Bước 5. Sử dụng hình ảnh đồ họa khi cần thiết để hỗ trợ văn bản
Hình ảnh đồ họa hoặc ảnh chụp màn hình có thể minh họa tốt hơn các điểm nhất định trong hướng dẫn hơn là văn bản, đặc biệt là trong các quy trình phức tạp mà người dùng cần xác nhận trực quan để đảm bảo họ đang thực hiện đúng các bước. Bản vẽ đồ họa có thể được tạo bằng cách sử dụng máy tính hỗ trợ soạn thảo (CAD) hoặc các ứng dụng chỉnh sửa đồ họa, máy ảnh kỹ thuật số và ứng dụng xử lý ảnh hoặc nếu bạn muốn sử dụng ảnh chụp màn hình, hãy sử dụng các tính năng ảnh chụp màn hình được tích hợp trong máy tính của bạn hoặc chương trình đồ họa có khả năng chụp ảnh màn hình.
- Sau khi bạn tạo một hình ảnh đồ họa, hãy lưu nó ở định dạng nén để bạn có thể sử dụng nó trong một ứng dụng xử lý văn bản hoặc xuất bản trên máy tính để bàn. Bạn cũng cần giảm kích thước của hình ảnh để phù hợp hơn với trang, nhưng vẫn cung cấp đầy đủ chi tiết cho người dùng. (Nếu cần, bạn có thể cắt ảnh gốc thành các phần và hiển thị các phần có liên quan cùng với văn bản hỗ trợ).
- Nếu bạn sử dụng nhiều hình ảnh đồ họa trong quy trình, hãy đảm bảo hình ảnh được tạo ở kích thước phù hợp, có cùng kích thước chiều dài và chiều rộng hoặc tương ứng với kích thước của hình ảnh gốc. Bằng cách đó, hình ảnh sẽ thu hút người dùng hơn. Điều này cũng đúng khi chụp ảnh màn hình từ máy tính; đảm bảo máy tính hiển thị bảng màu tiêu chuẩn khi chụp ảnh nếu không trình hướng dẫn sẽ hiển thị ảnh chụp màn hình màu.
- Trong khi các ứng dụng chỉnh sửa hình ảnh như Photoshop và Paint Shop Pro có khả năng chụp ảnh tốt, các chương trình dành riêng để chụp ảnh màn hình như Snagit cũng cung cấp khả năng dễ dàng sửa đổi, lập danh mục và chú thích ảnh chụp màn hình.
Phần 3/3: Thiết kế Hướng dẫn Sử dụng Dễ sử dụng
Bước 1. Chọn một số phông chữ dễ đọc
Mặc dù máy tính có thể hỗ trợ một số phông chữ nhưng mục đích của việc tạo hướng dẫn sử dụng là dễ đọc. Chọn nhiều phông chữ phù hợp là cách tốt nhất để đạt được mục tiêu đó. Phông chữ có thể được nhóm thành hai loại: serif và sans serif.
- Phông chữ Serif có các đường trang trí nhỏ ở cuối các dòng chính tạo nên các chữ cái. Các phông chữ serif bao gồm Times New Roman, Baskerville và Book Antiqua. Phông chữ Serif hoàn hảo cho hầu hết văn bản được hiển thị ở kích thước 10-12 trong phần thân chính cho hướng dẫn in.
- Phông chữ Sans serif chỉ có các đường tạo nên các chữ cái, không có phần tô điểm. Phông chữ thuộc nhóm sans serif bao gồm Arial, Calibri và Century Gothic. Phông chữ Sans serif có thể được sử dụng cho hầu hết các kích thước văn bản từ 8 đến 10 trong tệp PDF hoặc hướng dẫn trực tuyến, mặc dù việc không trang trí khiến các câu hiển thị bằng phông chữ 12 trở lên khó đọc hơn. Tuy nhiên, phông chữ có thể được sử dụng hiệu quả ở kích thước lớn hơn để hiển thị các tiêu đề và đề mục, và ở kích thước nhỏ hơn, chúng hoàn hảo cho các chú thích và số trong cột và bảng.
- Nói chung, tốt nhất bạn nên chọn một phông chữ đơn giản như Arial hoặc Times New Roman cho hướng dẫn của mình, mặc dù bạn có thể sử dụng phông chữ trang trí cho trích dẫn hoặc tiêu đề nếu bạn đang viết hướng dẫn cho một trò chơi điện tử lấy bối cảnh giả tưởng hoặc khoa học viễn tưởng. (Trong trường hợp trích dẫn, bạn thường có thể sử dụng phông chữ đơn giản và hiển thị toàn bộ trích dẫn bằng chữ nghiêng).
- Sau khi quyết định sử dụng phông chữ nào, hãy tạo các trang mẫu để xác minh rằng chúng trông đẹp trên giấy. Bạn cũng nên hiển thị trang mẫu này cho người chịu trách nhiệm phê duyệt việc hiển thị hướng dẫn trước khi bạn tiến hành quá trình viết.
Bước 2. Suy nghĩ về bố cục
Khi bạn đã chọn phông chữ cho hướng dẫn, bạn sẽ cần quyết định cách cấu trúc nội dung trên đầu trang.
- Nói chung, bạn có thể nên đặt tiêu đề tài liệu hoặc tiêu đề chương trong đầu trang hoặc chân trang, có thể sử dụng tiêu đề hướng dẫn ở bên trái trang và tiêu đề chương ở bên phải trang. Bạn phải đặt số trang trong đầu trang hoặc chân trang, ở bên ngoài (đầu trang hoặc chân trang) hoặc ở giữa (chỉ trong chân trang). Bạn cũng có thể cần phân biệt trang đầu tiên của mỗi phần hoặc chương với các trang khác bằng cách đặt số trang ở giữa chân trang và trang tiếp theo ở góc ngoài của đầu trang.
- Bạn có thể cần phải chèn văn bản bên trong hộp màu hoặc hộp khối để phân biệt nó với phần còn lại của văn bản. Đảm bảo rằng bạn chọn màu hoặc mức độ chặn để không làm cho văn bản khó đọc.
- Để lại một lề khá rộng ở tất cả các bên, có thêm khoảng trống ở các cạnh để ràng buộc.
Bước 3. Xem xét loại âm lượng cho hướng dẫn sử dụng
Nếu hướng dẫn dài hơn 4 trang, các trang phải được đóng một cách nhất định. Mặc dù tài liệu bên trong có thể được ghim bằng kim bấm ở góc trang, nhưng hướng dẫn sử dụng bên ngoài đi kèm với sản phẩm thường được ghim bằng một trong 3 phương pháp sau:
- Phương pháp dập ghim một mặt (kẹp vào các mặt của trang bằng kim bấm) cho các hướng dẫn in trên giấy gấp 21 x 27,5 cm, 21 x 35 cm hoặc 27,5 x 42,5 cm. Hầu hết các hướng dẫn rẻ tiền gồm 48 trang hoặc ít hơn đều bị ràng buộc theo cách này.
- Phương pháp khâu yên xe (khâu ở bên cạnh trang) được sử dụng thường xuyên hơn cho các hướng dẫn tham khảo của bên thứ ba hơn là các hướng dẫn đi kèm với các sản phẩm không phải ô tô, mặc dù một số hướng dẫn dài hơn được ràng buộc theo cách này. (Hướng dẫn Paint Shop Pro ban đầu bao gồm hướng dẫn khâu yên xe trong khi vẫn được sản xuất bởi JASC Software).
- Đóng gáy xoắn ốc phù hợp nhất cho các thanh dẫn được sử dụng trong môi trường khắc nghiệt hơn, chẳng hạn như ngoài trời (trong trường hợp này, phương pháp dập ghim một bên và khâu yên ngựa không đủ mạnh để làm trượt trang). Một số thanh dẫn hướng xoắn ốc cũng có thể có các trang được ép bằng nhựa để ngăn chúng bị hỏng khi bị ướt hoặc tiếp xúc với bùn.
Bước 4. Tạo một tài liệu mẫu để được hướng dẫn
Nhiều ứng dụng xử lý văn bản và xuất bản trên máy tính để bàn cung cấp tùy chọn tạo tài liệu mẫu cho hướng dẫn sử dụng. Vì vậy, khi bạn nhập, văn bản sẽ tự động xuất hiện với phông chữ bạn đã chọn cho phần của trình hướng dẫn bạn đang làm việc. (Thực ra, bài viết này ban đầu được viết bằng mẫu Microsoft Word). Hầu hết các chương trình này cũng bao gồm một bộ mẫu tiêu chuẩn mà bạn có thể sửa đổi khi cần thiết, do đó bạn không phải tạo của riêng mình từ đầu.
