問題タブ [help-authoring]

Robohelp に代わる無料のツールはありますか? オープンソースを好む

オープン ソース プロジェクト用の何らかのオンライン ヘルプ オーサリング ツールが必要です。

このような要件を満たすヘルプ/ドキュメント生成ツールを探しています。

• C# コンパイラによって生成された xmldoc コメントをサポートするか、(さらに良いことに) サンドキャッスルを直接サポートする必要があります。
• MS Word ドキュメントのインポートをサポートする必要があります。
• 概念ドキュメントからソース コードから生成された参照ドキュメントへのリンクの作成をサポートする必要があります。
• MS Word での概念的なドキュメント オーサリングがサポートされているとよいのですが

詳細。私のプロジェクトは、.NET のフレームワーク/ライブラリです。合計で 50 以上の C# プロジェクトを含む複数の VS ソリューションがあります。まず、プロジェクトのソース コードからヘルプ (将来的には chm & help2 & help3) を生成したいと考えています。そのドキュメントを「参照ドキュメント」と呼びます。サンドキャッスル (特にSCFBを使用した場合)）これは非常に良い方法で行うことができます。しかし (非常に一般的な状況だと思います)、フレームワーク/ライブラリに関する追加のドキュメントがあります。そのドキュメントは MS Word ファイル (5 ～ 10 ファイル) です。そのドキュメントを「概念ドキュメント」と呼びます。概念ドキュメントと参照ドキュメント (MSDN など) を備えた堅固なヘルプ システムを作成したいと考えています。また、ヘルプの概念部分には、フレームワーク/ライブラリからのすべての .NET タイプ名のヘルプの参照部分を参照するリンク (URL) が含まれている必要があります。(明らかに、どのヘルプ システムも最終的には単なる HTML です)。

問題は、これらのリンクを作成する方法です。MS Word ファイルは、C# xmldoc について何も知りません。Sandcastle は Word ファイルをサポートしていません。そのため、ヘルプ オーサリング ツール (HAT) を使用する必要があります。今のところ、適切なツールが見つかりません。そして、私はどんな助けにもとても感謝しています!

すべてのツールの障害は、リンクの自動作成です。生成中にリンクが自動的に作成されるようにします (ビルド サーバーで実行できます)。なぜ自動的に？型の名前を簡単に変更できるためです。たとえば。概念ドキュメントにテキストがあります:「リクエスト処理コンテキストにアクセスするには、XOperationContext タイプの静的プロパティ Current を使用します」。ここで XOperationContext は型名です。結果ヘルプシステムの XOperationContext クラスの仕様へのリンク (URL) を、さほど手間をかけずにできるようにしてほしいです。Word（おそらくHATのプラグインがインストールされている）またはHATのエディターで、「可能であればこの単語をリンクする」のようなものとしてマークしたいと思います。生成中に、そのような名前の型名があれば、そのような単語はそれぞれリンクになります。

私はこれらのツールについて知っています：

• Toolsfactory Doc-o-Matic (現在使用中)
• Innovasys DocumentX と HelpStudio
• ComponentOne Doc-to-Help

Doc-o-Matic サポート リンクの自動作成。本当に自動的に。PascalCase の各単語のリンクを作成しようとします - 見事です。ただし、MS Word には対応していません。Innovasys および ComponentOne のソフトウェアは、リンクの自動作成をサポートしていません。Innovasys のソフトウェアは MS Word をサポートしていません (これについては 100% 確信が持てません)。

Innovasys と ComponentOne のフォーラムで質問してみました。これまでのところ運がありません。私のような Innovasys のソフト サポート シナリオ: 別のツール (HelpStudio) で概念的なドキュメントを作成し、別のツール (DocumentX) でソース コードからヘルプを生成する。ただし、リンクを自動的に作成して MS Word ファイルをインポートする機能はありません。

ですから、その一般的なタスクの有効期限を共有してください (一般的なはずです)。

ps 英語の文法の観点から自分の考えを正しく説明できていない場合はお知らせください。もう一度試します。

Eclipse プラグインのオンライン ヘルプ (Eclipse ヘルプ形式) を作成する必要があります。Instantiations の RCP Developer の一部として提供される Help Composer の評価を試してみましたが、私が探していた機能をほとんど実行してくれました。しかし、1 ライセンスあたり 500 ドルというのは、私のニーズに対してはやり過ぎであり、予算を超えています。

ヘルプ プロジェクトを管理し、さまざまなファイル、目次を組み立て、WYSIWYG を使用して html ドキュメントを編集するためのツールが他にあるはずです。

完全なオーサリング機能を提供するために、基本的な Eclipse 3.5 インストールに追加する必要があるプラグインについて何か提案はありますか?

前もって感謝します！

Google ヘルプ システムに基づいて、アプリケーションの 1 つの HTML ヘルプを作成したいと考えています。Google ヘルプ システムが Google の外部で利用できるかどうか知っている人はいますか? はいの場合、それを取得する方法。オーサリングツールとは？オープンソースのツールですか？

そうでない場合、同じ風味のオーサリング ツールはありますか?

私が作成したいヘルプの種類は、たとえば http://docs.google.com/support/で得られるものです。

特に、ユーザーがヘルプトピックに関するフィードバックを提供できるようにするオプションがあります。

