優れたクイックリファレンスガイドの作成方法

クイックリファレンスガイドとは

クイックリファレンスガイドは、製品の使用方法に関する1ページまたは2ページの要約された手順のセットを提供するドキュメントです。 必要なものに応じて、非常に詳細にすることも、非常に単純にすることもできます。

ほぼすべての製品には、顧客がその使用方法を理解するのに役立つ何らかのドキュメントが必要です。 製品によっては、これらのユーザーガイドや製品マニュアルが数百ページの長さで、ページが長いテキストブロックでいっぱいになる場合があります。

言い換えれば、特に新規ユーザーにとっては、かなり気が遠くなる可能性があります。

明らかに、製品で実行できるすべてのことを網羅したドキュメントが必要です。 しかし、顧客は、大量のコンテンツを探し回ることなく、何かを知りたいだけの場合があります。

クイックリファレンスガイドは、すばやくアクセスできる豊富な情報を、わかりやすく魅力的な方法でユーザーに提供するのに最適な方法です。

学習する内容は次のとおりです。

• どうしてそれが重要ですか？
• 優れたクイックリファレンスガイドを作成するために不可欠な要素。
• 6つの簡単なステップでクイックリファレンスガイドを作成する方法。
• 一般的なタイプのクイックリファレンスガイド。
• クイックリファレンスガイドの推奨事項と禁止事項。

どうしてそれが重要ですか？

これらは、製品またはサービスにさまざまな機能または高度な機能がある場合に特に役立ちますが、より簡単に操作することもできます。

たとえば、数年前、私は基本的なストーブをより優れた、より高度なモデルにアップグレードしました。 古いストーブのオーブンは基本的に温度設定でオンまたはオフでしたが、私の新しいオーブンにはあらゆる種類の新機能が搭載されていました。

通常のベイク設定に加えて、対流ベイク、ロースト、パンプルーフなどがありました。 さらに、新しいものにはボタンとデジタル表示がありますが、古いものはそれをオンにして温度を設定するために回したノブでした。

さて、私は一日に一斤のパンを焼きましたが、正直に言いましょう。 オーブンを使うときは、ほとんどの場合、ピザロールを温めたり、ガーリックブレッドを焼いたりしているので、通常の焼き方を使用しています。

幸いなことに、製造元は、基本的なベーキングを行うのに役立つクイックスタートガイド（最も一般的なタイプのクイックリファレンスガイドの1つ）を提供しました。 いくつかの短いステップで、オーブンを最も基本的な機能に使用するために何をする必要があるかを正確に理解しました。

次に、より高度な機能を使用したいときに、完全な製品マニュアルをさらに深く掘り下げることができました。

クイックリファレンスガイドを使用すると、ユーザーは特定のタスクまたは一連のタスクを実行するために必要な情報をすばやく簡単に見つけることができます。 それらは完全なユーザーマニュアルに取って代わるものではありませんが、情報を提供するための素晴らしい補足的な方法を提供します。

ありがたいことに、Snagitを使用すると、クイックリファレンスガイドを非常に簡単に作成できます。

高品質のクイックリファレンスガイドをすぐに作成するために知っておく必要のあるすべてがここにあります。

クイックスタートガイドはクイックリファレンスガイドですか？

簡単な答え：はい！

上記のように、クイックスタートガイドは最も一般的なタイプのクイックリファレンスガイドの1つです。 したがって、すべてのクイックリファレンスガイドがクイックスタートガイドであるとは限りませんが、すべてのクイックスタートガイドはクイックリファレンスガイドです。

わかる？

6つの簡単なステップでクイックリファレンスガイドを作成する方法

そして、あなたが適切なツールを持っていない場合、これは物事が本当にトリッキーになる可能性がある場所です。 たとえば、すべてをMicrosoftWordドキュメントに入れようとすると時間がかかる場合があります。

また、プロのデザイナーにアクセスできない場合は、クイックリファレンスガイドの見栄えを良くするのは少し難しいかもしれません。

しかし、そのようにする必要はありません。

ちょっとした秘密をご紹介します。優れたコンテンツの設計に関しては、Snagit2020のテンプレートが私の超大国です。

ドラッグアンドドロップで簡単にハウツーガイドを作成するために使用できる、プロ並みのデザインを提供します。

