シンプルなステップバイステップガイド¶

2021年に気づくことは、ユーザーガイドの作成は今でも主に手作業のプロセスだということです。最適なアプリを選んでユーザーガイドを作成し、コンテンツを組み立て始めます。

では、どのように始めるのか、なぜ始めるのか、そもそもなぜユーザーガイドが必要なのか（当然ですが...）？この記事では、ユーザーガイド作成に関するよくある質問に答えるとともに、Docsieで最初のユーザーガイドを作成するためのガイドを提供します。もちろん、他のツールを使用することもできます。

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

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

お客様は、あなたが販売している製品、提供しているサービス、または従うべき方法や手順について教育を受ける必要があります。ユーザーガイドは、お客様が製品のさまざまな機能や特徴について学び、使い方を理解できるようにするステップバイステップのプロセスを提供します。

適切なユーザーガイドは製品の法的責任を制限します：¶

ユーザーガイドは、製品の誤使用に対する責任も制限します。製品を適切に使用または組み立てなかった結果、怪我や死亡の可能性がある製品には、ユーザーガイドが非常に便利です。例えば、高電圧デバイス、火気を発生させるデバイス、さらにはレーザーなどは、不適切な使用からお客様を保護するための詳細なマニュアルが必要です。

良質なユーザーガイドは時間を節約します：¶

質の高いユーザーマニュアルは製品の使用方法を共有することで、技術チームが説明したり営業チームがデモを行ったりする時間を大幅に節約できます。複雑なソフトウェア製品は、お客様が製品を最大限に活用する方法を学ぶのを助けるための優れた技術ユーザーガイドが必要です。ソフトウェアは通常、多くの機能で溢れているため、適切な量のユーザーガイドを用意して顧客に役立つ情報を提供することは、長期的には顧客維持や、ソフトウェアや複雑な製品のさまざまな側面の使用方法の説明に費やす時間の節約に役立ちます。

お客様に製品の使用法を教育する：¶

技術的な製品についてお客様を教育することは非常に重要です。適切なユーザーガイドがなければ、お客様は隠れた機能の洪水に混乱し、技術的な製品の潜在能力を最大限に活用する方法を知らないかもしれません。ユーザーガイドがあれば、お客様は製品のさまざまな技術的側面に取り組む方法を簡単に学ぶことができ、製品をより深く理解する必要があるときにユーザーガイドが手元にあることで安心できます。これにより、正式な書面によるガイダンスなしに物事を理解しようとするストレスが軽減されます。また、使用が危険な製品の場合、ユーザーガイドは危険な方法で製品を誤用することに対する警告を提供できます。

優れたユーザーガイドの条件¶

ユーザーガイドを作成し始めるには、特定のお客様に対してどのような問題解決を支援しようとしているのかを理解する必要があります。すべてについてのユーザーガイドを作成すると、対象読者を含め誰も理解できない混乱した状態になってしまいます。StripeやSlackのようなスター企業が書いたオンラインの優れたユーザーガイドの例を見ると、特定のパターンに気づくでしょう。

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

では、各ガイドは何をすべきでしょうか？このガイドに従うことでユーザーが達成できる簡単なアクションに焦点を当てるべきです。複雑にする必要はありません。反対に、製品に関するお客様の一般的な簡単な問題解決を支援する一般的な簡単なアクションに焦点を当てれば、お客様が喜ぶ素晴らしいユーザーガイドのセットが出来上がります。

優れたユーザーガイドの構造を理解するために、いくつかのユーザーガイドを詳しく見て、自分たち自身で素晴らしいユーザーガイドを書く方法の参考にしましょう。

優れたユーザーガイドに含まれる要素は？¶

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

ユーザーガイドの整理¶

Docsieを使用してユーザーガイドを作成する

Docsieには素晴らしいユーザーガイドを作成できるさまざまなツールや機能があります。まず、Docsieの仕組みを見てみましょう。Docsieは本、棚、コレクションという考え方で動作します。

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

これは、製品の異なる階層を使用しているさまざまなタイプの顧客がいる場合に役立ちます。Docsieでは「All」の横にある3つのドットをクリックして「add」を押すだけでシームレスに行えます。

Docsieのコレクションツールバーに移動すると、コレクションの名前を作成し、この特定のコレクションに含めたいユーザーガイドを選択することができます。これが重要な理由は、異なる顧客が製品の異なるユーザーガイドを知る必要があるかもしれないからです。このツールを使用すると、彼らが見る必要がある特定のユーザーガイドのみを表示することができます。

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

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

上部にエディタ、左上隅にさまざまなバージョンと言語を作成する機能、そして左側に「記事」と見出しセクションがあります。

エディタは使いやすく、シンプルなドラッグアンドドロップ処理でビデオ、写真、コードを追加できます。また、必要に応じてコンテンツのスタイルを設定することもできます。

記事の作成は非常に簡単です。タイトルを入力するだけです。この場合、タイプは「What is Docsie」ですが、ユーザーガイドのタイトルとして望むものを入力できます。

ユーザーガイドにサブセクションを作成して1.1、1.2...などとして表示するには、テキストの位置を選択し、エディタタブのHをクリックしてテキストを「Header」として設定するだけです。

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

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

まとめ：ユーザーガイド作成のヒントとコツ¶

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

お客様はあなたの製品やサービスに詳しくありません。製品が技術的であればあるほど、作成段階でのユーザーガイドはより詳細でなければなりません。あいまいな言葉や表現はこのプロセスでは役に立ちません。お客様が製品の基本的な側面でさえ理解できるように、できるだけ具体的に説明しましょう。

一枚の写真は千の言葉に勝ります。これは特にユーザーガイドやマニュアルにとって真実です。このステップはほとんどの企業で非常に無視されていますが、ユーザーガイドで製品の機能や側面を説明する際に、適切な写真やスナップショットを用意することは非常に重要です。そうすることで、お客様は製品のどの側面について言及しているのかを理解できます。

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