私は c# 4.0 で WinForm アプリを開発していますが、他の (開発者ではない) 同僚に状況依存のエンド ユーザー ヘルプファイルの作成に協力してもらいたいと考えています。最初は Microsoft の「HTML Help Workshop」が使えると思ったのですが、時代遅れのようです (Vista と Windows 7 はサポートされていません)。次に Sandcastle を見てみましたが、ドキュメントが不足しており、技術者以外のユーザーがエンドユーザー ドキュメントを作成するのに適しているかどうか疑問に思っています。RoboHelp について読みましたが、私にとっては高すぎます。ヘルプファイルに関して利用可能なすべての情報に迷っています。どのツールを使用するか、どの出力形式をターゲットにすべきか (まだ chm またはその他) について、ベスト プラクティスや情報を提供してくれる人がいますか?
3 に答える
素晴らしい質問です。開発者以外の人がエンドユーザーのドキュメントに貢献するというあなたの考えが好きです。
このアイデアは、アプリケーションのユーザーとテスターがドキュメントに簡単に貢献するように動機付ける可能性があります。
私が最初に頭に浮かぶのは、ある種のwikiエンジンを使用することです。WinFormアプリケーションで、ブラウザーを起動してWikiに誘導する単純な関数を作成できます。呼び出されたコンテキストを使用してURLを作成できます。例:http://dev-wiki.mycompany.com/LoginForm?action=edit
。ここでは、フォームの名前( "LoginForm")がwikiページのURLで使用されています。
または、WinFormsに埋め込まれたWebブラウザコントロールを使用して、Wikiにアクセスすることもできます。これは次のようになります。
var url = GetWikiUrl(myForm);
browserControl.Navigate(url);
これは、アプリケーションに組み込むのが非常に簡単です。
制御された(オフィス)環境では、これは非常に簡単に設定できます。実稼働環境では、少し難しいかもしれませんが、それでも実行可能です。エンドユーザーの貢献も活用する可能性があります。
ドキュメントを書くために、私はスフィンクスを使用します。プレーンテキストで文書化でき、さまざまな出力形式(chm、html、pdfなど)があります。
これらの一部(chm、html)は、状況依存ヘルプソースとして使用できます。
単純ですが、sphinxのユーザーインターフェイス(テキストエディターとmakeファイル)は、技術者以外のユーザーには適していない可能性があります。
CHM ドキュメントの作成にはHelp+Manualを使用することをお勧めします。これは MS Word に似ており、PC ユーザーなら誰でも簡単な教育を受けた後、ドキュメント開発に貢献し始めることができます。しかし、このツールは無料ではありません:(