Web アプリのヘルプを作成する必要があります (たとえば、ボタンの機能の説明を表示するなど)。これを行うための良い例はありますか?
8 に答える
古き良きHTML/CSSを使用します。これにより、ユーザーがブラウザーで既に知っている動作が維持され、アプリケーションのスタイルシートがすでに用意されているはずなので、追加の作業をほとんど必要とせずにヘルプページでL&Fを維持できます。
レイアウトのアイデアなどについては 、Googleマップ(http://maps.google.co.uk/support/ )のヘルプをご覧ください。
グーグルのヘルプページを見たときに気づいたことの1つは検索でした(そこには驚きはありません)。これは少し注意が必要かもしれません。サイトが外向きの場合は、'サイト:<あなたのサイト>でこれを実装します。 'キーワードとGoogle検索を使用します。サイトが内部にある場合は、独自の検索を行う必要がありますが、それはそれほど難しいことではなく、おそらく非常に楽しいサブプロジェクトになるでしょう。
PHP を使用している場合は、phpDocumentorをご覧ください。
phpDocumentor ツールは、PHP で書かれた JavaDoc に似たスタンドアロンの自動ドキュメンターです。
特に Rails の場合: http://github.com/darthapo/comatose/tree/masterは、組み込みのヘルプ システムに使用できる優れた小さな CMS ツールです。
それ以外の場合は、http://tenderapp.com/がホスト ソリューションとして適切に機能します。
JavaHelp を参照してください。古いバージョンの Windows に見られるヘルプ システムをエミュレートします。
Java Docを使用して、Java コード ファイル内に組み込まれたすべてのコメントを抽出できます。
ドキュメントを Wiki に書くのは非常に現代的です。編集しやすい、構成がいいなど。
でも、嫌いです。私は本当にそれが嫌いです。決してうまく構成されていて読みやすいわけではありません。ウィキをより良いものにするためには、多くの努力が必要です。
そのため、シンプルな CMS を使用することをお勧めします。リンクを使ってテキストを編集するだけです。それを Web アプリに統合するオプションがあり、そこから PDF を抽出する可能性があります。
これは、印刷などのオフライン ヘルプを提供するのに便利です。
ビルド エンジン Hudson のヘルプは非常にエレガントで目立たないものであることがわかりました。
ヘルプ アイコンがあり、それをクリックすると、ヘルプ テキストがページ内に展開され、もう一度クリックすると消えます。
https://hudson.dev.java.net/hudson.jnlpを起動して http://localhost:8080/configure に移動し、右側にある多くの (?) ボタンをクリックしてみてください。
各ボタンの機能を示すユーザー マニュアルの作成を検討している場合は、Debugmode Winkや Adobe Captivate などを使用して画面の操作を記録し、それを Flash ムービーまたは PDF に変換すると便利です。