最高のユーザードキュメントを作成する方法

製品がペーパータオルのロールよりも複雑な場合は、ユーザーがそれらの使用方法を学ぶのに役立つ何らかのユーザードキュメントを作成する可能性があります。

巧妙に作成された、ユーザーフレンドリーな製品マニュアルまたはユーザーガイドは、素晴らしいカスタマーエクスペリエンスとひどいカスタマーエクスペリエンスの違いを意味する場合があります。

さらに、ユーザードキュメントは新規ユーザーだけのものではありません。

経験豊富なお客様は、ユーザーマニュアルや製品ガイドを参照して、あまり使用していない機能の思い出を更新したり、特定の問題を解決したりすることもできます。

この投稿では、ソフトウェアなどの非物理的製品のユーザードキュメントを作成するためのベストプラクティスに主に焦点を当てますが、これらのヒントのほとんど（すべてではないにしても）はハードウェア領域にも当てはまります。

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

• ユーザードキュメントとは何か、なぜそれが重要なのか。
• エンドユーザーのドキュメントがカスタマーエクスペリエンスの一部である方法。
• 優れたユーザードキュメントがカスタマーサポートチームの負担を軽減するのにどの程度役立つか。
• ビジュアルコンテンツが最高のドキュメントの秘訣である理由。
• 最高のユーザードキュメントを保証する重要な要素。
• 顧客を喜ばせ、時の試練に耐えるドキュメントを作成するための4つのステップ。

ユーザードキュメントとは何ですか？

ユーザードキュメント（エンドユーザーマニュアル、エンドユーザーガイド、取扱説明書などとも呼ばれます）は、エンドユーザーが製品やサービスをより成功させるために提供するコンテンツです。

これらは、誰かが製品を適切に使用する方法、または物理的な製品の場合は組み立てる方法を学ぶのに役立つ、製品に付属する教材です。

IKEAの家具を組み立てたことがあれば、エンドユーザー向けのドキュメントを使用したことがあります。

ただし、ユーザードキュメントにはさまざまな形式があります。

ビデオゲームには、悪者を撃つために押すボタンを示すマニュアルが付属しています。 ソフトウェアのドキュメントには、購入で何ができるか、およびその方法が示されています。

納税申告書には、適切に記入する方法に関するガイドが付属しています。

芝刈り機と除雪機には、エンジンの始動方法と燃料の補充場所を示す製品ガイドがあります。

ユーザードキュメントの作成方法にスキップしてください

ユーザードキュメントが重要なのはなぜですか？

あなたはあなたの製品が素晴らしいことを知っています。 あなたはあなたの顧客にもそれを知ってもらいたいのです。 ユーザードキュメントは、顧客またはユーザーが製品を最大限に活用する方法を実際に学ぶのに役立ちます。

ドキュメントの保存方法、モーターの始動方法、特定のツールの使用方法、または重要な安全情報でさえ、エンドユーザーのドキュメントは顧客との関係の重要な部分です。

ユーザードキュメントは顧客を喜ばせることができます

ユーザードキュメントは簡単ですよね？ つまり、製品の使用方法についていくつか書くだけで、準備完了です。

それほど単純ではありません。

それは単なる「ハウツー」資料ではありません。 これはカスタマーエクスペリエンスの一部です。 そしてそれはそれがマーケティング資料でもあることを意味します。

私自身、消費者として、すばらしいユーザーガイドと恐ろしいユーザーガイドの両方を経験しました。 私はあなたのほとんどが同じような経験をしたに違いない。

優れたユーザーマニュアルまたは製品ガイドは、顧客が製品を購入するかどうかだけでなく、実際に製品を使用して本当に素晴らしい経験をしているかどうかを気にかけていることを顧客に示します。

あなたが彼らの財布を超えて彼らを気にかけていると感じる顧客はあなたに戻ってき続けるでしょう。

あなたが彼らにあなたの製品やサービスをどれだけ愛しているかについて世界に叫んでもらいたいのなら、素晴らしいユーザードキュメントを提供することはその購入後の経験の重要な部分です。

ユーザードキュメントがサポートチームをどのようにサポートするか

何かが機能していないときにサポートチームに連絡することがよくありますが、単に何かがわからないときに電話をかけることもあります。 優れたユーザードキュメントがあると、2つの主要な方法でサポートチームを支援します。

