製品ドキュメントUltimateGuide：優れたドキュメントを作成するために知っておく必要のあるすべて

公開: 2021-10-25

製品ドキュメント…それはビジネスを運営する上で最もセクシーな部分ではないかもしれませんが、ビジネスを成功させたいのであれば見逃してはならない重要な領域です。

高品質の製品ドキュメントを作成することで、顧客をより成功させ、サポートの負担を軽減し、一般的にはより良いビジネスを構築することができます。

しかし、製品ドキュメントの作成には何が必要ですか？また、Webサイトに独自のドキュメントを設定するにはどうすればよいですか？

これらは、製品ドキュメントの究極のガイドで回答する質問のほんの一部です。これが私たちがカバーするすべてです：

製品ドキュメント戦略を気にする必要がある理由
一流のドキュメントのいくつかの実際の例
最高の製品ドキュメンテーションソフトウェア
より良いドキュメントを作成するための8つのヒント

ビジネスでドキュメントを処理する方法を改善する準備はできていますか？掘り下げましょう！

製品ドキュメント戦略を気にする必要がある理由

製品ドキュメントの戦略を軽視してはいけない理由を見てみましょう。

それはあなたの顧客をより成功させる

製品ドキュメントを作成する最大の利点は、顧客をより成功させることです。より多くの成功した顧客を持つことは、より高いコンバージョン率、より低い解約率などを意味します。

それは理にかなっています–顧客があなたの製品から価値を得る方法を理解できない場合、彼らは非常に長い間顧客であり続けることはありません。

製品ドキュメントは、顧客が可能な限り多くの価値を得ることができるように顧客を教育するための1つの便利な方法です。彼らがあなたの製品からより多くの価値を得るとき、彼らは支払いを続ける可能性が高くなり、彼らの友人/同僚にあなたを推薦するなどです。

それはあなたのサポート負担を軽減します

製品ドキュメントは、人間のサポートチャネルの負担を軽減するための優れた方法でもあります。

製品ドキュメントの品質が低いか存在しない場合は、問題が発生するたびに顧客がヒューマンサポートチームに連絡する必要があることを意味します。つまり、サポートリクエストへの応答により多くの時間が費やされることになります。

これらの応答を自分で処理するためにビジネスの成長から時間をとる必要があるか、専任のサポート担当者を雇う必要があります（費用がかかります）。

高品質のドキュメントを使用すると、お客様は自分の問題の多くを解決できるようになり、サポートに連絡する必要がなくなります。また、サポートプロセスを構成して、リクエストを行う前にドキュメントを確認するように人々を促すこともできます。

それは良いマーケティングと販売ツールになることができます

多くの人がすでに購入を決定した人を助けるという文脈で製品のドキュメントについて考えていますが、優れた製品のドキュメントは、そもそもより多くの顧客を引き付けて変換するのにも役立ちます。

マーケティングの観点から、製品ドキュメントは、ドキュメントをランク付けできるロングテールSEOキーワードの宝庫です。あなたはグーグルからあなたの製品ドキュメントに直接着陸する人々の数に驚かれるかもしれません。ドキュメントを適切に構成すると、これらの人々を顧客に変えるチャンスがあります。

あなたのドキュメンテーションはまたあなたの製品を購入することについての柵にいる人々のための有用な販売ツールでありえます。製品ドキュメントは、販売前の潜在的な質問に対処し、製品が必要なことを実行できることを納得させ、必要なときに助けが得られるという自信を与えることができます。

たとえば、Stripeは最高の製品ドキュメントをいくつか持っていることで知られています。 Twitterにアクセスすると、Stripeのドキュメントの品質が高いため、多くの人がStripeを推奨していることがわかります。

それはあなたの従業員をより効果的にします

製品ドキュメントは顧客だけのものではなく、チームメンバーが製品について学び、必要に応じて参照するための重要なリソースにもなります。これは、製品に関する幅広い知識を持っていない可能性のある新入社員に特に当てはまります。

4つの優れた実際の製品ドキュメントの例

さらにインスピレーションを得るために、成功している企業の実際の製品ドキュメントの例を見てみましょう。

1.ストライプ

Stripeは、マーケティング/販売ツールとしての高品質のドキュメントの最良の例の1つとして前述したので、Stripeドキュメントはリストの1位でなければなりませんでした。

2.アディエン

Adyenは、eコマース、モバイル、POSでの支払いのための支払いプラットフォームです。 Stripeと同様に、開発者はStripeを独自のプラットフォームに統合する必要があり、優れたドキュメントが必要です。 Adyenは失望しません–ここでAdyenの完全なドキュメントをチェックしてください。

3. Twilio

