c＃winformアプリのエンドユーザードキュメントのエディター

Question

私はC＃4.0でWinformアプリを開発していますが、他の（開発者以外の）同僚に、コンテキストに敏感なエンドユーザーヘルプファイルを書くことを貢献してほしいと思います。最初に、Microsoftの「HTML Help Workshop」を使用できると思いましたが、時代遅れのようです（VistaとWindows 7はサポートされていません）。それから私はサンドキャッスルを見ましたが、ドキュメントが不足しており、非技術的なユーザーがエンドユーザーのドキュメントを書くのに適しているのだろうかと思います。だから私はロボヘルプについて読んだが、それは私にとって高価な方法だ。ヘルプファイルについて利用できるすべての情報で迷子になっています。誰かが使用するツールと、ターゲットにする必要がある出力形式（まだCHMまたはその他）に関するいくつかのベストプラクティスまたは情報を提供するのを手伝うことができます。

Answer 1

素晴らしい質問。エンドユーザーのドキュメントに貢献していない開発者のアイデアが気に入っています。

このアイデアは、アプリケーションのユーザーとテスターがドキュメントに簡単に貢献するように動機付けられる可能性があります。

私の頭に浮かぶ最初のことは、ある種のWikiエンジンを使用することです。 Winformアプリケーションでシンプルな機能を構築することができます。これにより、ブラウザを起動し、Wikiに向けることができます。 URLを構築するために呼び出されるコンテキストを使用できます。例えば http://dev-wiki.mycompany.com/LoginForm?action=edit. 。ここでは、フォームの名前（ "loginform"）がWikiページのURLで使用されます。

または、埋め込まれたものを単純に使用することもできます Webブラウザーコントロール winformsがwikiにアクセスするため。それは次のようになります：

var url = GetWikiUrl(myForm);
browserControl.Navigate(url);

これは、アプリケーションに簡単に埋め込むことができます。

制御された（オフィス）環境では、これは非常に簡単にセットアップできます。あなたの生産環境では、それはもう少し難しいかもしれませんが、それでも実行可能です。エンドユーザーの貢献も活用するかもしれません。

Answer 2

ドキュメントを書くために、私は使用します スフィンクス。プレーンテキストで文書化することができ、さまざまな出力形式（CHM、HTML、PDFなど）があります。

これらの一部（CHM、HTML）は、コンテキストに敏感なヘルプソースとして使用できます。

ただし、単純に、Sphinxユーザーインターフェイス（テキストエディターとファイルの作成）は、非技術的なユーザーには適していない場合があります。

Answer 3

使用することをお勧めします ヘルプ+マニュアル CHMドキュメントを作成するため。それはMS Wordに似ており、PCユーザーは短い教育後にDoc Developmentに貢献し始めることができます。しかし、このツールは無料ではありません:(