1.簡単なリファレンスガイドを提供します

優れたユーザードキュメントは、顧客向けである必要はありません。 製品サポートチームは、ドキュメントを使用して、顧客が助けを求めたときに、より良いサポートを提供できます。 目次や索引などの重要な部分を含めると、必要な情報をすばやく見つけることができます。 そして、それが検索可能な電子文書であれば、それはさらに良いことです！ これについては、この記事の後半で詳しく説明します。

2.通話を減らす

上記のように、人々は何かを理解できないときにサポートを呼び出すことがよくあります。 しかし、顧客が自分でそれを理解できれば、助けを必要とする可能性ははるかに低くなります。 実際、70％以上の人が、電話や電子メールを使用して支援を受けるよりも、会社のWebサイトを使用して支援を受けることを好みます。

最高のドキュメントでさえ、これらの呼び出しのすべてを排除するわけではありませんが、明確で包括的で簡潔なユーザーガイドとマニュアルを作成することは、サポートリクエストの全体的な量を減らすのに大いに役立ちます。

優れたユーザードキュメントの重要な要素は何ですか？

各製品は固有であり、真に優れたユーザードキュメントを作成するにはさまざまな要素が必要ですが、何があっても従うべきエンドユーザードキュメントのベストプラクティスがいくつかあります。

優れたユーザードキュメントには、次のものが含まれている必要があります。

• 分かりやすい言葉
• シンプルさ
• ビジュアル
• 問題に焦点を当てる
• 論理的な階層とフロー
• 目次
• 検索可能なコンテンツ
• アクセシブルなコンテンツ
• 良いデザイン
• 実際のユーザーからのフィードバック
• その他のリソースへのリンク

分かりやすい言葉

理解できないことを読むことほど、顧客を苛立たせることはありません。 誰も愚かさを感じたくないので、顧客にそのように感じさせる言葉は確かに素晴らしい体験を育む方法ではありません。

顧客が最も複雑な概念でさえ理解できるように、可能な限りシンプルでわかりやすい言葉を使用してください。

開発者ではなく、ユーザーのために書くことを忘れないでください。

当たり前のように聞こえますが、知っている製品やサービスについて平易な言葉で書くのは、想像以上に難しいことです。 あなたは、顧客がおそらく知らないあらゆる種類の専門用語、頭字語、およびその他の「インサイダー」情報を知っています。 あなたがそれを使うのは自然なことです。

しかし、それはあなたがいくつかの深刻な問題に遭遇する可能性がある場所です。

あなたの顧客があなたの製品について何も知っていると思い込まないでください。 あなたがオフィス内で毎日使用する可能性のあるすべての技術的および/または業界の流行語を彼らが知っていると思い込まないでください。

彼らが子供であるかのように書くのではなく、彼らが本当に彼らをスピードアップさせるために追加の助けが必要かもしれないことを理解してください。 読みやすい方法でドキュメントを作成します。

シンプルさ

目標を達成するために、ドキュメントはできるだけシンプルにしてください。 これは、ドキュメントのコンテンツとデザインの両方に適用されます。 書かれたコンテンツやグラフィックコンテンツがぎっしり詰まったテキストやページの長いブロックは、ユーザーガイドやマニュアルを威圧的で不親切に感じさせる可能性があります。

ユーザー資料に脅迫されている顧客は、自分で質問を解決しようとするよりも、サポートチームに助けを求める可能性がはるかに高くなります。 さらに、彼らは優れた顧客体験をする可能性がはるかに低くなります。

ビジュアル

最高のユーザードキュメントは、「語るのではなく見せる」というフレーズを完全に示しています。

画像、注釈付きのスクリーンショット、グラフィック、ビデオなどのビジュアルコンテンツは、製品がどのように機能するかをすばやく誰かに示します。 彼らはそれについて読む必要はありません：彼らはそれを見ることができます！

TechSmithの最近の調査によると、視覚的またはビデオコンテンツで指示が提供されると、人々は実際に視覚情報をより速く吸収し、タスクをより適切に実行します。

ビジュアルコンテンツは、テキストの長いブロックを分割するのにも役立ち、多くのユーザーガイドやマニュアルを威圧的で不快に感じるテキストの多くを排除するのに役立ちます。

