ユーザーヘルプドキュメント（ソフトウェアからのchm、html、ハイパーリンク）

私はアプリケーションを持っており、今はユーザーヘルプドキュメントを書く時間です。少なくとも3つの機能が必要です：ユーザーヘルプドキュメント（ソフトウェアからのchm、html、ハイパーリンク）

オフラインのUserHelp.chm;
オンライン版index.html;
winformで "help"をクリックすると、指定したヘルプページを表示できます。

私のプロジェクトにはどのようなツール（HTMLワークショップ？）が完璧ですか？私にいくつかの一般的なガイドラインを教えていただければ幸いです。

2011-01-08 Peter Lee

これはC＃または.NETと何が関係がありますか？ –

私はwinformが.NETであると仮定します。それ以外の場合は、winapiまたはGDI形式になります:-) –

要件＃1と＃2については、SandCastleを使用することをお勧めします。それは、chmファイルとASP.NETページを生成することができます。最も重要なことは、このプロジェクトは依然としてMicrosoftによって活発に維持されていることです。

要件3の場合は、「状況依存ヘルプwinform」をGoogleに送信できます。あなたは多くの参照を見つけることができるはずです。それは無料であってはならない場合はここでone of them from code project

出典

2011-01-08 03:54:48

@Harvey、私は開発者のTechAPIヘルプドキュメントにSandCastleを使用しています。ユーザーのドキュメントで使用するのは大丈夫か簡単ですか？ –

@Peter、私はあなたの質問を誤解しました。 APIのヘルプを作成していると思いました。おそらく、これは私の会社がどのように働いているかによるものです。開発者はAPIのヘルプを担当し、テクニカルライターはユーザーのヘルプを担当します:)。とにかく、SandCastleでは概念的なコンテンツを書くことができます。これは非常に原始的で、HTMLワークショップとほとんど変わりません。私たちの会社のテクニカルライターは、chm、pdf、およびWebページを生成するために、フレームメーカを使用するのが好きです。 –

@Harvey、あなたの返事をありがとう。私はSandCastleをAPIヘルプに使用しました。これは、開発者がすべてのクラスと関数にXMLスタイルのコメントを付けることを要求しています...ユーザードキュメントにSandCastle（概念コンテンツ）を使用すると、Tech Writerは変更する必要がありますソースコード？ –

ですが、私はヘルプ&マニュアルについての良いものを聞いた：http://www.ec-software.com/

Helpwareのを別のよく知られたベンダーです：http://www.helpware.net/

出典

2011-01-09 12:24:33

私はH＆Mをチェックしましたが、それは無料ではないと思われます:-) –

あなたはあなたの要求に自由に言及しませんでした。 –

はHelpinatorをチェックし、それは、あまりにも良いですが、安価で無料版があります。

出典

2011-06-28 18:24:49

無料版のHelpinatorにはいくつかの機能が欠けているようです：http://www.helpinator.com/upgradetopro.html –

ユーザーヘルプドキュメント（ソフトウェアからのchm、html、ハイパーリンク）

答えて

関連する問題