ユーザー マニュアルの作成方法: ゼロからヒーローまで (フル ガイド)

顧客が製品からより多くの価値を引き出すのに役立つユーザーマニュアルを作成する方法がわかりませんか?

ユーザー マニュアルは、顧客 (または従業員) が製品やサービスを効果的に使用するのに役立つコンテンツです。 また、ユーザー ガイド、取扱説明書、製品マニュアルなどと呼ばれることもあります。

高品質のユーザー マニュアルを作成すると、顧客が製品を効果的に使用できるようになるだけでなく、ユーザーがサポートに連絡しなくても問題を解決できるため、顧客サービスやサポートのリクエストを減らすことができます。

この詳細なガイドでは、顧客が成功を収めるのに役立つユーザー マニュアルを作成する方法を学びます。

それを実現するために、ここで取り上げるすべてのことを以下に示します。

• 各種取扱説明書
• ユーザーマニュアルを公開する場所
• ユーザーマニュアルの作成方法

掘り下げましょう！

さまざまな種類のユーザー マニュアル

ユーザー向けマニュアルと社内向けコンテンツの両方を含む、さまざまな種類のユーザー マニュアルがあります。

開始する前に、作成するマニュアルの種類を理解することが重要です。これは、コンテンツへのアプローチ方法に影響します。

さまざまな種類のユーザー マニュアルの概要を以下に示します。

• ユーザーマニュアル– 従来のユーザーマニュアルは、ユーザーに製品の使用方法を教えます。
• トレーニング マニュアル– トレーニング マニュアルは、特定のタスクの実行方法または特定のジョブの完了方法をユーザーに教えます。
• オペレーション マニュアル– オペレーション マニュアルは通常、会社の業務を文書化する内部マニュアルです。
• サービス マニュアル– サービス マニュアルは、製品ライフ サイクルのさまざまな時点で製品を適切に保守する方法をユーザーに教えることに重点を置いています。
• 標準業務手順書 (SOP) – SOP は、特定のプロセスを「正しい方法」で適切に完了する方法を組織のメンバーに教える内部マニュアルです。

以下の手順では、主に一般向けのユーザー マニュアルの作成に関心があります。 ただし、以下の基本原則は、あらゆる種類のユーザー マニュアルに適用されます。

ユーザーマニュアルを公開する場所

ユーザー マニュアルを公開する場所は、作成するユーザー マニュアルの種類によって異なります。

顧客向けのユーザー マニュアルについては、ほとんどの場合、Web サイトに公開したいと思うでしょう。 これにより、ユーザーはどこからでもマニュアルにアクセスできます。

さらに、ユーザー マニュアルのコンテンツを Web 上に公開すると、クリック可能な目次やリアルタイムの検索候補を追加するなど、物理的なユーザー マニュアルよりもユーザー フレンドリーなエクスペリエンスを作成できます。

ただし、物理的な製品の場合は、Web ベースのマニュアルに付属する物理的なユーザー マニュアルを含めることもできます。

内部のユーザー マニュアルの場合、一般に公開されないようにする必要があります。

これを実現する 1 つの方法は、企業のイントラネットでのみ利用できるようにすることです。 ただし、非常に多くの人が自宅で仕事をしているため、会社に独自の VPN セットアップがない限り、これを行うのは難しい場合があります.

代わりに、従業員にユーザー アカウントへのログインを要求するか、ページにアクセスするためのパスワードを追加するだけで、コンテンツをパスワードで保護することを検討できます。

物理的なユーザー マニュアルの場合は、専用のナレッジ マネジメント ツールを使用して、より複雑なマニュアルを公開できます。 または、より単純なユーザー マニュアルについては、Google ドキュメントに書き込んでそこから公開することもできます。テクニカル ライティング ツールのコレクションには、作業を楽にする便利なツールがいくつか含まれています。

ユーザー マニュアルをオンラインで公開するには、ほとんどのドキュメントまたはナレッジ ベース ソフトウェアを使用できます。 公開ユーザー マニュアルと内部ユーザー マニュアルの両方を処理できるツールが必要な場合は、WordPress 用のオープンソースの Heroic Knowledge Base プラグインを検討できます。 これについては、チュートリアルで詳しく説明します。

以下は、Heroic Knowledge Base (および Heroic Knowledge Base について) のオンライン ユーザー マニュアルの例です。

チュートリアルといえば…

6つのステップでユーザーマニュアルを作成する方法

いくつかの背景情報が得られたので、ゼロから始めて完成したユーザー マニュアルに至るまで、ユーザー マニュアルを作成する方法を見てみましょう。

