2023年のユーザーガイドの作り方

簡単なステップバイステップガイド

あなたはついに、素晴らしい製品についての新しいユーザーガイドを書くことに決めました。

2021年になると、ユーザーガイドの作成はまだほとんど手作業だということに気づきます。あなたは、ユーザーガイドを作成するための次善のアプリを入手し、コンテンツをまとめ始める。

では、どうやって始めるのか、なぜ始めるのか、なぜユーザーガイドが必要なのか（呆...）。今回は、ユーザーガイド作成に関するよくある質問にお答えするとともに、Docsieで初めてのユーザーガイドを作成する際のガイドをしようと思います。

ユーザーガイドを作成する理由と利点

ユーザーガイドを作成する理由はたくさんあります。ユーザーガイドは、消費者、電子機器、ソフトウェアプログラム、有形・無形を問わずあらゆる製品の世界において非常に有用であり、重要な役割を果たしています。ユーザーガイドは、製品の使い方や組み立て方を、ステップ・バイ・ステップで簡単に説明します。

あなたの顧客は、あなたが販売している製品、あなたが提供しているサービス、または彼らが従わなければならない方法や手順について教育される必要があります。ユーザーガイドは、顧客が使い方を学び、製品のさまざまな特徴や機能を理解するためのステップ・バイ・ステップのプロセスを提供します。

適切なユーザーガイドを作成することで、製品の法的責任を制限することができます：

ユーザーガイドは、製品の誤った使用による法的責任も制限します。ユーザーガイドは、製品の使用や組み立てが適切でなかった結果、怪我をしたり死亡したりする可能性のある製品に非常に便利です。例えば、高電圧機器、火災を発生させる機器、さらにはレーザーなどでは、不適切な使用から顧客を守るために広範なマニュアルが必要です。

優れたユーザーガイドの作成は、時間の節約になります：

良質なユーザー・マニュアルは、製品の使用方法に関する指示を共有し、技術チームが説明する時間や営業チームがデモを行う時間を大幅に節約することができます。複雑なソフトウェア製品の多くは、顧客が製品の可能性を最大限に引き出す使い方を習得できるよう、優れたテクニカルユーザーガイドを必要としています。ソフトウェアには多くの機能が搭載されていますが、適切な量のユーザーガイドを用意することで、顧客に有用な情報を提供することができます。

製品の使用方法について顧客を教育する：

技術的な製品について顧客を教育することは非常に重要です。適切なユーザーガイドがなければ、顧客は隠された機能の嵐に混乱し、技術的な製品の可能性をフルに活用する方法がわからなくなる可能性があります。ユーザーガイドがあれば、顧客が製品の様々な技術的側面について簡単に学ぶことができ、製品を深く掘り下げる必要があるときにユーザーガイドがあれば安心です。正式な文書によるガイダンスなしに物事を理解しようとするストレスから解放されます。また、危険な使い方をする製品については、ユーザーガイドで危険な使い方をしないように警告することができます。

優れたユーザーガイドとは

