Thay thế cho Trợ giúp HTML

Chúng tôi hiện đang sử dụng một hệ thống có tên là AsciiDoc cho phép chúng tôi tạo tài liệu trong một đánh dấu văn bản đơn giản. Từ đó chúng ta có thể tạo ra nhiều định dạng đầu ra. Chúng tôi chỉ sử dụng các định dạng đầu ra pdf và chm.

Tôi đã tự hỏi nếu có một thay thế cho chm? Những gì tôi đang tìm kiếm là thứ gì đó có thể được sử dụng ngoại tuyến (điều này rất quan trọng vì khá nhiều người dùng của chúng tôi ở những nơi rất xa) với phần mềm của chúng tôi. Nó nên có một chỉ mục (nó có thể đơn giản như một trang html với các cụm từ siêu liên kết), nó có thể tìm kiếm được và nó phải có một cơ chế cho phép các mục cụ thể được gọi lên từ mã (tương tự như trợ giúp theo ngữ cảnh).

Hai điều chống lại PDF trong trường hợp này là:

1. Trợ giúp theo ngữ cảnh không phải là một lựa chọn
2. Nói chung tài liệu khá lớn
3. PDF phù hợp với tài liệu in hơn là trợ giúp theo ngữ cảnh

Những gì tôi muốn là sử dụng html. Vấn đề duy nhất với html là dường như tôi không thể tìm ra cách tự động cung cấp tìm kiếm từ khóa (ngoài chức năng ctrl + f của trình duyệt - tôi muốn một cái gì đó rõ ràng hơn). Tôi dường như cũng không thể tìm thấy một phương pháp để tự động tạo ra một chỉ mục siêu liên kết của các từ khóa. Trợ giúp theo ngữ cảnh sẽ đơn giản vì các thẻ phần - Tôi có thể chỉ cần chuyển url của trang và phần mà tôi quan tâm đến trình duyệt mặc định và trang đó sẽ tải lên đúng phần.

Yêu cầu của tôi nghe có vẻ rất tệ như chm - họ làm. Tôi mô hình hóa các yêu cầu của tôi ra chm. Lý do duy nhất tôi không thích chm là vì cách mã tương tác với nó bằng cách sử dụng mapids và như vậy. Tôi thà sử dụng lưu trữ một danh sách văn bản đơn giản (được tạo tự động cho tôi) mà mã của tôi có thể sử dụng để truy cập vào phần nhạy cảm ngữ cảnh của tài liệu.

Tôi đang hình dung một tập lệnh sẽ đi qua các tệp đầu ra html và tạo một trang chỉ mục chỉ chứa một danh sách các từ khóa mà nó tìm thấy. rõ ràng nên có cơ chế loại trừ từ để bỏ qua các từ như: the, it, is, v.v .. Phần này sẽ tương đối dễ viết. Phần thứ hai sẽ cần một tập lệnh sắp xếp để kết hợp cơ sở dữ liệu từ khóa và vị trí của chúng trong văn bản html. Tôi nghĩ rằng đây sẽ là phần khó khăn cùng với việc cung cấp cơ chế tìm kiếm trong trình duyệt.

Bất kỳ ý tưởng về các lựa chọn thay thế sẽ được đánh giá cao. Tôi rất thích sử dụng wiki hoặc tập hợp các trang html tĩnh được lưu trữ trên máy chủ web ở đâu đó, nhưng chúng tôi có một yêu cầu sử dụng ngoại tuyến quan trọng. Chỉ cần đặt html trên ổ đĩa cục bộ sẽ không cung cấp cho chúng tôi các yêu cầu tìm kiếm mà chúng tôi cần.

BIÊN TẬP:

Tôi thiết kế phần mềm được sử dụng bởi ngành công nghiệp khai thác. Rất nhiều mỏ rất xa và không có quyền truy cập internet theo bất kỳ cách có ý nghĩa nào. Không có gì sai với pdf hoặc html hoặc chm (ngoại trừ việc nó đang cũ). Nếu tôi có thể hiển thị một tệp pdf ở đúng vị trí (nghĩa là trợ giúp theo ngữ cảnh) tôi sẽ sử dụng nó. Tôi gần như bị cám dỗ để tự viết - về cơ bản nó sẽ là một wiki di động. Nói về điều đó, nếu bạn đề xuất wiki di động - bạn phải nghĩ đến người dùng cuối có thể không có kinh nghiệm sử dụng các công cụ như vậy. Nó đã được chết đơn giản. Đó là vẻ đẹp của chm, thật khó để làm việc nhưng người dùng cuối thích nó.

Nếu bạn đã sẵn sàng để hỗ trợ sự giúp đỡ của bạn trong đánh dấu XML của DocBook chứ không phải HTML, thì DocBook có hỗ trợ để tạo WebHelp: http://wiki.docbook.org/WebHelp

