Phần mềm tốt nhất để viết hướng dẫn sử dụng dựa trên HTML

Question

Tôi đang làm việc trên một dự án mà tôi cần để tạo tài liệu người dùng cuối cho một phần mềm. Vào một thời điểm nào đó trong năm tới, phần mềm mà tôi đang viết tài liệu này sẽ được gỡ bỏ. Do đó, tôi không muốn dành nhiều thời gian cho một tài liệu hướng dẫn chuyên nghiệp. Đây là cái gì đó mà sinh viên tốt nghiệp tại một trường cao đẳng, và một vài chuyên gia trong nhà, sẽ được nhìn thấy. Mặc dù nếu nó tốt và đủ hữu ích, tôi có thể đưa nó trở lại cộng đồng mã nguồn mở dưới dạng tài liệu miễn phí.

Tôi đã nghĩ rằng một hướng dẫn sử dụng HTML sẽ phù hợp. Phần mềm này được viết bằng PHP, vì vậy bất cứ ai sử dụng nó sẽ có một trình duyệt web mở và sẵn sàng để đi. Điều này cũng dẫn đến khả năng của tôi, hoặc người khác, tích hợp các trang hướng dẫn sử dụng vào chính phần mềm.

Tôi không quan tâm đến việc tạo/sử dụng wiki cho phần mềm này. Những gì tôi thực sự tìm kiếm là một phần của phần mềm mà tôi có thể viết như một tài liệu bình thường và tạo ra HTML đơn giản. Tôi biết rằng có nhiều phần mềm như Dreamweaver và Frontpage nhưng tôi đặc biệt quan tâm đến thứ gì đó được thiết kế để giúp quá trình tạo tài liệu trở nên dễ dàng hơn (khi quá trình chụp màn hình và video được tích hợp cùng với chỉnh sửa hình ảnh/video đơn giản).

Nếu bạn nghĩ rằng một cách tiếp cận khác (ngoài tài liệu HTML) có thể tốt hơn, tôi rất muốn nghe nó. Nếu bạn có một cách tiếp cận khác, và bạn nghĩ rằng bạn biết một giải pháp phần mềm tốt để đạt được điều đó, hãy cho tôi biết.

mong muốn chính của tôi cho cách tiếp cận và các phần mềm để đạt được điều đó là

• sự đơn giản trong triển khai (các trang HTML không cần thiết lập đặc biệt. Một thư mục giúp đỡ chỉ có thể được triển khai với tất cả các trang của nhãn hiệu trong nó)
• Không có phần mềm đặc biệt cần thiết để sử dụng (HTML có thể được đọc bởi tất cả mọi người có trình duyệt web)
• Dễ sử dụng cho tôi viết tài liệu/đường cong học tập nhỏ (Tôi không muốn dành nhiều thời gian để học một phần mềm phức tạp để làm việc trên một dự án tương đối nhỏ)
• Khả năng kết hợp văn bản, video và hình ảnh thành các tài liệu đơn lẻ (các trang HTML rõ ràng hỗ trợ hiển thị tất cả các tài liệu này với nhau)

Cảm ơn!

@Lie Ryan: "MediaWiki lưu trữ tất cả văn bản và dữ liệu (trang nội dung, chi tiết người dùng, thông báo hệ thống, v.v.) trong cơ sở dữ liệu ..." đó là những gì tôi muốn tránh. Tôi nghĩ rằng wiki rất tuyệt vời và hữu ích, nhưng tôi chỉ quan tâm đến việc cung cấp dữ liệu tĩnh với chi phí rất thấp.

Answer 1

Bất cứ khi nào tôi được yêu cầu viết hướng dẫn sử dụng (có nghĩa là mỗi khi tôi hoàn thành một dự án), tôi thích sử dụng Markdown. Kết hợp với CSS tối thiểu, nó rất dễ sử dụng.

Đánh dấu là công cụ chuyển đổi văn bản sang HTML dành cho người viết web. Đánh dấu cho phép bạn viết bằng cách dễ dàng đọc, định dạng văn bản thuần tuý dễ viết, sau đó chuyển đổi nó thành cấu trúc hợp lệ XHTML (hoặc HTML).

Do đó, “Đánh dấu” là hai việc: (1) a cú pháp định dạng văn bản thuần túy; và (2) một công cụ phần mềm, được viết bằng Perl, rằng chuyển đổi định dạng văn bản thuần túy thành HTML.

Answer 2

Viết hướng dẫn sử dụng trong XML, sử dụng một cái gì đó như docbook. Điều này sẽ cho phép bạn làm bất cứ điều gì bạn cần với nội dung và sau đó tạo bản trình bày theo cách riêng của nó.

Có rất nhiều tutorials trên các công cụ docbook tới HTML.

Chỉnh sửa: Tôi quên đề cập đến rằng OO can save in docbook.

Answer 3

Tôi khuyên bạn chỉ nên viết nó trong OpenOffice và xuất bản sang PDF. PDF, có lẽ thậm chí nhiều hơn HTML, là nền tảng bất khả tri và xuất hiện gần giống hệt nhau trên nhiều khách hàng và hệ điều hành. Nếu bạn thực sự muốn video, bạn có thể liên kết đến một trang web bên ngoài như Youtube hoặc những gì bạn có từ tệp PDF.

Answer 4

Tôi đoán điều này không chính xác đáp ứng tất cả các yêu cầu của bạn, nhưng tôi là người hâm mộ lớn của Sphinx. Bạn viết tài liệu của mình ở ReST và bạn có thể tạo các phiên bản HTML và PDF khá dễ dàng. Thế hệ HTML sử dụng các mẫu, do đó, nó hoàn toàn có thể tùy chỉnh. Ngoài ra, có thêm lợi ích của việc có các phiên bản văn bản thuần túy xung quanh (ReST là phần nào có thể đọc được như là) cho những người trong chúng ta, những người thích những thứ như vậy :)