ユーザードキュメントにビジュアルコンテンツを含める一般的な方法には、スクリーンショット、画面記録、チュートリアルビデオなどがあります。

簡略化されたグラフィックについて聞いたことがありますか？ 簡略化されたユーザーインターフェイス（またはSUI）と呼ばれることもある簡略化されたグラフィックは、ユーザーインターフェイスまたは他のグラフィックの画像を取得し、その名前が示すように、それらを簡略化します。 このより基本的なバージョンは、最も重要な情報を強調すると同時に、より単純な形状にとって重要ではないテキストとグラフィックスを削減します。

したがって、次のようになります。

今は次のようになります：

[モバイルデバイスの接続]メニュー項目を選択する方法を誰かに見せようとした場合、2番目の画像はすべての雑然としたものを取り除き、顧客の目が必要な場所に焦点を合わせることができるようにします。

G Suite Learning Centerの次のように、簡略化されたグラフィックスに既に遭遇し、それを認識していなかった可能性があります。

そこにはたくさんのツールがありますが、スクリーンショットや画面記録を作成するための強力で簡単な方法を探している場合は、Snagitの無料試用版をダウンロードすることを強くお勧めします。

解決すべき問題に焦点を当てる

すべての製品が問題を解決します。 しかし、あまりにも多くの場合、私たちはクールな製品機能をとても気に入っているので、私たちがやりたいのは、顧客がそれを必要とする理由ではなく、それができることを強調することだけです。

製品でタスクを実行する方法をユーザーに必ず示してください。

当然、これには製品の機能が含まれますが、特定の問題を解決するために、ユーザーが最初に製品を購入した理由を理解するのに役立つという文脈でそれらを強調します。

たとえば、CamtasiaとSnagitのチュートリアル（はい、チュートリアルビデオはドキュメントの形式にすることができます）は特定の機能を強調していますが、誰かがその特定の機能を使用する理由のコンテキストでそうしています。 方法だけでなく、理由についてです。

これが素晴らしい例です…

論理階層とフロー

優れたドキュメントには、各セクションに何が表示されるかをユーザーに知らせる見出しと小見出しの階層が必要です。 そして、その階層は、ユーザーが最も役立つ方法で製品を使用する方法を学ぶのに役立つ論理的な流れに従う必要があります。

たとえば、製品の動作の基本を最初に示さずに、より高度な機能の使用方法を顧客に示すことからドキュメントを始めたくない場合があります。 最初に簡単なものから始めて、ユーザーが知識を構築しながら、高度な機能を示します。

目次

目次は、質問や問題の解決策をすばやく見つけるための、シンプルで効率的で使い慣れた方法を顧客に提供します。 ドキュメントの冒頭にあるので、探しているものを見つけるためにテキストのページをふるいにかける必要はありません。 上記のように、すべての主要な見出しと小見出しを含める必要があります。

検索可能にする

ほとんどのユーザードキュメントが印刷された時期がありました。 今では、ほぼすべての人がスマートフォンにアクセスできる時代では、電子文書を作成する方が理にかなっています。 これは、印刷版も作成できないという意味ではありませんが、電子版には、以下で詳しく説明する多くの利点があります。

目次のように、検索可能なコンテンツを使用すると、ユーザーはコンテンツに簡単にアクセスでき、自分で解決策を見つけることができます。

アクセシビリティ

アクセシブルなコンテンツを作成します。 これは、視覚障害または視覚障害、聴覚障害または難聴、または認知障害のある人のアクセシビリティの基準に電子文書が準拠していることを確認することを意味します。

多くの顧客は、ユーザードキュメントを理解して完全にアクセスするために、これを必要としていることを忘れないでください。 それらを置き去りにしないでください！

良いデザイン

ユーザーが見たいドキュメントを提供すると、ユーザーはそれを使用する可能性が高くなります。

顧客を念頭に置いて材料を設計します。 使いやすくフレンドリーにします。 コンテンツが多すぎるテキストやページの長い段落は避けてください。 単調さを解消し、新製品を学ぶ可能性をそれほど難しくしないようにするために、空白を考慮に入れてください。

製品の使用方法を顧客に伝えるのではなく、できるだけ多くのグラフィックや画像を含めて表示します。 電子ドキュメントの場合は、ビデオとGIFを使用してください。