Twilioに慣れていない場合は、テキストメッセージ、電子メール、電話などを介して、企業がプラットフォームにコミュニケーションを構築するのに役立つツールです。 StripeやAdyenと同様に、これは企業がTwilioを既存のサービスに統合する必要があることを意味します。これには一流のドキュメントが必要です。 Twilioドキュメントを参照して、優れた例を確認できます。

4.たるみ

Slackは、非常によく書かれた便利なドキュメントを備えたもう1つのツールです。 Slackの完全なドキュメントはここで閲覧できます。

その他の例を確認するには、最高のユーザードキュメントの例に関する投稿全体を確認してください。

最高の製品ドキュメンテーションソフトウェア

それでは、サイトでより優れた製品ドキュメントの提供を開始する方法に焦点を当てましょう。

次のセクションでは、実際にドキュメントを作成する方法について説明します。ただし、ドキュメントを作成する前に、それらの記事を保存してユーザーがアクセスできるようにする場所が必要です。

これらの記事をサイトに直接追加することもできますが、専用の製品ドキュメントソフトウェアを使用することをお勧めします。コンテンツを整理して訪問者がアクセスできるようにするだけでなく、優れた製品ドキュメントソフトウェアには、次のような他の便利な機能が含まれます。

訪問者がドキュメントを閲覧するのに役立つAjax検索機能。
アナリティクスを検索して、人々が探しているトピックを確認します。
個々の記事がどれほど役立つかを追跡し、必要に応じて改善できるようにするための有用性データ。

ここに2つの最良の解決策があります…

ヒロイックナレッジベース（ヒロイックKB）

Heroic Knowledge Baseは、無料のオープンソースWordPressソフトウェアのプラグインであり、独自のセルフホスト製品ドキュメントハブを簡単に作成できます。

すでにビジネスのWebサイトにWordPressを使用している場合は、Heroicナレッジベースをサイトに追加して、独自のドキュメントハブを作成できます。または、そうでない場合は、ドキュメント専用のWordPressインストールを作成できます。 後者の場合、 KnowAllWordPressドキュメントテーマにも興味があるかもしれません。

Heroicナレッジベースでは、WordPressのコンテンツエディタを使用してすべてのドキュメントを追加できます。これにより、必要に応じてマルチメディアコンテンツを簡単に含めることができます。また、WordPressの組み込みコンテンツバージョン管理システムにアクセスできるため、変更を簡単に追跡し、以前のバージョンのドキュメントを比較できます。

Heroic Knowledge Baseには、次のような便利な機能も追加されています。

インスタントAjax検索。
検索分析。
記事の有用性の評価。
記事ファイルの添付ファイル。

Heroicナレッジベースの価格はわずか129ドルです。

Adobe RoboHelp

ドキュメントをWebで公開するだけの場合、必要なのはHeroicナレッジベースのようなソリューションだけです。ただし、よりエンタープライズレベルのドキュメントのニーズについては、Web、物理的な紙、モバイルアプリ、PDFなどの複数のプラットフォームにドキュメントを公開する必要がある場合があります。

この場合、AdobeRoboHelpなどのマルチプラットフォームのドキュメントオーサリングツールをお勧めします。個人使用の月額$29.99から、Heroicナレッジベースよりも高価です。ただし、マルチプラットフォームのオーサリングが必要な場合は、その追加料金はお金の価値があるかもしれません。

製品ドキュメントの構造とコンテンツを最適化する方法

ドキュメントを管理するために必要なソフトウェアが揃ったので、高品質の記事を作成する方法について説明しましょう。ドキュメントを構成し、より良いヘルプ記事を書くための8つの重要なヒントを次に示します…

1.対象者を理解する

優れた製品ドキュメントを作成するには、作成対象の対象者（つまり顧客）を理解する必要があります。

誰のために書いているかは、どの情報を含めるか、そしてすべてをどのように構成するかに影響します。たとえば、開発者向けに作成する場合、ドキュメントはカジュアルユーザー向けに作成する場合とは根本的に異なる必要があります。

あなたはあなたの聴衆が専門家であり、重要な詳細を熟知していると仮定したくはありませんが、彼らが誰であるかに応じていくつかの基本的な知識を仮定するかもしれません。

2.さまざまな製品ドキュメントタイプを理解する

製品ドキュメントにはさまざまな種類があり、それぞれに異なるアプローチが必要です。一般的なタイプのいくつかは次のとおりです。

概要–これらの記事は、「はじめに」ガイドなど、製品のある領域がどのように機能するかの概要を提供します。
ステップバイステップのチュートリアル–これらの記事は、特定のタスクを実行する方法を示しています。
リファレンス–これらの記事では、製品の特定の概念について説明しています。
トラブルシューティング–これらの記事では、お客様が遭遇する可能性のある一般的な問題をデバッグ/トラブルシューティングする方法について説明しています。

