ウェブアプリケーション用のインタラクティブマニュアルの例

Question

ウェブアプリケーションのヘルプ（たとえば、ボタンの機能の説明を表示する）が必要です。これを行う良い例はありますか？

Answer 1

私は非常にエレガントで離散しているビルドエンジンハドソンの助けを見つけました。

ヘルプアイコンがあります。クリックすると、ヘルプテキストがページ内に展開され、もう一度クリックすると消えます。

https://hudson.dev.java.net/hudson.jnlpを試してみて、http：// localhost：8080/configureに移動し、右側の多数の（？）ボタンをクリックしてください。

Answer 2

Java Docは、Javaコードファイル

Answer 3

の内側に組み込まれたすべてのコメントを抽出するために使用することができJavaHelpのを見てください。古いバージョンのWindowsで見つかったヘルプシステムをエミュレートする

Answer 4

ドキュメントをWikiに書くのはとても現代的です。編集が簡単で、構造が整いました。
しかし、私はそれが嫌いです。私は本当にそれが嫌いです。決して構造化されておらず、読みやすい。 Wikiに入れるためには、多くの努力が必要です。

シンプルなCMSを使用することをお勧めします。過度な習慣はなく、リンクによるテキストの編集だけです。それをあなたのwebappに統合するオプションがあります。そこからPDFを抽出する可能性があります。
これは、印刷などのためにオフラインヘルプを提供するためのきちんとしている

Answer 5

私はちょうど良い古いHTML/CSSを使用したい - これは行動ユーザーは既にブラウザに知っ維持します、あなたはすでにのスタイルシートを持っている必要がありますこのアプリケーションでは、ほとんど手間をかけずにヘルプページを通じてL & Fを維持します。

Googleマップのヘルプ（http://maps.google.co.uk/support/）を見てみましょう - レイアウトのアイデアのために、など

を私は、Googleのヘルプページを見たとき、私は予告をしたことの一つが検索（そこには驚き）だった、これあなたのサイトが外部に面している場合、私は 'site：< your site>'キーワードを使ってこれを実装し、Google検索を使用します。あなたのサイトが内部的なものであれば、あなた自身の検索をロールバックする必要がありますが、それはあまり難しくはありませんし、おそらくかなり楽しいサブプロジェクトです。

Answer 6

PHPを使用している場合はphpDocumentorをご覧ください。

phpDocumentorのツールはPHPで書かれたのJavaDoc と同様スタンドアロン 自動のDocumentorあります。

Answer 7

あなたは各ボタンが何をするかを示すマニュアルを生産で探しているなら、私は、画面との対話を記録した後、FlashムービーやPDFのいずれかにそれを変換するのに有用なDebugmode WinkまたはAdobe Captivateのようなものを使用して見つけました。

Answer 8

具体的にはRails用： http://github.com/darthapo/comatose/tree/masterは、埋め込みヘルプシステムに使用できる小さなCMSツールです。

それ以外の場合は、http://tenderapp.com/がホスティングソリューションとしてうまく機能します。