1. ユーザー ペルソナを作成する

コンテンツの作成を開始する前に、コンテンツの対象者を理解しておく必要があります。これは、ユーザー ペルソナを作成することで実現できます。

あなたはおそらく、顧客が誰であるかをすでによく知っていますが、これを書き留めておくと、本当に努力に集中するのに役立ちます.

何でこれが大切ですか？

さて、ここに例があります：

機械エンジニア向けの技術コンテンツを作成することと、非技術者向けの技術コンテンツを作成することには大きな違いがあります。

ほとんどの製品では、違いはそれほど大きくありません。 しかし、ユーザー マニュアルが実際に使用する人にとって意味のあるものであることを確認できるように、顧客のペルソナを理解することは依然として重要です。

2. 主な問題と目標を特定する

顧客が誰であるかを理解したら、次のステップは、作成するユーザー マニュアルで顧客が何を達成しようとしているのかを理解することです。

つまり、このマニュアルを読む人々の最終目標 (または最終目標) は何ですか?

マニュアルの目的は、ユーザーがその目標をできるだけ効率的に達成できるようにすることであるため、これを理解することは重要です。

場合によっては、この最終目標が特定のものになることがあります。 たとえば、ソーシャル メディア管理ツールをお持ちの場合、それは「ソーシャル メディアへの投稿のスケジュール」かもしれません。

また、「プロジェクト管理プロセスの改善」など、より抽象的な目標である場合もあります。

大規模な製品の場合、ユーザーが達成しようとしていることが複数ある可能性があるため、次のセクションに進みます。

3. 論理構造と階層を作成する

顧客が誰で、何を達成したいのかを理解したので、ユーザー マニュアルの構造のマッピングを開始できます。

ユーザーを「ゼロ」から、前のセクションで挙げた最終目標に到達させる構造を作成したいと考えています。

これを行うためのヒントを次に示します。

1. 顧客が製品からできるだけ早く価値を得られるようにする方法を考えてください。
2. そこからあなた自身の個人的な知識を引き出してください。 あなたは明らかにあなたの製品についてよく知っていますが、あなたの顧客はそのレベルの背景知識を持っていません.
3. 製品を使用しようとするときに顧客が遭遇する可能性のある一般的な問題や紛らわしい詳細については、必ず説明してください。 これらは、顧客が問題に遭遇する可能性が最も高い時期に論理的に対処する必要があります。

4. ユーザーマニュアルの内容を書く

コンテンツのマッピングが完了したら、執筆を開始する準備が整います。

製品/組織の規模によっては、すべてを自分で作成することもできます。 または、他のチーム メンバーと協力してコンテンツを作成する必要がある場合もあります。

ユーザー マニュアルを作成する際に考慮すべき一般的なユーザー マニュアルのベスト プラクティスを次に示します。

• テンプレートを使用して、書式の一貫性を確保します。 書式設定されたテンプレートを作成すると、作業がスピードアップするだけでなく、マニュアルの各記事が他の記事と一致するようになります。
• ユーザーに役立つビジュアル（画像と動画）を含めます。 十分に注釈が付けられた画像や GIF は、テキストがどれほど詳細で完全であっても、単独のテキストによる指示よりも役立つ場合があります。
• 平易な言葉を使用し、専門用語は避けてください。 または、専門用語がどうしても避けられない場合は、必ず説明してください。
• 短く要点を押さえてください。 ユーザー マニュアルの目標は、トピックを完全にカバーすることですが、できるだけ短い言葉で説明する必要があります。 重要な情報を省いてはいけませんが、不要なコンテンツは容赦なくカットしてください。
• 可能な場合は、説明に箇条書きとリストを使用してください。 番号付きまたは箇条書きのリストを使用すると、ユーザーがガイドを追跡しやすくなります。 または、リストに記載されている以上の詳細が必要な場合は、各ステップに独自の小見出しを作成できます。
• 能動態を使用します。 受動態は、特にユーザー マニュアルの指示を混乱させる可能性があります。 「赤いボタンを押せば電源が入る」と「赤いボタンを押せば電源が入る」の違いです。 後者の例 (能動態) はより明確であり、読み手が説明に身を置くことが容易になります。

最後に、初めてのユーザーであるかのように、ユーザー マニュアルの手順をテストすることを常にお勧めします。

つまり、記事を書き終えたら、実際に戻って、実際にそれらの手順を順を追って実行し、何も見逃していないことを確認してください。

5. ユーザーマニュアルを公開する