ですから、ユーザーガイドを作り始めるには、特定の顧客に対してどのような問題を解決する手助けをしようとしているのかを理解する必要があります。何でもかんでもユーザーガイドを作ると、ターゲットとなるユーザーを含めて誰も理解できない、理解不能なゴチャゴチャしたものになってしまいます。Stripe](https://stripe.com/docs/payments?payments=popular)やSlackのようなスーパースター企業によって書かれた、オンライン上のユーザーガイドの最良の例を見てみましょう。特定のパターンに気づくだろう。

それぞれのユーザーガイドは、特定の問題の解決に焦点を当てている。

では、それぞれのガイドは何をすべきなのでしょうか？それは、ユーザーがこのガイドに従っている間に達成できる簡単な行動に焦点を当てるべきです。複雑にする必要はありません。逆に、ユーザーがあなたの製品に関する一般的で単純な問題を解決するのに役立つ、一般的で単純なアクションに焦点を当てれば、あなたの顧客が気に入るような素晴らしいユーザーガイドのセットを持つことになるでしょう。

それでは、素晴らしいユーザーガイドの構造を理解するために、いくつかのユーザーガイドをよく見てみましょう。

では、優れたユーザーガイドには何が必要なのか？

上記の「ブックガイドの管理」を見て、いくつかのポイントを考えてみましょう。

ユーザーガイドの整理

ユーザーガイドの作成にDocsieを使う

Docsieには、素晴らしいユーザーガイドを作成するための様々なツールや機能があります。まず、Docsieがどのように動作するのか見てみましょう。Docsieは、本と棚とコレクションを前提に動作します。

コレクションは、異なるタイプの顧客を表示したい様々なブックを分離するために使用されます。例えば、このコレクションはビジネスユーザーのみを表示するために使用されます。これは、これらの特定の顧客を表示するために作成されたすべてのブックから3つのブックだけを選択したことを意味します。

この機能は、様々なタイプの顧客がいて、その顧客が異なる製品を使用している場合に便利です。これは、Docsie上で "All "の横にある3つの点をクリックし、追加を押すことでシームレスに行うことができます。

Docsiesコレクションツールバーでコレクションの名前を作成し、どのユーザーガイドをこのコレクションに含めるかを選択できます。なぜこれが重要かというと、顧客によって、あなたの製品の異なるユーザーガイドを知る必要がある場合があり、このツールは、彼らが見る必要がある特定のユーザーガイドのみを表示することができます。

それでは、Docsieを使って最初のユーザーガイドを書き始めましょう。

ブックはユーザーガイドまたはマニュアルだと思ってください。開いたブックの中にエディターがあり、「記事」と「ヘッダー」を作成する場所があります。

上部にエディター、左上に様々なバージョンと言語を作成する機能、そしてもちろん「記事と小見出しのセクションが左にある」。

エディターの使い方は簡単で、動画、写真、コードをドラッグ＆ドロップで追加できます。 また、あなたが合うようにあなたのコンテクツをスタイライズすることができます。

記事の作成はとても簡単で、タイトルを入力するだけです。この例では、「Docsieとは」というタイトルになっていますが、ユーザーガイドのタイトルは自由に入力することができます。

1.1,1.2...extのように表示されるサブセクションをユーザーガイドに作成するには、テキストの場所を選択し、テキストを「ヘッダー」に設定します。

Docsieでは、様々なバージョンや言語のユーザーガイドを作成することもできます。これは、ローカライゼーションや、製品のユーザーガイドの様々な変更について説明するのに非常に便利で重宝します。

ユーザーガイドを準備し、それを書き出し、製品や機能のさまざまな側面を説明するのに役立つ写真でスタイル化したら、次のステップは公開することです。

要約すると、ユーザーガイドを作成するためのヒントとコツは次のとおりです。

ほとんどのソフトウェアや技術製品は、非常に複雑で多面的です。複雑な製品のユーザーガイドを作成する際にこの問題に対処するためには、情報や指示をより小さな部分に分割するのがよいでしょう。基本的には、さまざまな小さなユーザーガイドを作成し、それらをユーザーガイド・マニュアルにまとめます。

あなたの顧客は、あなたの製品やサービスに精通していません。あなたの製品が専門的であればあるほど、ユーザーガイドは作成段階でより説明的であるべきです。曖昧な言葉や言い回しは、このプロセスではあなたの味方にはなりません。できるだけ具体的に説明することで、顧客はあなたの製品のより詳細な部分を理解することができます。

百聞は一見に如かず。これは、特にユーザーガイドやマニュアルにおいて言えることです。このステップは、ほとんどの企業で非常に軽視されていますが、ユーザーガイドで説明しながら、製品の特徴や側面を適切な写真やスナップショットにすることは非常に重要です。そうすることで、顧客はあなたが製品のどの部分に言及しているのかを理解することができます。

ユーザーガイドは、顧客が製品のさまざまな使い方を理解できるようにするためのものです。できるだけシンプルに説明し、さまざまな機能や側面を簡単に理解してもらえるようにしましょう。