Snagit 2020にはテンプレートが用意されていますが、TechSmith Assets forSnagitを使用してさらに数十をダウンロードすることもできます。

Snagitテンプレートを使用すると、さまざまな種類のハウツー、プロセスドキュメント、チュートリアルなどを作成できます。

ただし、この例では、Snagitで最も一般的な5つのツールのクイックリファレンスガイドを作成したいとします。

ステップ1.スクリーンショットを撮ります

まず、必要なすべてのスクリーンショットを撮り、グラフィックに含める注釈（矢印、テキストなど）を作成します。

ステップ2.テンプレートを作成します

次に、Snagitエディタで、[作成]> [テンプレートからイメージを作成]を選択します。

ステップ3.テンプレートを選択します

使用するテンプレートを選択します。 選択できるクイックリファレンスガイドテンプレートはたくさんあります。

この例では、基本的な5ステップのランドスケープを選択しました。 このテンプレートはステップバイステップガイドとして意図されていますが、これにも最適です。

ステップ4.画像を追加する

Snagitエディタの下部にあるトレイ（[最近の画像]トレイ）から、スクリーンショットをテンプレートのプレースホルダーにドラッグします。

ステップ5.画像のサイズを変更する

必要に応じて、スクリーンショットのサイズを変更するか、調整します。

ステップ6.書かれたコンテンツを追加する

テンプレートの右側のスペースの対応するセクションに説明を追加し、タイトルボックスにタイトルを追加します。

そして、あなたは完了です！

この小さなクイックリファレンスガイドを作成するよりも、手順を書き出すのに時間がかかりました。

その後、共有して保存したり、リンクを共有したり、印刷して机に置いたりすることができます。

一般的なタイプのクイックリファレンスガイド

クイックリファレンスガイドにはさまざまな種類があるため、作成する前に、対象者が何を必要としているかを正確に把握する必要があります。

あなたの聴衆はあなたの製品の最も基本的な機能を使い始めるための速くて簡単な方法を必要としていますか？ 次に、クイックスタートガイドを作成します。

または、ソフトウェアのUXを理解するためのワンストップリファレンスが必要なのかもしれません。 一般的な用語の用語集はどうですか？ または、製品のコア機能の概要ですか？

または、ユーザーが1つのソフトウェアからあなたのソフトウェアに移行していると想像してください。 移行を容易にするために、どのような情報が必要になる可能性がありますか？ メニューツリー、アイコン、機能名などの違いなどについて考えてください。

これらすべて（およびそれ以上）は、クイックリファレンスガイドを使用して実行できます。

しかし、明らかに、これらはすべて非常に異なるアプリケーションです。 視聴者のニーズと期待を学び、成功するために必要なコンテンツを作成します。

1. クイックスタートガイド
   ユーザーが製品をすばやく立ち上げて実行できるようにします。
2. コアまたは基本的なタスクガイド
   クイックスタートガイドに似ていますが、製品またはサービスの最も基本的な機能またはコア機能の使用方法の概要を示します。
3. より高度な機能へのガイド
   ユーザーが物事を新しいレベルに引き上げる準備ができたら、クイックリファレンスガイドを使用して、他の機能を紹介します。
4. 製品変更のガイド
   ソフトウェアは最近更新されましたか？ クイックリファレンスガイドを使用して、ユーザーに変更点を説明します。
5. ステップバイステップのハウツー
   説明する必要のあるプロセスがありますか？ それを示す！
6. 機能が制限されている製品のユーザーマニュアル
   製品に膨大なマニュアルが必要ない場合は、クイックリファレンスガイドが必要なすべてのドキュメントである可能性があります。

優れたクイックリファレンスまたはクイックスタートガイドを作成するための重要な要素

あなたの聴衆と彼らのニーズを知ってください

私が書くこれらのブログが多ければ多いほど、一貫したテーマに気付くようになります。 視聴者が望むコンテンツ（必ずしもあなたが伝えたいものではない）を作成することは、最も一貫性のあるものの1つです。

より効果的な顧客教育コンテンツを作成する方法についてのこの記事で述べたように、オンラインフォーラム、顧客調査、または独自のテクニカルサポートスタッフからさえも、それが何であるかを正確に把握する方法はいくつかあります。

入手方法に関係なく、顧客が必要としているコンテンツを配信することは、クイックリファレンス資料の成功を確実にするのに大いに役立ちます。