コンテンツを入手したら、公開するための最後のステップは、ユーザー マニュアルを公開して、顧客が簡単に利用できるようにすることです。

これを行う方法は、提供する製品のタイプによって異なります。 たとえば、物理的な製品を出荷する場合は、マニュアルの物理的なバージョンを含めることができます。

ただし、提供する製品の種類に関係なく、ユーザーが簡単に見つけられるように、ユーザー マニュアルをオンラインで公開する必要があります。

そのために、ナレッジ ベース/ドキュメント ソフトウェアを使用できます。

たとえば、Heroic Knowledge Base WordPress プラグインを使用すると、オープンソースの WordPress ソフトウェアを使用してユーザー マニュアルを公開できます。

このオープンソースのアプローチにより、プラットフォームの完全な所有権と制御が得られると同時に、顧客がユーザー マニュアルをより効果的にナビゲートするのに役立つ多くの便利なツールが提供されます。

• カテゴリの整理– ユーザー マニュアルを論理的なカテゴリに簡単に整理し、ドラッグ アンド ドロップを使用してそれらのカテゴリを並べ替えることができます。
• リアルタイムの検索候補– 顧客が特定のチュートリアルに直接ジャンプしたい場合は、検索の入力を開始するだけで、クエリに基づいたライブ検索候補を表示できます。
• 自動目次– プラグインは、ユーザー マニュアル記事ごとにクリック可能な目次を自動的に生成します。これにより、読者は関連するセクションに直接ジャンプできます。
• 簡単なコールアウト/書式設定– コールアウトやその他の書式設定を簡単に追加して、記事の重要な要素に注意を引くことができます.
• インスタント アンサー ウィジェット– サイトに専用のユーザー マニュアル ページを作成するだけでなく、検索可能なインスタント アンサー ウィジェットを追加して、訪問者がサイトのどこからでもユーザー マニュアルのコンテンツを閲覧できるようにすることもできます。

ユーザー マニュアルの発行に役立つソフトウェアのオプションをさらに知りたい場合は、最高のナレッジ ベース ソフトウェアと最高のドキュメンテーション ツールに関する投稿をご覧ください。

6. 必要に応じてユーザー マニュアルを更新および改訂する

ユーザーマニュアルの作成は一度きりの作業ではありません。 今後は、コンテンツの修正と更新に時間を割く必要があります。

ユーザー マニュアルを更新する必要がある主な理由は 2 つあります。

1. 製品に新機能を追加したか、既存の機能/インターフェースの動作を変更しました。
2. ユーザー マニュアルのコンテンツを改善して、より役立つものにしたいと考えています。

最初の状況は明らかです。何らかの方法で製品を変更した場合、それらの変更を考慮してユーザー マニュアルを更新する必要があります。

ただし、2 番目の状況も考慮に入れることが重要です。いろいろ試してみてください。すべてのユーザー マニュアル記事が最初から完璧であるとは限りません。

ユーザーをよりよく支援するために、パフォーマンスの低いマニュアル コンテンツを更新および修正して、より便利なものにする必要があります。

Heroic Knowledge Base などのツールを使用してユーザー マニュアルを公開すると、記事の有用性評価が組み込まれているため、どの記事を改善する必要があるかを簡単に確認できます。 ユーザーは、記事にテキスト フィードバックを残すこともできます。これにより、記事の特定の部分があまり役に立たないことを指摘できます。

また、ユーザーが問題を抱えているトピックの記事が欠落している可能性もあります。 これらの不足しているトピックを見つけるのに役立つように、Heroic Knowledge Base には組み込みの検索分析も含まれているため、どの検索でトピックの結果が得られないかを追跡できます (一般的な検索全体も同様です)。

ユーザーマニュアルを今すぐ作成

顧客を成功に導くには、ユーザー マニュアルの作成方法を学ぶことが重要です。

この投稿のヒントとベスト プラクティスを使用して、ユーザー マニュアルを起動して実行するために必要な知識を得ることができます。

ユーザー マニュアルをオンラインで公開し、顧客がナビゲートできるようにする簡単な方法として、WordPress と Heroic Knowledge Base プラグインを使用できます。

Heroic Knowledge Base を使用すると、記事を簡単に公開し、必要に応じて整理できます。 さらに、顧客はライブ検索の提案、自動目次などの便利な機能を利用できます。

今日から始めれば、すぐにユーザー マニュアルを公開できます。

ビジネスの内部知識を向上させるためのドキュメントの作成に興味がある場合は、スタッフ向けのトレーニング マニュアルを公開する方法に関するチュートリアルにも興味があるかもしれません。