クロスプラットフォームエンドユーザーヘルプオーサリングツール

https://stackoverflow.com/questions/2977398

24-10-2019
|

質問

エンドユーザー向けのクロスプラットフォームヘルプファイルを作成するための優れたオーサリングツールは何ですか？（当社のアプリケーションは、QTフレームワークを使用しています。

注：私は内部APIドキュメントに興味がありません - 私たちは使用していますドキシゲンそのために。

理想的には、解決策は次のとおりです。

すべてのヘルプコンテンツ（テキスト、目次、画像など）を単一の場所で管理できるようにします。
ネイティブヘルプ形式への出力。（Windows用のCHMまたは少なくともHTMLに直接フィードできるものがAPIに直接フィードできます。他のプラットフォームの「標準的な」フォーマットがわかりません。）
まともなwysiwygサポート：一般的なテキストエントリ、画像、相互参照などを簡単に処理しますが、必要に応じてHTMLを編集できます。
ヘルププロジェクトのためのテキストベースのファイルフォーマット（XMLなど）。
実際のコードベースと同期するのに役立つフックは素晴らしいでしょう。（おそらく、どういうわけかヘルプトピックはコードファイルに関連付けられており、Subversionをチェックして変更が行われたかどうかを確認し、トピックに「おそらく時代遅れ」としてフラグを立てることができます...私は夢を見ていますか？）
ヘルプコンテンツをローカライズできます。
商業製品に反対しませんが、無料のオプションはいいでしょう。

先に進んで、これをウィキにして、いくつかの例から始めます。あなたが彼らとの経験がある場合は、上下に投票し、いくつかのコメントを残してください。追加のツールも追加します。

解決

私はちょうど発見しましたスフィンクス;私は恋をしていると思います。

htmlよりもwysiwygよりも優れています：rustructuredtext
（とりわけ）QTHELPへの出力は、アプリケーションに簡単に配布（および統合）することができます。
まだローカライズについてはわかりませんが、必要なときにその橋を渡ります。
セットアップが簡単で「ただ機能」しました。プロフェッショナルに見えます。

他のヒント

私は何年もロボヘルプを使用してきました。

問題ありませんが、コアテクノロジーは今では非常に古いものです。また、彼らが単語バージョンにロックする方法は、合計ピタです（そして、MSオフィスのアップグレードを数回避けることを余儀なくされました）。

私たちはマッドキャップフレアに移動しています http://www.madcapsoftware.com/products/flare/robohelp.aspx

おもうドキュメントブックおそらく同期フックを除くすべての要件に対処しますが、これについてはもう少し考えます。本質的には、ドキュメントを作成するために設計されたXMLのサブセットであり、無料でオープンソースです。これは、ドキュメントをより有用な形式（html、したがってxml-foまたはtexを介してCHM、Javahelp、PDF）に変換するXSL出力変換のセットに加えて、単なるフォーマットに加えています。

これは、WysiWygのようなものがXMLオーサリングソフトウェアの機能に依存するように、実際に編集するためにXMLオーサリングツールを選択する必要があることを意味します。 Syntext Sernaは、XML #includesのwysiwygとインライン編集を適切にサポートしているためです（他の人は後者をサポートしていないようです）。他のXMLオーサリングツールがあなたのニーズに合った方が良いことがあります - セルナはかなり高価な商業用品です。

Docbookはプロファイリングを介して多くの柔軟性を提供します。これにより、属性に基づいてXML要素を含める/除外できます。ユースケースの例は、OS = LinuxとはOS = Windowsの出力をわずかに異なるヘルプ出力を持つことです。ローカリゼーションは、プロファイリングやその他のメカニズムによってもサポートされています。

かなり良い DocBookの紹介見つけることができますここ.

ヘルプ形式にDocbookを使用し、特定の製品に関連する機能のみにヘルプを含むCHMファイルにコンパイルします（つまり、標準バージョンまたはデモバージョンにない機能があります）。関連する手順は次のとおりです。