シンプルさが鍵

クイックリファレンスガイドの要点は、情報に簡単かつ簡単にアクセスできるようにすることです。そのため、理解しやすいものにしてください。

ビジュアルを使用する

巨大なテキストブロックはできるだけ避けてください。代わりに、マークアップ付きのスクリーンショット、アイコン、製品写真などの視覚要素と、ポイントが明確になるように十分なテキストを使用してください。

重要な情報のみを含める

1ページか2ページにしてください。 完全なユーザーマニュアルからすべてを網羅しようとしないでください。 考えてみてください。目次が必要なクイックリファレンスガイドは、おそらくそれほど迅速ではありません。

特定のタスクを実行するために最も重要な情報を選択するか、そうでなければ表示したいものを伝えます。 複雑な概念を最も基本的な形にまとめます。

何を残し、何を除外するかを知ってください。 他の重要なトピックをカバーするために、いつでも別のクイックリファレンスガイドを作成できることを忘れないでください。

シンプルでわかりやすいレイアウトを使用する

クイックリファレンスガイドが視覚的に魅力的でわかりにくい場合、ユーザーはそれが役に立たないと感じるでしょう。

優れたクイックリファレンスガイドを作成するために、総合的な芸術作品を作成する必要はありません。 矢印やテキストなどで注釈が付けられた単純なスクリーンショットで、必要な情報を誰かに提供できる場合があります。

ビジュアルコンテンツ

これを十分に強調することはできないように感じます。クイックリファレンスガイドは、優れた画像、アイコン、スクリーンショット、またはその他の視覚的要素がなければ、効果的で魅力的で有用ではありません。

画像は目を引き、コンテンツへのアンカーポイントを提供するのに役立ち、ユーザーが情報の重要なポイントをすばやく簡単に特定するのに役立ちます。

実際、私たちのValue of Visualsの調査では、人々はテキストだけの場合よりも画像とテキストの方がよく学ぶことがわかりました。

この素晴らしいインフォグラフィックを使用すると、ビジュアルコミュニケーションがいかに価値があるかをすべて学ぶことができます。

そして、あなたは絵が千の言葉に値するという用語を聞いたことがありますか？ さて、何かを示すための最良の方法は、実際にそれを表示することです。

優れた画像は、大量の情報を伝達し、コンテンツのテキスト密度を減らし、よりユーザーフレンドリーにするのに役立ちます。

Venngageの友人は、ビジュアルコンテンツの重要性についてさらに情報を持っています。

クイックリファレンスガイドのすべきこととすべきでないこと

すべてのクイックリファレンスガイドが、私が作成したものほど単純なわけではありません。 より多くのテキストが必要なものもあれば、より多くの画像が必要なものもあります。 より複雑なレイアウトが必要なものもあります。 テーマによってはもっと長くなる場合があります。

クイックリファレンスガイドにはさまざまな種類と用途があり、ここですべてを網羅することは不可能です。 しかし、かなり普遍的ないくつかの一般的なすべきこととすべきでないことがあります：

行う

1. できるだけ短くしてください。 1〜2ページが最適です。
2. 注釈付きのスクリーンショット、アイコン、製品またはUX画像などのビジュアルを使用します。
3. 必要に応じて明確な見出しと小見出しを付けて、わかりやすくわかりやすいレイアウトを使用します。
4. あなたの聴衆と彼らが何を必要としているかを知ってください。
5. 自立させてください。 ユーザーは、クイックリファレンスガイドを理解するためにマニュアルを調べる必要はありません。

しないでください

1. 情報が多すぎます。 ユーザーマニュアル全体をこの1つのガイドに収めようとしているのではありません。
2. フォントサイズを小さくして、電子顕微鏡なしでは誰も読めないようにします。
3. 不必要に情報を繰り返します。

Snagit2020ですばらしいクイックリファレンスガイドの作成を開始します

クイックリファレンスガイドは、製品またはサービスの最も一般的な機能に関する迅速で便利な手順をユーザーと顧客に提供するための優れた方法です。

スクリーンショットや画像編集からテンプレートや画像アセットまで、Snagit 2020を使用すると、便利で魅力的で視覚的に魅力的なクイックリファレンスガイドを非常に簡単に作成できます。

注：この記事は元々2020年4月に公開されましたが、新しい情報で更新されています。