2021年版ユーザーガイドの作り方

Avatar of Author
Tal F
on May 04, 2021 · · filed under 製品ドキュメント プロダクトマネジメント ドキュメンテーションポータル 製品アップデート ベストプラクティス
シンプルなステップバイステップガイド

そこで、あなたはついに、素晴らしい製品に関する新しいユーザーガイドを書くことにしました。

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

では、どのように始めるのか、なぜ始めるのか、なぜユーザーガイドが必要なのか(くどいですが...)?今回は、ユーザーガイド作成に関するよくある質問にお答えするとともに、Docsieで初めてのユーザーガイドを作成する際のガイドを試みますが、文字通り他のどのツールでも構いません...

ユーザーガイドを作成する理由とメリット

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_iZzj1WY3nNoP7oCen/boo_occBcYZBFuyefSBLr/61ddfa77-6229-1511-c6b1-c77b1d40b8069.png)

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

顧客は、販売する製品、提供するサービス、あるいは従うべき方法と手順について教育される必要があります。そのため、製品の特徴や機能について、お客様が使い方を学んだり、教育したりするためのステップバイステップのプロセスを提供します。

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

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

優れたユーザーガイドを作成することで時間を節約できる:

良質なユーザーマニュアルは、製品の使い方を説明するものであり、技術チームが説明する時間や営業チームがデモを行う時間を大幅に短縮することができます。複雑なソフトウェア製品の多くは、顧客が製品の可能性を最大限に引き出す使い方を学ぶために、優れた技術的なユーザーガイドを必要としています。ソフトウェアには多くの機能が搭載されていますが、適切な量のユーザーガイドを用意することで、顧客に有用な情報を提供することができ、長期的には顧客の維持に役立ち、ソフトウェアや複雑な製品のさまざまな側面について説明する時間を節約することができます。

製品の用途をお客様に伝えること:

技術製品についてお客様を教育することは非常に重要です。適切なユーザーガイドがなければ、顧客は隠された機能の数々に混乱し、技術的な製品の可能性を最大限に活用する方法がわからなくなる可能性があります。ユーザーガイドは、お客様が製品の様々な技術的な側面を理解するための簡単なプロセスを提供し、製品をより深く理解する必要があるときに、ユーザーガイドを手元に置くことで安心感を与えることができます。また、ユーザーガイドがあれば、製品をより深く理解することができます。また、危険な製品の場合、ユーザーガイドは、製品を危険な方法で使用しないように警告を与えることができます。

優れたユーザーガイドを作るには

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_jripxf4mYymO4f3xy/boo_occBcYZBFuyefSBLr/fe45270c-c55d-dab5-f45c-363cc455ecb821.png)

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

各ユーザーガイドは、特定の問題の解決に焦点を当てています。

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

そこで、いくつかのユーザーガイドをよく見て、素晴らしいユーザーガイドの構造とは何かを理解し、それを参考に自分たちも素晴らしいユーザーガイドを書くことができるようにしましょう。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_R5PJ3qo7jkogbCKR3/boo_occBcYZBFuyefSBLr/ce19c948-7756-658f-003e-05a17c916e7cimage.png)

では、優れたユーザーガイドを作るにはどうしたらいいのでしょうか。

上記のManaging Bookのガイドを見ながら、いくつかのポイントを考えてみましょう。

ユーザーガイドを整理する

ユーザーガイドを作成するためのDocsieの使用

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

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_8ASkXMSmGFUkhL3h8/boo_occBcYZBFuyefSBLr/e263c093-0b3e-b83b-bd9a-38f6cc305cb21.png)

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

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_4hX2usZ2Cfu8kxDGT/boo_occBcYZBFuyefSBLr/b69ec337-f114-7421-8222-ba3bf6c336e12.png)

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

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_YGY3TUq04j0YUkBjB/boo_occBcYZBFuyefSBLr/c155b6fa-ad22-b5ca-1e6e-3df6b2293e7c3.png)

Docsiesコレクションツールバーでは、コレクションの名前を作成し、このコレクションに掲載するユーザーガイドを選択することができます。この機能が重要な理由は、顧客によって異なる製品のユーザーガイドを知る必要があるため、このツールを使って、顧客が見る必要のある特定のユーザーガイドだけを表示することができるからです。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_4ez4W22Q45oCMqyi6/boo_occBcYZBFuyefSBLr/dfc1562f-cbad-ea86-a55a-cc371063c2634.png)

では、Docsieを使って最初のユーザーガイドを書き始めましょう。これはDocsieの "Book "で行います。

書籍はユーザーガイドまたはマニュアルとお考えください。開いた本の中には、「記事」や「ヘッダー」を作成する場所である「エディター」が表示されます。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_6H3Y1e38RtMPPxwXp/boo_occBcYZBFuyefSBLr/ec59b894-5433-d849-0493-cd836dbe797a5.png)

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

エディターは使いやすく、動画や写真、コードをドラッグ&ドロップで簡単に追加することができます。 また、コンテンツは自由にカスタマイズすることができます。

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

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_w2Fo0BuxXtGjFQuzx/boo_occBcYZBFuyefSBLr/42e5df8b-db8e-ec6a-6a70-dc0420c427376.png)

ユーザーガイドに1.1、1.2...といったサブセクションを作成するには、テキストの位置を選択し、テキストを「ヘッダー」に設定する必要があります。この設定は、エディタータブの「H」をクリックして行います。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_OCwuils7ezubiAv8a/boo_occBcYZBFuyefSBLr/1dd88460-f856-79c7-96a9-e43c31fd5f217.png)

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

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_ULxUK3nJlSUujhpeo/file_vJFG764JBiJeDM4fU/boo_occBcYZBFuyefSBLr/a160f3ac-da2e-37bc-7133-a0172707c2828.png)

ユーザーガイドを作成し、書き出し、製品のさまざまな側面や機能を説明するのに役立つ写真を添えてスタイル化したら、次のステップは出版です。

まとめとして、ユーザーガイド作成のコツとポイントを紹介します。

ソフトウェアや技術製品の多くは、非常に複雑で多面的なものです。このような複雑な製品のユーザーガイドを作成する場合、情報や指示をより小さなパーツに分割することが有効です。基本的には、さまざまな小さなユーザーガイドを作成し、ユーザーガイドのマニュアルを設定するためにコンパイルします。

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

写真は千の言葉よりも価値がある。これは、特にユーザーガイドとマニュアルの場合に当てはまります。このステップはほとんどの企業で非常に軽視されていますが、製品の特徴や側面を適切な写真やスナップショットで撮影し、ユーザーガイドで説明することは非常に重要です。そうすることで、顧客はあなたが製品のどの部分について言及しているのか理解することができます。

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


Subscribe to the newsletter

Stay up to date with our latest news and products