作業しているドキュメントの種類は、ドキュメントの作成方法と構造に影響を与えるはずです。そのため、掘り下げる前に、目標が何であるかを知ることが重要です。

3.スタイルと命名規則に一貫性を持たせる

製品ドキュメントを顧客が使いやすくするために、ドキュメント全体で同じスタイルと命名規則を維持することが重要です。これにより、顧客はドキュメントを簡単にフォローでき、混乱を避けることができます。

これを行うのに役立つ場合は、基本的なフォーマットと用語のスタイルガイドを考え出すと役立つ場合があります。

4.わかりやすい言葉を使用し、簡潔に保つ

すべてのものが等しく、短く、単純な言語は、単語のサラダよりも常に優れています。あなたの目標は、必要なすべての情報をできるだけ少ない言葉で伝えることです。

また、可能な限り専門用語や複雑な用語を使用しないようにする必要があります。すべての顧客が同じ知識ベースを持っているわけではなく、一部の顧客はドキュメントの言語のネイティブスピーカーでさえない可能性があるため、できるだけシンプルに保つことで、すべての顧客がドキュメントから価値を得ることができます。

5.論理的な「問題サイズの」記事でドキュメントを整理する

人々があなたのドキュメントを閲覧し、彼らの特定の問題に関する記事を見つけやすくするために、あなたはあなたのドキュメントを論理的なセグメントに分割する必要があります。一般に、各記事は1つの特定の問題の解決に焦点を当てる必要があります。

もちろん、その主な問題の中に複数のサブ問題があるかもしれませんが、人々がそれらのトピックを検索するのが難しくなるので、2つの完全に別々の問題を同じ記事にまとめたくないという考えです。彼らが記事に着陸するとき、混乱するかもしれません。

顧客は、本を読んでいるように直線的にドキュメントを読むことはありません。代わりに、彼らは現在直面している問題に基づいて飛び回るでしょう。記事を論理的なセグメントに分割すると、この動作を説明するのに役立ちます。

6.マルチメディア要素を組み込む

書かれたテキストは製品ドキュメントのコアを形成する必要がありますが、それだけではありません。意味のある場所に画像やビデオのコンテンツを含めることも役立ちます。

スクリーンショットを含める場合は、画像に注釈を追加して、重要な詳細を明確にすることもできます。

7.見出しを使用し、目次を追加します

個々の製品ドキュメントの記事内で、1つの長いテキストの壁を書くのではなく、見出しを使用して記事を論理的なセグメントに分割してください。

人々が記事をナビゲートしやすくするために、読者が特定のセクションにすばやくジャンプできる目次を追加することもできます。

一部の製品ドキュメントソフトウェアは、目次を自動的に追加するのに役立ちます。たとえば、Heroicナレッジベースプラグインには、各記事の見出しに基づいて目次を自動的に生成する機能が組み込まれています。

8.ドキュメントを常に改善および更新します

最後に、製品ドキュメントの作成は1回限りのイベントではないことを覚えておくことが重要です。それは進行中のプロセスです。

基本的なレベルでは、製品はおそらく変更されるため、それらの変更と追加した新機能を考慮してドキュメントを更新することが重要です。

しかし、それを超えて、Heroic Knowledge Baseなどの製品ドキュメントソフトウェアを選択すると、分析にアクセスして、人々がドキュメントをどのように使用しているかを理解するのに役立ちます。これらの分析を使用して、次のことができます。

人々が何を検索しているかを追跡します。これは、まだ作成していない場合は、それらのトピックに関するドキュメントを作成する必要があることを示している可能性があります。
どの記事がユーザーの役に立っていないかを確認します。これは、それらの記事の有用性を向上させるために、それらの記事を改善する必要があることを示している可能性があります。

今日から素晴らしい製品ドキュメントの作成を始めましょう！

高品質の製品ドキュメントを作成することは、ビジネスの長期的な成功への投資です。それはあなたを助けます…

顧客をより成功させる。
サポートチームの負担を軽減します。
そもそも、より多くの顧客を引き付け、転換します。
製品に関する従業員の知識を向上させます。

この投稿では、成功した企業の製品ドキュメントの優れた例と、ドキュメントの作成方法と構造化のヒントを共有しました。

独自の製品ドキュメントハブを作成する準備ができている場合は、Heroicナレッジベースプラグインを使用して、WordPressを利用した独自のセルフホストソリューションを構築できます。 Heroicナレッジベースの詳細については、ここをクリックしてください。