この情報はお役に立ちましたか？はい いいえ わかりやすい？はい いいえ 十分な詳細を記入しますか? はい・いいえ

これが役に立たなかった理由を教えてください。ありがとうございました！

どうすればこれを改善できますか? ありがとうございました！皆様からのフィードバックは、ヘルプ センターの改善に役立てさせていただきます。

HTML ヘルプ ワークショップでプロジェクトを作成しました。ヘルプ (/chm) アプリケーションを開くと、目次が表示されました。デフォルトでは、ファイルの最初のエントリが選択されています。

ただし、対応するページ データが表示されず、代わりに「このプログラムは Web ページを表示できません」(IE7 のデフォルトのエラー メッセージ) が表示されます。左側のコンテンツのいずれかをクリックした場合にのみページが表示されます。

エントリをクリックせずにデフォルトでページを表示する方法はありますか?

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

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

理想的には、ソリューションは次のようになります。

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

先に進み、これをwikiにして、いくつかの例から始めます。それらの経験がある場合は、賛成または反対に投票し、コメントを残してください。追加のツールも追加します。

ヘルプ（.chm）アプリケーションを開くと、目次が表示されました。デフォルトでは、ファイルの最初のエントリが選択されていますが、対応するページデータが表示されませんでした。代わりに、「このプログラムはWebページを表示できません」（IE7に表示されるデフォルトのエラーメッセージ）が表示されます。ページは、左側のコンテンツのいずれかをクリックした場合にのみ表示されます。

エントリをクリックせずにデフォルトでページを表示する方法はありますか？

次のコードは.hhpファイルです。

QtHelp（.qchおよび.qhc）にコンパイルする必要があります。これにはどのツール/ツールチェーンが最も簡単か疑問に思いますか？WYSIWYGヘルプオーサリングツールを出発点として、そこからの出力をQtHelpを取得するために必要なものすべてに実行する必要があります。

過去にヘルプとマニュアルを使用しましたが、これはヘルプオーサリングツールで探している種類のWYSIWYGインターフェイスです。qhelpgeneratorただし、またはで使用できる単純なhtmlページ（ヘルプトピックごとに1つ）を生成するためのツールチェーンが必要です。またqcollectiongenerator、.qhp（少なくとも目次とキーワードセクション）と.qhcpを作成して.qchを生成する必要があります。および.qhc。ヘルプとマニュアルがこれにどのように適合するのかわかりません。

Sphynxについて簡単に説明しましたが、テキストの書式設定のオプションが非常に限られているようです。たとえば、テキストのセクションのフォント、フォントサイズ、フォントの色などを変更する方法はないようです。太字と斜体の両方のテキストを使用することは実際には不可能のようです。開発者向けドキュメントには最適に見えますが、ユーザーヘルプファイルを作成するための基本的なものが不足しているようです。どういうわけか基本的なテキストフォーマット機能を見逃した場合は、私を訂正してください！

では、どのWYSIWYGヘルプオーサリングツールをお勧めしますか。また、そのツールから.qchおよび.qhcへのパスは何ですか。

Wiki のようなソフトウェア製品のヘルプ ドキュメントを作成できるヘルプ オーサリング ツールが存在するかどうか知っている人はいますか? 現在、Confluence wiki エンジンを使用しています。これは非常に優れており、Apache サーバーを必要とせずにそのようなものがあるかどうか疑問に思っていました。ユーザーに必要なヘルプ ドキュメントを提供できるスタンドアロンの何か。ヘルプ オーサリング ツールを使用してきましたが、それらはすべて Wiki に比べて非常に扱いにくいように見えます。

RoboHelp 9 で WebHelp ヘルプ システムを作成しています。これは状況依存のオンライン ヘルプになります。システムが作成されたソフトウェア製品には、ほとんど同じような 3 つのユーザー「コンテキスト」がありますが、わずかな違いがあります。私の目標は、ユーザーに関連するヘルプ コンテンツのみを表示することです。

私の問題を説明すると: アプリケーションで、ユーザー A が Foo を追加すると、フィールド 1、2、および 3 が表示されます。ただし、ユーザー B が Foo を追加すると、フィールド 1、2、および4が表示されます。ユーザー A が [追加] 画面の [ヘルプ] リンクをクリックすると、表示内容を正確に説明するヘルプ トピックが表示されます。ユーザー B が [ヘルプ] リンクをクリックすると、表示内容に合わせて調整されたコンテンツが表示されます。

この目標を達成するために、ソフトウェアのさまざまなコンテキストに対してテキスト レベル (トピック内) で状態インジケーターを追加しようとしています。

私の質問は、ヘルプ システムを出力するときに、コンディショナル ビルド タグを使用して、コンテキストごとに 1 つずつ、3 つの完全なヘルプ システムを生成する必要があるかどうかです。次に、開発者がコンテキスト マップ ID をプラグインするとき、正しいヘルプ システムにアクセスするには、a_pszHelpFile パラメーターに別の場所を渡す必要がありますか?

上記は、任意のページでヘルプ リンクをクリックする可能性のある各タイプのユーザーに対して TOC とトピック テキストが正しいことを確認するために考えられる唯一の方法ですが、条件付きビルドごとにヘルプ システム全体を生成するのは面倒に思えます。鬼ごっこ。