Tài liệu WebHelp cũng là bản demo của đầu ra: http://docbook.sourceforge.net/release/xsl/civerse/webhelp/docs/content/ch01.html

Nó cung cấp cho bạn một định dạng trợ giúp HTML dựa trên Web bao gồm:

• Tìm kiếm toàn văn với:
  • Hỗ trợ gốc cho tiếng Anh, tiếng Pháp và tiếng Đức. Hỗ trợ gốc có thể được thêm vào cho các ngôn ngữ khác bằng cách triển khai một trình phát gốc.
  • Hỗ trợ cho tiếng Trung, tiếng Nhật và tiếng Hàn bằng cách sử dụng mã từ công cụ tìm kiếm Lucene.
  • Làm nổi bật tìm kiếm cho thấy nơi tìm kiếm cụm từ xuất hiện trong kết quả.
  • Kết quả tìm kiếm có thể bao gồm các mô tả ngắn gọn về mục tiêu.
• Bảng mục lục với cây TOC có thể thu gọn.
• Tự động đồng bộ hóa khung nội dung và TOC.
• TOC và khung tìm kiếm được triển khai mà không cần sử dụng bộ khung.
• Một tệp Ant build.xml để tạo đầu ra.

Những người tạo ra RoboHelp đã tiếp tục những thứ khác, và đã quay lại để tạo ra một sự thay thế tốt hơn. Hãy xem MadCap's Flare - nó hỗ trợ nhiều định dạng đầu ra, tạo chỉ mục và cung cấp chức năng tìm kiếm hoạt động cục bộ (thông qua JavaScript).

Chúng tôi đã sử dụng Adobe RoboHelp để tạo các kiểu tài liệu trợ giúp ngoại tuyến khác nhau. Nó cung cấp nhiều tùy chọn đầu ra và tích hợp cho nội dung. Điều tuyệt vời của công cụ này là bạn có thể trao nó cho những người không phải là nhà phát triển và có được nội dung tuyệt vời với ít nỗ lực tích hợp vào giải pháp của bạn.

Bản thân CHM đã già đi và Microsoft cũng đã chuyển sang những thứ mới hơn: http://msdn.microsoft.com/en-us/l Library / bb164608 ( v = vs.80) .aspx

Nhưng nếu bạn thực sự muốn tránh chuyển đổi trợ giúp của mình sang một hệ thống hiện có và đang tìm cách cung cấp tìm kiếm và tra cứu từ khóa trên các tệp trợ giúp tĩnh, thì đây là hai ý tưởng:

• thêm một máy chủ HTTP chỉ dành cho localhost vào dự án để phục vụ trang web cùng với tài liệu. Vấn đề là khi nào hoặc làm thế nào để bắt đầu / dừng máy chủ HTTP này và / hoặc giữ cho nó chạy. Một giải pháp thay thế sẽ là triển khai lược đồ URL tùy chỉnh, nhưng điều này sẽ ràng buộc bạn với một trình duyệt và còn nhiều việc hơn ( và tôi có thể nói )

• viết một công cụ tìm kiếm JavaScript. JavaScript trong bất kỳ trình duyệt nào đang trở nên khá nhanh và hiệu quả trong những ngày này. Một chỉ mục từ khóa có thể dễ dàng được lưu trữ trên JSON và tôi đã chạy các biểu thức chính quy trên các tệp cục bộ với kết quả khá tốt.

Những gì tôi đang tìm kiếm là thứ gì đó có thể được sử dụng ngoại tuyến (điều này rất quan trọng vì khá nhiều người dùng của chúng tôi ở những nơi rất xa) với phần mềm của chúng tôi.

Chúng tôi sử dụng RoboHelp tại công ty của tôi và chúng tôi rất may mắn khi cung cấp các tệp trợ giúp ngoại tuyến vì chúng tôi thường có người dùng đi từ các khu vực có mạng truy cập vào các khu vực mà không có.

Nó nên được tìm kiếm và nó nên có một cơ chế cho phép các mục cụ thể được gọi lên

Chúng tôi sử dụng một số trang trong RoboHelp để giải thích việc sử dụng các trường nhất định trên màn hình. Chúng tôi có thể có cửa sổ bật lên cho các trường xuất hiện sau một cú nhấp chuột. RoboHelp cũng có khả năng tìm kiếm rất tốt và chỉ mục được tạo tự động. Tôi đã luôn gặp may mắn khi tìm kiếm nó. Điều này có thể không phải là một mối quan tâm lớn đối với bạn, nhưng chúng tôi có thể có bất kỳ ai cập nhật tài liệu vì RoboHelp là một chương trình khá dễ sử dụng.