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

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

クイックリファレンスガイドとは、製品の使用方法を1~2ページに凝縮して説明した文書のことです。 必要な内容に応じて、非常に詳細であったり、非常にシンプルであったりします。

ほとんどすべての製品は、顧客がその使用方法を理解できるように、ある種のドキュメントを必要とします。 製品によっては、それらのユーザー ガイドや製品マニュアルは、長いテキスト ブロックでページがいっぱいになり、何百ページにもなることもあります。

言い換えれば、特に新規ユーザーにとって、それらはかなり困難なものになります。

当然ながら、製品ができることすべてを網羅したドキュメントが必要です。 しかし、顧客は、それを見つけるために大量のコンテンツをかき分けることなく、何かを知りたいだけということもあります。

クイック リファレンス ガイドは、すぐにアクセスできる豊富な情報を、消化しやすく、魅力的な方法でユーザーに提供する完璧な方法です。

  • 優れたクイック リファレンス ガイドを作成するために不可欠な要素
  • 6つの簡単なステップでクイック リファレンス ガイドを作成する方法
  • クイック リファレンス ガイドによくあるタイプ
  • クイック リファレンス ガイドのやるべきこととやってはいけないこと
  • クイック リファレンス ガイドを作成する(無料テンプレート)

    Download

    なぜそれが重要なのですか?

    製品やサービスがさまざまな、あるいは高度な機能を持ちながら、よりシンプルに操作できる場合に特に役立ちます。

    たとえば、数年前、私はベーシックなコンロをより良い、より進んだモデルでアップグレードしました。 古いコンロのオーブンは、基本的にオンかオフで温度設定ができましたが、新しいコンロにはさまざまな新しい機能がついていました。

    通常の焼き設定だけでなく、コンベクション焼き、ロースト、ブレッドプルーフなどの設定もありました。 さらに、古いものはあなたがそれをオンにし、温度を設定するために回すだけのノブだったのに対し、新しいものは、ボタンとデジタル表示を持っています。 オーブンを使うときはたいてい、ピザロールを温めたり、ガーリックブレッドを焼いたりしているので、ほとんど通常のベイク設定を使っています。

    幸運なことに、メーカーはクイックスタートガイド(クイックリファレンス・ガイドの最も一般的なタイプの1つ)を提供してくれて、基本的なベーキングを行うのに役に立ちました。 いくつかの短いステップで、オーブンを最も基本的な機能で使うために何をすべきかがよくわかりました。

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

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

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

    ここでは、高品質のクイック リファレンス ガイドをすぐに作成するために知っておくべきすべてを説明します。 はい!

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

    Make sense? たとえば、Microsoft Word 文書にすべてを書き込もうとすると、時間がかかります。

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

    少し秘密を打ち明けますが、優れたコンテンツをデザインする場合、Snagit 2020 のテンプレートは私の大いなる力なのです。

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

    Snagit 2020 にはテンプレートが付属していますが、TechSmith Assets for Snagit でさらに数多くのテンプレートをダウンロードできます。

    Snagit テンプレートにより、さまざまな種類の HowTo、手順ドキュメント、チュートリアルなどを作成することができます。

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

    まず、必要なスクリーンショットをすべて撮り、グラフィックに含めたい注釈(矢印、テキストなど)を記入します。 テンプレートを作成する

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

    ステップ3. テンプレートを選ぶ

    使用するテンプレートを選択します。 クイックリファレンスガイドのテンプレートはたくさんあるので、その中から選びます。

    この例では、「基本的な 5 つのステップの風景」を選択しました。 このテンプレートはステップバイステップのガイドを目的としていますが、このような場合にも最適です。

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

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

    ステップ5.テンプレートに画像を追加する

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

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

    Step 6. コンテンツを追加する

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

    そして完了!

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

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

    Common types of quick-reference guides

    異なるタイプのクイック リファレンス ガイドが多数あるため、作成前にユーザーが何を必要としているかを正確に知っておきたいものです。

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

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

    これらのことすべて (そして、それ以上) は、クイック リファレンス ガイドで実現できます。

    しかし、明らかに、これらはすべて非常に異なるアプリケーションです。

    1. クイックスタートガイド
      ユーザーが製品をすぐに使い始められるようにします。
    2. コアまたは基本タスクガイド
      クイックスタートガイドに似ていますが、製品またはサービスの最も基本的またはコア機能の使用方法について概要を提供するものです。
    3. より高度な機能へのガイド
      ユーザーが新しいレベルに進む準備ができたら、他の機能や特徴を紹介するためにクイック・リファレンス・ガイドを使用します。
    4. ステップバイステップのハウツー
      説明が必要なプロセスがある場合、クイックリファレンス・ガイドを使用してユーザーに説明します。
    5. 限定的な機能や特徴を持つ製品のユーザーマニュアル
      製品が膨大なマニュアルを必要としない場合、クイックリファレンス ガイドが必要なすべてのドキュメントになるかもしれません。

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

    読者とそのニーズを知る

    このブログを書くほど、一貫したテーマがわかってきました。 オーディエンスが求めるコンテンツを作ること(必ずしも自分が伝えたいことではない)は、最も一貫したテーマの1つです。

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

    どのように入手するかにかかわらず、顧客が必要とするコンテンツを提供することは、クイック リファレンス資料の成功に大きく貢献します。

    シンプルさが重要

    クイック リファレンス ガイドのポイントは、情報に簡単かつ容易にアクセスできることなので、わかりやすくすることが重要です。

    ビジュアルを使う

    膨大なテキストブロックはできるだけ避け、マークアップされたスクリーンショット、アイコン、製品写真などのビジュアル要素を使用し、ポイントが明確になるように十分なテキストを使う

    必須情報のみを含める

    1~2ページに収める。 完全なユーザーマニュアルからすべてをカバーしようとしないでください。 考えてみてください – 目次を必要とするクイック リファレンス ガイドは、おそらくそれほど迅速ではないでしょう。

    特定のタスクを達成するために最も重要な情報、または示したいことを伝える情報を選択する。 複雑な概念を最も基本的な形に煮詰める。

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

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

    クイックリファレンスガイドが視覚的に魅力的でわかりやすくなければ、ユーザーはそれを有用と感じないでしょう。

    優れたクイック リファレンス ガイドを作成するために、完全な芸術作品を作成する必要はありません。 矢印やテキストなどで注釈されたシンプルなスクリーンショットで、誰かが必要とする情報を得るには十分な場合があります。

    ビジュアル コンテンツ

    これだけは強調したいのですが、優れた画像、アイコン、スクリーンショット、その他の視覚的要素がなければ、クイック リファレンス ガイドは効果的で魅力的、かつ有用なものにはならないのです。

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

    実際、当社の「ビジュアルの価値」の調査では、人は画像とテキストでよりよく学習し、テキストだけよりよく学習することがわかりました。

    この素晴らしいインフォグラフィックで、ビジュアル コミュニケーションがいかに貴重であるかをすべて学ぶことができます。 何かを示す最良の方法は、実際にそれを示すことであることがわかりました。

    優れた画像は、大量の情報を伝え、コンテンツのテキスト密度を下げ、よりユーザーフレンドリーにすることができます。

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

    クイック リファレンス ガイドの注意点

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

    クイック リファレンス ガイドにはさまざまな種類と用途があり、ここですべてを網羅することは不可能です。

    Do

    1. できるだけ短くすることです。 1~2ページがベストです。
    2. 注釈付きスクリーンショット、アイコン、製品またはUX画像などのビジュアルを使用することです。
    3. 必要に応じて明確な見出しや小見出しをつけ、理にかなったわかりやすいレイアウトにする。

    Don’t

    1. Cram in too much information.ユーザーは、クイックリファレンスガイドを理解するためにマニュアルを見る必要がないはずです。 ユーザーマニュアル全体をこの1冊のガイドに収めようとしているわけではありません。
    2. 電子顕微鏡がなければ誰も読むことができないほどフォントサイズを小さくする。
    3. 不必要に情報を繰り返す。

    Get started creating amazing quick-reference guides with Snagit 2020

    Quick-reference guides is a great way to provide your users and customers with fast and handy instructions for the most common features of your product or service.

    スクリーンショットや画像の編集から、テンプレートや画像アセットまで、Snagit 2020 では、便利で魅力的、かつ視覚的にも魅力的なクイック リファレンス ガイドを驚くほど簡単に作成できます

    クイック リファレンス ガイドとは何ですか?

    クイック リファレンス ガイドとは、製品の使用方法について 1、2 ページに凝縮された説明を提供するドキュメントです。

    クイックスタートガイドは、クイックリファレンスガイドの一種ですか。

    そうです。 クイックスタートガイドは、顧客やユーザーが、複雑な機能や高度な機能を知らなくても、製品やサービスをすばやく使い始められるようにするものです。

    クイックスタートガイド
    コアまたは基本タスクガイド
    より高度な機能へのガイド
    製品変更へのガイド
    段階的なハウツー
    限定機能や特徴を持つ製品のユーザーマニュアル

    優れたクイックリファレンス ガイドを作るための必須要素は何ですか。

    オーディエンスとそのニーズを知ること
    シンプルであること
    きれいでわかりやすいレイアウト/デザイン
    画像やイラストなどのビジュアルコンテンツを使用すること

  • コメントを残す

    メールアドレスが公開されることはありません。