優れたヘルプコンテンツを作成するための5つの実証済みの方法

ヘルプ作成者の仕事は、複雑なトピックをシンプルにすることです。つまり、発見と消化が容易な方法で高レベルと低レベルの情報を構造化することです。

実際には、タスクベースの手順で概念をわかりやすい言葉で説明できれば、優れたヘルプを開発するための道を進んでいます。タスクが少数のステップを超えるプロセスである場合は、タスクを小さなチャンクに分割するのが最善です。

各トピックの上部に高レベルのプロセスの概要を含めて、一連のタスクがより大きなプロセスでどのように機能するかを説明します。その時点で、ユーザーはプロセスのどの部分に行き詰まっているか、興味を持っているかを特定し、必要な低レベルの情報に移動できます。ライターとして、プロセスの概要を説明するこのアクティビティも役立ちます。これは、タスクベースのドキュメントにある可能性のあるギャップや穴を明らかにするためです。

1。ビデオから始める

優れたヘルプコンテンツを提供するすべての方法の中で、テキストの巨大な壁はおそらく最も役に立たないでしょう。調査によると、人々はビデオやビジュアルコンテンツを好むだけでなく、提供された方が実際にパフォーマンスが向上します。彼らはそれをもっと長く覚えています！文字通り、win-win-winです。

ユーザーがタスクの実行方法を確認できると、ユーザーは自分が何をする必要があるかをより早く理解できます。

ただし、すべてのユーザーが同じ方法でビジュアルコンテンツとビデオコンテンツを利用できるわけではないことを忘れないでください。障害を持つユーザーのアクセシビリティを念頭に置いてコンテンツを常に作成してください。すべての画像には代替テキストを含める必要があり、すべての動画には音声ガイドとキャプションを含める必要があります。

2。ユーザーが知っておくべきだと思うものではなく、必要なコンテンツをユーザーに提供します。

これは直感に反するように思えるかもしれませんが、あなたのようにあなたの製品を知っている人は誰もいませんが、顧客が何を必要としているのかを顧客自身よりもよく知っている人は誰もいません。

多くの場合、私たちはクールな機能やその他のベルやホイッスルを披露したいと思うことに夢中になり、ほとんどのお客様がソフトウェアアプリケーションの機能の小さなサブセットを使用している可能性があることを忘れています。

そして、それは大丈夫です！

より上級のユーザーに話しかけたり、お気に入りの新機能を披露したりするコンテンツを作成できますが、平均的なユーザーとその平均的な問題を忘れないでください。ソフトウェアの使用方法とユーザーインターフェイスの操作方法の基本を説明します。可能な限り最善の方法で開始するのを手伝ってください。そうすれば、おそらく、より高度なユースケースを探すことができます。

では、顧客がどのようなコンテンツを必要としているかをどうやって知るのでしょうか。最も簡単な方法は、単に彼らに尋ねることです！調査、円卓会議、および顧客インタビューは、顧客がソフトウェアをどのように使用し、何に苦労しているのかを知るための素晴らしい方法です。そして、私はあなたがあなたが考えもしなかったことを学ぶことを保証します。

ほとんどの企業は、ソフトウェア自体から貴重なデータを収集することもできます。たとえば、最も人気のあるツール、ほとんどのユーザーが好む出力の種類などです。

3。ユーザー主導の言語を選択する

一般的に、簡潔に、能動態で書きます。開発者があなたに物事を説明するために使用した用語ではなく、ユーザーが検索する単語やフレーズを使用してください。

あなたの聴衆を覚えておいてください。視聴者が製品についてどのように話しているかを理解するのに役立つデータがある場合は、それを使用して用語に関する決定を通知します。

製品が複雑で技術的であっても、あなたの助けは必要ありません。それを分解し、読者のためにデコードします。会話型の制御された言語を使用します。彼らはそれを高く評価するでしょう。

能動態で書く方法の詳細については、デューク大学が発行しているこのライティングリソースをご覧ください。

4。検索エンジン向けに最適化

優れたヘルプコンテンツは、いつどこで検索すると表示されます。それは製品を意味する場合もあれば、ウェブ上を意味する場合もあります。

ユーザーがGoogleを開いて回答を検索する場合は、あなたが権威者である（またはあなたがなりたい）ので、ユーザーにあなたの助けを見つけてもらいたいと考えています。

彼らが内部サイト検索を開いた場合でも、適切な記事を結果の一番上に表示する必要があります。つまり、検索エンジンがページをカタログ化してランク付けする方法に注意を払い、それを念頭に置いてヘルプ記事を作成する必要があります。

出力がPDFであろうとWebページであろうと、検索用にページを最適化するためにできることがあります。

5。関連記事とリソースの相互参照

トピックに関連するサポート記事、ブログ投稿、またはチュートリアルがある場合は、ページでそれらを相互参照することをお勧めします。

多くの場合、これらの他のリソースは、わずかに異なる方法で主題にアプローチするか、ユーザーの成功に役立つ可能性のある、より技術的または有益な視点を提供します。