素晴らしいユーザードキュメントの9つのヒント（例付き）

ユーザードキュメントは、顧客に提供される製品全体の重要な部分です。 それはエンドユーザーがあなたの製品やサービスでより成功するのを助けます。

以前は、ユーザードキュメントは、ユーザーのマシンにローカルなヘルプファイル、または物理的なマニュアルや小冊子を介して提供されていました。 つまり、簡単に更新または変更することができず、ソフトウェアプロバイダーはコンテンツの使用方法に関するデータをほとんど取得していませんでした。

現在、ユーザードキュメントはほとんどの場合オンラインで提供されており、テクニカルライターがユーザーを支援する方法についてより想像力を働かせるのに役立っています。 彼らはデータを収集し、さまざまな学習手法を試し、より迅速に反復し、ユーザーにとってより豊かなコンテンツ体験を生み出すことができます。

そこで、このブログ投稿が登場します。 私

この投稿では、ユーザードキュメントを改善するために何ができるかを探り、優れたユーザーサポートコンテンツの例をいくつか確認します。

計画から始める

人生のほとんどのものと同様に、計画から始めるのが最善であり、ユーザードキュメントの作成も例外ではありません。 そのため、開始する前に、自分自身（および場合によってはドキュメントを要求している人）に多くの質問をするようにしてください。

1.視聴者を考慮します

誰のために作っているの？ エンドユーザー？ システム管理者？ このコンテンツは内部でのみレビューされますか、それとも外部でも表示されますか？ ユーザードキュメントを作成する相手は、共有する情報を組み立てるのに役立ちます。

2.最終目標を評価し、念頭に置いてください

ドキュメントの主な目的は、聴衆に何かを教えることです。 誰がドキュメントを消費するかを決定した後、ドキュメントから何を取得するかを決定する必要があります。

ドキュメントを確認した後、視聴者に実行してもらいたいアクションは何ですか？ その質問への回答を念頭に置くことで、問題のタスクに適切な量のコンテンツを提供できるようになります。

3.ユーザードキュメントが簡単に見つけられることを確認します

隠されたユーザードキュメントは、悪いユーザードキュメントとほとんど同じくらい役に立たない。 作成するユーザードキュメントが、それを必要とするユーザーが簡単に見つけられるようにすることが重要です。

これは、それが表示されていることを確認するだけでなく、ユーザーが技術文書内をナビゲートして、質問に対する回答をすばやく見つけることができることも意味します。

あなたの聴衆がそれらの答えをより早く見つけることができれば、彼らはより幸せになるでしょう。 また、製品に関する重要ではあるが一般的な質問に答える必要がなくなるため、時間を節約できます。

簡潔で強力な文章

優れたユーザードキュメントには、強力な記述が不可欠です。 しかし、書くことは、ユーザーのドキュメントがどのように読んだり聞こえたりするかだけではありません。 また、ユーザードキュメントのナビゲートがいかに簡単であるかに影響を与える可能性があります。

4.説明的なタイトルとサブタイトルを書く

タイトルが有用であり、最も重要なこととして具体的であることを確認してください。 多くの場合、質問に答えるために作成されたタイトルや字幕を書くのが最善です。 このようにタイトルをフレーミングすると、エンドユーザーが探しているものを見つけやすくなり、ユーザーのニーズに直接対応する記事を書くのにも役立ちます。

Unbounceは、ユーザードキュメント全体に効果的なタイトルとサブタイトルを書くという素晴らしい仕事をします。 これにより、ドキュメントを簡単にナビゲートできます。 それぞれの特定の記事には独自の目次があり、特定の質問に対する答えを簡単に見つけることができます。

5.閲覧しやすくする

スキャンしやすい方法で情報を提供することは、ユーザーが時間を節約するのに役立ちます。 人間として、私たちは私たちが得ることができるどんな時間節約にも感謝します。 さらに、ユーザーは自分が探しているものを正確に知らない場合があります。 閲覧しやすいコンテンツが最も有益なのはそのときです。

IBMは、クリーンな目次を編成し、関連トピックを提供することにより、ヘルプ・コンテンツを簡単に閲覧できるようにするという優れた仕事をしています。

6.簡単に検索できるようにする

Googleは、質問の答えを見つけるのは検索ボックスに入力するのと同じくらい簡単であることを私たちに教えてくれました。 ヘルプドキュメントは、この期待を反映している必要があります。 ヘルプコンテンツが検索できない場合は、おそらくあまり役​​に立ちません。

Hubspotの詳細な知識ベースにより、クライアントのセルフサービスが容易になります。

ビジュアルを使用して理解を深める

優れたユーザードキュメントは非常に視覚的です。 優れたユーザードキュメントには強力な文章とテキストが不可欠ですが、ビジュアルも存在する場合に人々は最もよく学習します。

7.注釈付きのスクリーンショットを使用する

注釈付きのスクリーンショットは、ユーザードキュメントで使用できる強力なビジュアルです。 ユーザーが実行する必要のある手順を正確に示すことで、ユーザーの当て推量を排除します。

TechSmith Snagitのようなプログラムを使用すると、スクリーンショットにテキストの呼び出しや矢印などを簡単に追加できます。 たとえば、このブログ投稿全体で、Snagitで作成した注釈付きのスクリーンショットを使用していることに気付くでしょう。

インスピレーションを感じている場合は、Snagitのステップツールを試してみることもできます。このツールを使用すると、ポイントしてクリックするときに順序付けられたコールアウトを配置することで、画像の一部を識別できます。 クリックして別のステップを追加するたびに、番号が自動的に進みます。

ドキュメントでスクリーンショットの力を活用するという素晴らしい仕事をしている会社はAsanaです。 すばらしいユーザードキュメント全体で、注釈付きのスクリーンショットを使用して顧客を明確にガイドしています。

8.語るのではなく見せるビデオを活用する

ビデオは、プロセスを示すのに適しています。 多くのすばらしいユーザードキュメントは、ビデオの力とテキストによる指示を組み合わせています。 たとえば、短いビデオを使用してプロセスをすばやくウォークスルーすることをお勧めします。

次に、ビデオと一緒に、ユーザーが自分でプロセスを試すときに参照できるテキストのステップバイステップガイドを提供できます。 そうすれば、簡単なリマインダーが必要な場合でも、ビデオを何度も見る必要がありません。

TechSmith製品チュートリアルでは、メインビデオを使用して、説明している機能またはトピックの完全な概要を説明します。 次に、ビデオの下に、ビデオの要点を繰り返すためのスクリーンショットまたはアニメーションGIFを伴うスニペットを提供します。

9.例と最終結果を表示する

ユーザーは、各タスクを正常に完了することがどのように見えるかを知る必要があります。 最終結果の例のスクリーンショットをユーザーに提供することは、視聴者に理想的な結果を示す良い方法です。

優れたユーザードキュメントにより、エンドユーザーは質問に対する回答を簡単に見つけることができ、満足のいく満足のいくユーザーが作成されます。

優れたユーザードキュメントを作成するための重要な部分は、明確で簡単にスキャンできる情報を提供することです。 スクリーンショット、ビデオ、アニメーションGIFなどのビジュアルはすべて、ユーザーとより効率的かつ効果的にコミュニケーションするための優れた方法です。