web-dev-qa-db-ja.com

Webアプリケーションのユーザーマニュアルを設計するための最も革新的な方法?

ウェブアプリケーションのユーザーマニュアルを提示/デザインする最良の方法は何ですか?

問題

私はエンドユーザーとクライアントにユーザーマニュアルを共有/提示するWebアプリケーションを持っています。スクリーンカットを使って文書化する通常の方法は非常に長く、時間がかかりました。Webアプリケーションのユーザーマニュアルを提示する最良の方法は何でしょうか?

考えられる解決策

私は可能な解決策かもしれない以下の解決策を探求しました

  1. Chmファイルを設計してお客様に提供:使いやすさとして、左側と右側を読み取ることができます

  2. 段階的な実行でビデオデモを提示する:使いやすさに関してはインタラクティブになるため、生成する1つの方法はswfファイルを使用することでした

3.アニメーションキャラクターを使用したビデオプレゼンテーションの作成:エンドユーザーが子供である場合、これは良いかもしれませんが、専門的な方法としては適切ではない可能性があります

4.雑誌型プレゼンテーションの作成:フリップブックなどの雑誌型マニュアルをユーザーに提示

私が探しているもの

上記のソリューションとは別に、Webアプリケーションのユーザーマニュアルを提示する革新的な方法は何でしょうか。

それを提示しながら、私は使いやすさとより専門的な方法に期待したいと思います

ユーザーマニュアルに対するコミュニティの提案は何でしたか?

私の経験から、ユーザーはマニュアルを最初から最後まで読んでいません。彼らはしばしば自分自身で、または同僚に尋ねることによってタスクを完了できないソリューションに自分自身を見つけます。したがって、マニュアルを作成するときは、このタスクベースの考え方に対処する必要があります。

多くの場合、どのメディアを使用するかは重要ではありませんが、重要なのは、+ 100ページのドキュメントを無制限にスクリーンショットでブラウジングする手間をかけずに、手動でタスクをすばやく解決できることです。代わりに、ユーザーのタスクに応じて分類および構造化されたさまざまなコンテンツをすべて配置できるWebの機能を使用します。タスクが複雑で難しい場合は、順を追ったビデオをフォローするとよいでしょう。タスクが単純な場合は、ユーザーが実行する必要があることを書き留め、スクリーンショットを提供します。

おそらく、すべてのタスクについてコメント形式でフィードバックを許可できます。そして、これらのコメントに基づいて、特権のある作成者がコンテンツを編集できます。それがあなたまたは組織内で信頼されている誰かである場合、それは本当に重要ではありません。最初のバージョンが常に最適なバージョンであるとは限らないため、マニュアルを頻繁に更新するようにしてください。経験豊富なユーザーがいる場合は、wikiが良い解決策になるかもしれません。また、ユーザーが必要なコンテンツをすばやく見つけられるように、マニュアルをサポートする優れた検索エンジンを用意することを忘れないでください。

キーワードは、タスク指向で検索可能で、適切に構成されたマニュアルです。

2
Benny Skogberg

Webアプリであることは、エンジニアがいつでも変更できることを意味します。つまり、ドキュメントをすばやく更新できる必要があります。

Webアプリであることは、複数のブラウザで実行されることを意味します。つまり、アプリが実行される可能性のあるすべての環境でユーザー支援が利用可能である必要があります。

1
StormyKnight

最近のサイトの多くは、基本を説明する コーチマーク を使用しています。 Googleは、アプリケーション(Gmail、写真)を再設計するときと、Inboxを起動するときにそれを使用しています。

サービスに最初にログインしたときに表示されます。ガイドを完了すると、ガイドは表示されなくなりますが、何らかの方法でガイドを再起動することができます。

0
Assimiz