Mặc dù thường xuyên bị nhiều người dùng máy tính bỏ qua, các tệp trợ giúp cung cấp thông tin chính về cách sử dụng ứng dụng phần mềm mà chúng được liên kết. Bằng cách nhấp vào "Trợ giúp", người dùng có thể xem tổng quan về các tính năng của chương trình, mô tả về màn hình mà họ đang xem, hướng dẫn về cách sử dụng chương trình để thực hiện một tác vụ nhất định hoặc đọc danh sách các câu hỏi thường gặp về chương trình và câu trả lời của họ. Viết một tệp trợ giúp đòi hỏi cả khả năng làm việc với các ứng dụng phần mềm và khả năng giải thích mọi thứ theo cách người dùng có thể hiểu được.
Các bước
Bước 1. Nhận một bản sao của phần mềm bạn đang sử dụng để làm tài liệu
Nếu có thể, bạn cũng nên nhận một bản sao của các thông số kỹ thuật đã viết cho chương trình, mặc dù không phải tất cả các nhà phát triển phần mềm đều làm việc với chúng. Trong một số trường hợp, lập trình viên sẽ đi chệch khỏi các thông số kỹ thuật, dựa trên thời gian phát triển ngắn hoặc không thể viết mã một tính năng cụ thể.
Bước 2. Nhận một công cụ hỗ trợ tạo tác giả
Mặc dù có thể tạo tệp trợ giúp bằng tay bằng cách sử dụng tệp có định dạng văn bản đa dạng thức (.rtf), hầu hết các tác giả tệp trợ giúp sử dụng ứng dụng phần mềm để viết tệp trợ giúp của họ, chẳng hạn như RoboHelp, Help and Manual, Doc-To -Giúp đỡ, MadCap Flare hoặc HelpLogix. Hầu hết các công cụ tạo trợ giúp bao gồm trình soạn thảo văn bản hoặc làm việc với chương trình xử lý văn bản như Microsoft Word và cung cấp giao diện người dùng cho phép tác giả trợ giúp xem tệp trợ giúp trông như thế nào khi họ đang viết nó trong khi viết mã máy tính ở hậu trường để làm cho tệp trợ giúp hoạt động. Một số công cụ tạo trợ giúp cũng bao gồm trình chỉnh sửa đồ họa để tạo ảnh chụp màn hình để đưa vào tệp trợ giúp.
Có một số định dạng tệp trợ giúp: Phổ biến nhất là Trợ giúp HTML, được sử dụng bởi các ứng dụng chạy trong Windows. (Định dạng cũ hơn, WinHelp, không còn được hỗ trợ.) Apple và Unix đều có các định dạng riêng của họ, Sun Microsystems cũng vậy, với JavaHelp của nó. Các ứng dụng phần mềm được thiết kế để chạy trong một số hệ điều hành có thể sử dụng hệ thống trợ giúp đa nền tảng chạy trong trình duyệt Web của người dùng. Bất kỳ công cụ soạn thảo trợ giúp nào bạn sử dụng đều phải hỗ trợ (các) định dạng trợ giúp mà bạn sẽ tạo tệp trợ giúp
Bước 3. Tạo tệp dự án trợ giúp
Công cụ soạn thảo trợ giúp của bạn sẽ tạo tệp dự án trợ giúp cho bạn, dựa trên tên tệp bạn cung cấp và các thông tin khác. Tệp dự án chính chứa thông tin về các tệp khác, bao gồm tệp nội dung, tệp chỉ mục, một hoặc nhiều tệp hình ảnh và các tệp khác.
- Tệp nội dung bao gồm văn bản trong tệp trợ giúp giải thích cách hoạt động của ứng dụng phần mềm mà bạn đang lập tài liệu. Văn bản thường được chia thành các chủ đề bao gồm một màn hình, tính năng hoặc quy trình cụ thể.
- Tệp chỉ mục là danh sách các chủ đề của tệp trợ giúp. Nó được sử dụng để tạo một mục lục mà người dùng có thể sử dụng để chọn một chủ đề để xem, cũng như một chỉ mục có thể tìm kiếm trong tệp trợ giúp.
- Tệp hình ảnh là tệp đồ họa của màn hình chương trình hoặc các phần của màn hình đó được hiển thị trong tệp trợ giúp để nâng cao khả năng của người dùng hiểu nội dung tệp trợ giúp đang đề cập đến.
Bước 4. Điều chỉnh kích thước của cửa sổ trợ giúp
Trừ khi bạn đang viết tệp trợ giúp để xuất hiện trong trình duyệt Web của người dùng, tệp trợ giúp sẽ xuất hiện trong cửa sổ riêng của nó. Công cụ soạn thảo trợ giúp của bạn sẽ cho phép bạn điều chỉnh kích thước ngang và dọc của cửa sổ thành kích thước cho phép người dùng cuối đọc tệp trợ giúp mà nó không cản trở chính ứng dụng. Cửa sổ trợ giúp chính thường ở định dạng ba ngăn, với mục lục ở bên trái và chủ đề được chọn ở bên phải.
Ngoài cửa sổ chính, các tệp trợ giúp cũng có thể có các cửa sổ phụ mô tả chi tiết một tính năng cụ thể và tự động định kích thước cửa sổ bật lên cung cấp các mô tả ngắn gọn về các tính năng. Tệp trợ giúp cũng có thể bao gồm văn bản nhúng chỉ xuất hiện khi văn bản được đánh dấu hoặc một nút được nhấp vào
Bước 5. Viết các chủ đề trợ giúp
Để làm điều này, bạn sẽ cần xem lại các thông số kỹ thuật hoặc chính chương trình để tạo các chủ đề để ghi lại các màn hình và tính năng của chương trình. Khi bạn tạo mỗi chủ đề, công cụ soạn thảo trợ giúp của bạn sẽ thêm chủ đề đó vào mục lục và chỉ mục của tệp trợ giúp.
- Mặc dù bạn có thể xây dựng mục lục ngay khi tiếp tục, nhưng sẽ giúp bạn có một số kế hoạch về cách sắp xếp nó. Bạn có thể sắp xếp mục lục xung quanh màn hình của chương trình, các tính năng của nó, cách sử dụng nó hoặc một số kết hợp của chúng.
- Khi bạn viết các chủ đề, hãy xem xét các thông tin khác trong tệp trợ giúp mà người dùng sẽ muốn có quyền truy cập nhanh. Bạn có thể tạo các bước nhảy hoặc siêu liên kết trong văn bản tệp trợ giúp kết nối với các chủ đề có thông tin đó.
Bước 6. Bao gồm ảnh chụp màn hình, nếu cần
Nhiều tính năng của chương trình được giải thích tốt nhất với sự kết hợp của văn bản và đồ họa. Bạn có thể tạo ảnh chụp màn hình bằng ứng dụng đi kèm với công cụ tạo trợ giúp của bạn hoặc bằng một ứng dụng riêng biệt, chẳng hạn như Microsoft Paint, Paint Shop Pro hoặc SnagIt.
- Văn bản và ảnh chụp màn hình phải được bố trí cùng nhau trong một chủ đề để người dùng có thể xem ảnh chụp màn hình và văn bản hỗ trợ của nó mà không cần cuộn quá mức. Trong nhiều trường hợp, bạn sẽ muốn hiển thị một phần của màn hình chương trình thay vì toàn bộ màn hình hoặc hiển thị ảnh chụp màn hình ở kích thước nhỏ hơn bản gốc. Ứng dụng ảnh chụp màn hình của bạn phải có khả năng thay đổi kích thước ảnh chụp màn hình mà không làm mờ hoặc mất chi tiết.
- Nếu bạn biết trước những thay đổi đối với giao diện người dùng giữa phiên bản thử nghiệm và phiên bản cuối cùng của chương trình, bạn có thể muốn tạm dừng việc tạo ảnh chụp màn hình cho đến khi bạn có phiên bản cuối cùng của chương trình để làm việc.
Bước 7. Tạo một tệp bản đồ, nếu cần
Một số chương trình bao gồm các nút "Trợ giúp" để người dùng nhấp vào và hiển thị chủ đề trong tệp trợ giúp mô tả cụ thể cách hoạt động của màn hình đó. Hiển thị chủ đề theo cách này được gọi là trợ giúp theo ngữ cảnh và yêu cầu tạo tệp bản đồ để lập trình viên liên kết nút "Trợ giúp" với chủ đề cụ thể trong tệp trợ giúp của bạn. Công cụ tạo trợ giúp của bạn có thể tạo một công cụ cho bạn hoặc lập trình viên có thể viết mã và cung cấp cho bạn để đưa vào tệp trợ giúp.
Bước 8. Biên dịch tệp trợ giúp
Biên dịch tạo ra tệp trợ giúp thực tế sẽ được bao gồm trong chương trình. Đối với hầu hết các định dạng trợ giúp, điều này sẽ kết hợp tất cả các tệp thành phần đã được tạo khi bạn tạo tệp trợ giúp, mặc dù một số định dạng trợ giúp không được biên dịch cũng yêu cầu các tệp chủ đề trợ giúp riêng lẻ phải được đưa vào chương trình.
Bước 9. Kiểm tra tệp trợ giúp
Sau khi biên dịch tệp trợ giúp, bạn cần kiểm tra tệp đó để đảm bảo rằng tất cả các siêu liên kết đều kết nối với các chủ đề mà chúng phải và tất cả đồ họa hiển thị chính xác. Tệp trợ giúp cũng cần được kiểm tra để đảm bảo rằng nội dung chính xác và phù hợp với người dùng và có định dạng nhất quán. Bạn sẽ muốn tự mình xem xét tệp trợ giúp và nhờ những người đang kiểm tra ứng dụng xem xét lại.
Trên các dự án tệp trợ giúp lớn hơn, quá trình biên dịch và thử nghiệm đang diễn ra. Bạn sẽ muốn biên dịch tệp trợ giúp và kiểm tra công việc của mình nhiều lần trước khi tạo phiên bản cuối cùng
Bước 10. Cung cấp tệp trợ giúp cho nhà phát triển để đưa vào chương trình
Tùy thuộc vào bản chất dự án và định dạng tệp trợ giúp, bạn có thể phải cung cấp cho nhà phát triển một số tệp, bao gồm cả tệp bản đồ nếu có các chủ đề nhạy cảm với ngữ cảnh.