複数のドキュメントで一貫したフォントと補色を使用します。 組織にスタイルガイドがある場合（まだ存在しない場合は作成することを強くお勧めします）、ドキュメントがそれに準拠していることを確認してください。

Snagitテンプレートを使用すると、一連のスクリーンショットやその他の画像からプロ並みのユーザードキュメントを非常に簡単に作成できます。 必要な画像を収集し、[作成]、[テンプレートからの画像]の順に選択するだけで、準備が整います。

Snagitには、専門的に設計された無料のテンプレートが多数付属しています。TechSmithAssetsfor Snagitを使用すると、さらに多くのテンプレートにアクセスできます。

実際のユーザーやベータテスターからのフィードバック

組織外で実際に製品を使用している人々の話を聞くまで、本当に優れたユーザードキュメントを作成することはできません。

彼らの問題点を学び、できる限りそれらに対処するようにしてください。 あなたの製品を最もよく使うために知る必要があると彼らが言っていることを見つけてください。 当たり前のように思えるかもしれませんが、私はあなたが考えもしなかったことを学ぶことを保証します。

他のドキュメントへのリンク

あなたの顧客があなたの製品で成功する方法に関するあなたの組織のより多くのリソースにアクセスできることを確認してください。 電子ユーザードキュメントの場合、これはチュートリアル、FAQ、ユーザーフォーラムなどへのリンクを提供するのと同じくらい簡単です。

ただし、印刷されたドキュメントでさえ、さらにサポートするためにWebサイトのアドレスや電話番号などを含めることができます。

ボーナス！ ステップバイステップの説明を追加する

ステップバイステップガイドは、テキストの長いブロックを回避するのに役立ち、テキストだけで説明しようとするよりも、プロセスを示すためのはるかに明確な方法を提供します。 単にタスクを完了する方法を誰かに教えるよりも、フォローしやすく、理解しやすく、はるかにユーザーフレンドリーなエクスペリエンスを提供します。

また、ステップバイステップの説明にビジュアルコンテンツを含めると、さらに改善されることを忘れないでください。

Snagitは、優れたステップバイステップのドキュメントを作成するのに役立つ使いやすいステップツールを提供します。 さらに、画像の結合ツールを使用すると、個々のスクリーンショットやその他の画像を1つの画像に結合して、編集やマークアップを簡単に行うことができます。

優れたユーザードキュメントを作成する方法

ステップ1：計画する

すべての優れたユーザードキュメントのセットは、計画から始まります。 行きたい場所に行くためのヒントをいくつか紹介します。

どこから始めればよいか

多くの人は、製品を知っていれば、ドキュメントの作成を開始できると考えています。 しかし、それに入るものはもっとたくさんあります。 代わりに、実際にユーザーを支援していることを確認するための計画から始めてください。

ドキュメントを作成する前に、考慮すべきことがいくつかあります。

• 何を含めるべきですか？ 何を省くべきですか？ （ヒント：これは、ユーザーのフィードバックが本当に役立つ場合があります！）
• どのような順序で情報を提示する必要がありますか？ （学校からのエッセイの概要を覚えていますか？ 'emを使用してください！）
• 他にどのようなリソースが利用可能になりますか？ それらへのアクセス/リンクをどのように提供しますか？
• ドキュメントの作成は誰が担当しますか？ ドキュメントに関するフィードバックの責任者は誰ですか？ 最終的な承認は誰にありますか？
• これは翻訳またはローカライズする必要がありますか？

これらの質問への回答は、ドキュメントの作成方法を形作ります。 計画により、スムーズなプロセスとより優れたユーザードキュメントが保証されます。

あなたの製品を知っている

あなたがあなたの製品を知っていることを確認してください。

それはあなたがすべてにおいて絶対的な専門家である必要があるという意味ではありませんが、ユーザーマニュアルまたはユーザーガイドを作成する人は誰でも製品を実際に体験する必要があります。

より深い知識については、対象分野の専門家に頼ってください。ただし、他の人に教える前に、自分でそれを使用する方法を知っておく必要があります。

フォーマットを選択してください

さらに、ドキュメントの最終的な形式も同様に重要です。 印刷のみですか？ それは電子的でしょうか？ もしそうなら、それはどこに住むのでしょうか？

ほとんどすべてのユーザードキュメントが印刷物のみであったのはそれほど昔のことではありません。 ただし、非常に正当な理由がない限り、少なくとも電子版をWebサイトで入手できるようにすることをお勧めします。

ほとんどのユーザーは、スマートフォン、コンピューター、またはタブレットに24時間アクセスでき、知りたいことを知りたいときはいつでも見つけることに慣れています。 ユーザーリソースをオンラインにすると、どこにいてもアクセスできるようになります。つまり、引き出しやファイルキャビネットを検索して、何年も見たことのないユーザーマニュアルを探す必要がなくなります。

また、障害を持つ人々が電子文書にアクセスできるようにする方が簡単です。 印刷専用バージョンはほとんどの人に有効ですが、目の不自由なユーザーや視覚障害のあるユーザー向けに点字バージョンを作成する準備はできていますか？ 手で物を操作することが難しい身体障害のあるユーザーはどうでしょうか。

すべての人が電子文書にアクセスしやすくするためのツールが存在しますが、印刷のみのバージョンでは、はるかに難しいアクセシビリティの問題が発生します。

さらに、電子文書はWeb上に存在するため、更新がはるかに簡単です。

ドキュメントをPDFにする必要がありますか？

ドキュメントのダウンロード可能なPDFバージョンを提供したい場合は、それで問題ありません。 ただし、PDF以外の形式でもWebサイトで利用できることを確認してください。

ステップ2：ユーザードキュメントを作成する

すべての質問に答え、上記のすべての決定を行ったら、ユーザードキュメントを作成します。 特定の製品のドキュメントを正確に作成する方法を説明するつもりはありませんが、覚えておくべき重要なことがいくつかあります。

• どうしても必要な場合を除いて、専門用語や高度な専門用語は避けてください（そして、必ずそれらを定義してください）。
• 頭字語の意味を説明しない限り、頭字語は避けてください。
• 可能な限り、APやシカゴなどの一般的に認識されている文体を使用してください。 組織に会社スタイルガイドがある場合は、それを使用してください。
• ユーザーがあなたの製品やその機能について何も知っていると思い込まないでください。 成功するために知っておくべきことを彼らに示してください。
• 平易な言葉を使うことを忘れないでください。 8年生以下のレベルで書いてください。 上級の読者でも、単純な言語はより速い処理とより良い理解につながります。
• デザインは、心地よく、威圧的でなく、ユーザーを引き付ける必要があります。ユーザーがドキュメントを使用したくなるようにします。

ステップ3：テストする

ユーザーガイドは、顧客が製品を最大限に活用するのに役立つ場合にのみ優れています。 そして、誰かがそれを使用するまで、あなたはそれを知ることができません。 新しい作品が世に出る前に、それをテストしたいと思います。 ここにいくつかのヒントがあります！

• ベストプラクティス：実際のユーザーまたはベータテスターのグループにそれを渡して、それらがどのように機能するかを確認します。 完成したドキュメントにフィードバックを組み込みます。
• ベータテストのユーザーフィードバックがない場合は、社内でテストしてください。できれば、製品にあまり詳しくない従業員を使用してテストしてください。
• 開発者やエンジニアからフィードバックをもらいましょう。 彼らは誰よりも製品をよく知っており、あなたが見逃したかもしれないことを指摘することができます。

ステップ4：ドキュメントを最新の状態に保つ

製品が変更された場合は、ユーザードキュメントを最新の状態に保つ必要があります。 上記のように、これは電子文書に印刷よりも大きな利点をもたらします。 ただし、印刷のみのドキュメントでも更新して、Webサイトからダウンロードできるようにすることができます。

あなたのコンテンツはそれが正確である場合にのみ素晴らしいことを忘れないでください。 あなたがあなたの顧客に与えるものが実際に彼らがあなたの製品を使うのを助けることを確認してください。

概要

他に何も覚えていない場合は、優れたユーザードキュメントを、ユーザーにとって最も役立つ方法で作成、設計、および提示する必要があることに注意してください。

彼らを喜ばせ続け、あなたが望むような顧客体験を提供するドキュメントを彼らに提供してください。

ドキュメントをアクセスしやすく、便利で、視覚的にします。

よくある質問