12の最高のドキュメント例

公開: 2021-08-05

あなたの顧客はあなたの製品やサービスに関する彼らの問題の解決策を彼ら自身で見つけることができますか？そして、彼らはそう迅速かつ簡単に行うことができますか？

これらの質問の両方に「はい」と答えることは、優れた顧客体験を提供し、顧客満足度を向上させるための大きな部分です。そのため、スタッフの誰かが返信するのを待たずに、顧客が質問に対する回答を見つけるのに役立つドキュメントを用意することが重要です。

ただし、オンラインドキュメントをゼロから作成することは、平均的な偉業ではありません。それはあなたの前でそれを成功させたブランドを見るのを助けます。したがって、この投稿では、ドキュメントのさまざまなカテゴリと、それらのカテゴリでの最良のドキュメントの例について説明します。また、そこにある最高のドキュメントの先導に従い、独自のドキュメントを自分で作成する方法についても説明します。始めましょう。

ドキュメントの種類

ドキュメントの例にジャンプする前に、さまざまな種類のドキュメントについて学ぶことが重要です。これは、ビジネスにとって最も意味のあるタイプを理解するのに役立ちます。

ユーザードキュメント

ユーザードキュメントとは、ユーザーマニュアル、クイックスタートガイド、チュートリアル、FAQ、およびその他の説明資料を作成して、製品またはサービスのエンドユーザーにその潜在能力を最大限に活用するために必要な支援を提供することです。

開発者向けドキュメント

ご想像のとおり、開発者向けドキュメントは、開発者が特定のソフトウェアライブラリまたはサービスを利用または統合する方法のすべての側面を理解することを目的としています。通常はAPI（アプリケーションプログラミングインターフェイス）を使用します。開発者向けドキュメントには、ユースケース、認証、トラブルシューティング情報などの資料が含まれています。これは通常、顧客向けのユーザードキュメントよりもテクニカルライティングで構成されます。

技術文書

技術文書は、ユーザー文書と開発者文書の中間にあり、通常はテクニカルライターが必要です。開発者でなくても理解できるように、製品に関連する技術的な指示や概念をわかりやすく説明することを目的としています。

プロジェクトドキュメント

プロジェクトのドキュメントには、プロジェクトに関する重要な詳細が含まれています。それは、プロジェクトを適切に実行するためにプロジェクトの過程で何が必要かを説明する包括的なドキュメントを作成することです。プロジェクトドキュメントの例としては、プロジェクトの提案、プロジェクトの計画、ビジネスケース、ステータスレポートなどがあります。

ドキュメントの利点

わかりました。あなたはあなたのビジネスを運営するのに忙しいです、そしてあなたが望む最後のことはステータスレポート、ガイドなどのようなものを絶えず文書化する必要があることです。ただし、予期しない問題がどこからともなく発生した場合（そして発生する場合）、あなたとあなたのユーザーが頼りになるドキュメントを持っていることをうれしく思います。適切なドキュメントに優先順位を付けることの主な利点は次のとおりです。

一箇所の知識

平均的な知識労働者は、情報を探すのに1日約2.5時間を費やすと推定されています。効果的なドキュメントは、すべての重要な情報を1か所に収集することで、すべての人の時間を大幅に節約します。

生産性の向上

ドキュメントにより、チームメンバーの不在や、既知の問題が再び発生するなどの予期しないイベントが発生した場合でも、確実に処理を実行できます。クレデンシャルや詳細などを追跡するためにリソースを無駄にすることなく、車輪を動かし続けることができます。

満足度を高める

ドキュメントは、顧客を満足させ、満足させるのに役立ちます。ドキュメントは、製品から最大の価値を引き出す方法を示すことで、解約率を減らし、顧客の生涯価値を高めます。

利点がわからなくなったので、4種類のドキュメントのそれぞれに最適なドキュメントの例に飛び込みましょう。

ヒロイックナレッジベースプラグイン

知識ベースを構築し、顧客が自分自身を助けるのを助けます。

プラグインを入手する

ユーザードキュメントの例

グーグル

Googleは紹介する必要はありません。何百もの製品を提供しており、各製品には独自のドキュメントがあります。 Googleの製品ドキュメントで際立っているのは、静的な回答と、ユーザーがフィードバックを送信したり質問したりするためのコミュニティフォーラムを組み合わせたものであるということです。

Googleのドキュメントの他の注目すべき機能は次のとおりです。

ユーザーは、珍しいクエリで互いに助け合うことができます。これにより、お客様は自分の声をよく聞き、懸念を表明する機会が増えます。
賛成票機能は、他の人も同じ問題に直面しているかどうかを確認し、最も重要な問題やアイデアのサポートを集めるのに最適です。
顧客は、ディスカッションの更新をサブスクライブしたり、コメントを投稿して、追加の視点を提供したりすることもできます。

Skype

Skypeは、Microsoftの人気のあるビデオ会議ソフトウェアであり、ビジネス会議、教育セッション、個人的なチャットなどのさまざまな目的に使用されます。 Skypeのソフトウェアドキュメントには、さまざまなナビゲーションや並べ替えオプションなどのユーザーフレンドリーな機能が搭載されているため、Skypeは優れたドキュメントの例になります。

注意すべきその他の事項は次のとおりです。

ユーザーは、ドキュメントが役に立ったかどうかを示し、フィードバックを共有できます。
ブレッドクラムや目次などの機能により、ドキュメントを簡単にナビゲートできます。

Apple iPhone

AppleのiPhoneはその直感性とユーザーフレンドリーな機能で知られていますが、それは適切なドキュメントを無視する言い訳にはなりません。幸いなことに、Appleはこれを理解しており、そのドキュメントはiPhoneと同じくらいシンプルでナビゲートしやすいです。

iPhoneドキュメントの注目すべき点は次のとおりです。

ユーザーが現在インストールしているiOSバージョンを選択するオプションがあります。これは、エンドユーザーが指示が正確で関連性があることを確認するのに役立ちます。
目次は、他の機能やデバイス固有のスクリーンショットを参照するために使用されています。
ドキュメントが質問に答えない場合、ユーザーはサポートチームに直接連絡できます。

開発者向けドキュメントの例

DockerDocs

Dockerは、アプリケーションを構築、実行、および出荷するためのオープンプラットフォームです。これにより、ソフトウェアを迅速に提供するために、アプリケーションをインフラストラクチャから分離できます。 Dockerのドキュメントにすばらしいスタートを切るのは、ナイトモードとデイモードを切り替える機能です。

このドキュメントを素晴らしいものにする他の要因は次のとおりです。

さまざまな章の最後に、要約とチートシートのセクションがあります。これらのセクションは、ユーザーが見逃した可能性のある概念を強化するのに役立ちます。
ドキュメントのすべてのページに内部リンクが用意されているため、ユーザーは情報を簡単に拡張できます。
現在のページで提供される洞察を理解するために不可欠な前提条件のページまたは章に戻ることができます。

Heroku Dev Center

Herokuは、開発者向けに強力で簡単なアプリケーションデプロイメントサービスを提供します。そして、その開発者センターには美しいドキュメントのセットアップがあります。このドキュメントの最大のハイライトは、別の言語への切り替えがいかに簡単かということです。

Herokuのドキュメントについて注目に値する点がいくつかあります。

さまざまなプログラミング言語の一連の手順と、それぞれのパッケージを提供します。
Githubをコードリポジトリとして使用するなど、Herokuと一緒に使用されることが多い他のツールや統合に関するリソースを利用できます。

Twilio Docs

Twilioは、2008年以来、カスタマイズされた通信ソリューションでビジネスと開発者を支援するトップAPIプロバイダーです。Twilioの開発者向けドキュメントは芸術作品であり、洗練された2つのパネルのデザインですぐに知る必要のあるすべてを提供します。左側のパネルには簡単な説明があり、右側のパネルには便利なコードスニペットがあります。

他に何がこのドキュメントを素晴らしいものにしていますか？以下：

Twilioの開発者向けドキュメントには、エレガントなフォントスタイルと対照的なハイパーリンクがあります。全体のインターフェースは目には非常に簡単です。
開発者が時間と手間を節約するためにすぐにコピーして貼り付けることができるいくつかのソースコードスニペットがあります。
Twilioは、「とにかく、REST APIとは何ですか？」などのトピックで、初心者にも驚くほどの深さを提供します。

技術文書の例

キャンペーンモニター

Eメールマーケティングツールのキャンペーンモニターは、優れた技術文書の優れた例です。検索機能に焦点を当て、その後に顧客を支援するためのクリーンで適切に構造化された記事のコレクションが続きます。

他に何がそれを良いドキュメントにしますか？

記事は、電子メール自動化ソフトウェアの機能に一致するカテゴリに分類されています。
アプリステータスインジケーターは、直面している問題がキャンペーンモニターの側にあるかどうかを顧客に知らせ、ストレスを軽減する巧妙な動きです。

Canva

Canvaは、個人用および業務用のグラフィックデザインツールを提供しており、iOSおよびAndroidデバイスでも使用できます。 Canvaのデザインに関する専門知識は、独自の美しいドキュメントページから明らかです。検索機能から記事のカテゴリまで、ユーザーが適切なソリューションをすばやく見つけるための明確な選択肢があります。

Canvaのドキュメントは次の理由で機能します：

メインページには、トップ記事、カテゴリ、およびその他のサポートオプションが豊富に用意されています。
「人気の検索」は、検索機能を有効に活用するために検索できるフレーズの種類をお客様が理解するのに役立ちます。

ドロップボックス

クラウドストレージサービスを利用する場合は、Dropboxのことを聞いたことがあるはずです。 DropboxのようなSaaSソリューションの場合、ホームページで最も一般的な問題を解決するのが賢明な決断です。

Dropboxドキュメントのその他のハイライトは次のとおりです。

魅力的なイラストの使用は、ブランドの親しみやすい雰囲気を強化し、問題のある人々を慰めるのに大いに役立ちます。
Dropboxコミュニティとの統合により、ユーザー間のやり取りが容易になり、助けを求めるための追加の手段が提供されます。

プロジェクトのドキュメントの例

グエルフ大学のプロジェクト憲章

プロジェクト憲章は、各利害関係者の役割と責任に加えて、プロジェクトの範囲、目標、および開発の詳細を共有する公式のプロジェクト承認文書です。

グエルフ大学のプロジェクト憲章は、優れたドキュメントの例です。わかりやすいテーブルレイアウトでプロジェクト憲章に不可欠なすべての側面をカバーしています。

MSWordのプロジェクト計画テンプレート

プロジェクトドキュメントのもう1つの例は、MSWord用の単純なプロジェクト計画テンプレートです。タスクを追加したり、開始日と終了日を追跡したり、各タスクのステータスを監視したりできます。

プロジェクトステータスレポート

プロジェクトステータスレポートは、プロジェクトマネージャーが作成する週次レポートであり、プロジェクトの現在の状態をすべての利害関係者に伝えます。基本的なレベルでは、範囲、予算、スケジュール、問題、およびリスクをカバーしています。これが例です。

Webサイトにドキュメントを追加する

ドキュメントを作成して維持することは困難を感じることがあります。ただし、作成するすべてのドキュメントは、何万人もの顧客が人間の助けを必要とせずにクエリに回答するのに役立ちます。

始める準備ができたら、HeroicKBを検討してWebサイトにドキュメントを追加してください。これは、見栄えの良いドキュメントをWordPressサイトに統合する使いやすいナレッジベースプラグインです。 HeroicKBの主な機能は次のとおりです。

インスタントテーマの統合：テンプレート中心の構造を備えたHeroicナレッジベースを使用すると、ドキュメントのルックアンドフィールを制御できます。テーマ統合ノートも提供されるため、HeroicKBはWordPressの最も柔軟なナレッジベースプラグインの1つになります。

インスタントアンサー：超高速のAJAX検索により、顧客は必要なものを数秒で見つけることができます。

組み込みの分析：ナレッジベースがユーザーをどの程度支援しているかについての洞察を取得します。また、記事に関するフィードバックを収集して、ユーザーに役立つ記事を特定することもできます。

簡単な整理：Heroic KBにはドラッグアンドドロップのカテゴリ注文が付属しているため、すべてを自分のやり方で注文できます。

ユーザーアクセス制御：パスワードで保護し、さまざまなユーザーの役割から記事を非表示にします。

添付ファイルのサポート：記事内のダウンロード可能なファイルを訪問者に提供します。

ウィジェットのサポート：サイト全体でナレッジベースの記事、カテゴリ、および作成者を表示するための3つのウィジェットがあります。

開発者向け：Heroic KBは、デフォルトでレスポンシブスタイルに加えて、最も適切にコーディングされたテーマですぐに使用できます。

言語サポート：プラグインはWPML互換性を備えた翻訳対応であり、完全なローカリゼーションサポートを提供します。

優れたカスタマーサービス：Heroic KBチームは、問題が発生した場合に備えて、いつでも喜んで迅速にサポートします。

もちろん、WordPressユーザーは、ブログ投稿として記事を追加するだけです。ただし、特定のKBプラグインを使用することには、いくつかの利点があります。ドキュメントの管理がはるかに簡単になり、ユーザーは他のコンテンツとは別にドキュメントを検索できます。

もう1つのオプションは、専用のナレッジベーステーマを使用することですが、これは、Webサイト全体がナレッジベースである場合にのみお勧めします。ナレッジベースを既存のWordPressWebサイトに追加する場合、プラグインが断然最良のソリューションです。

上記の例からわかるように、優れたドキュメントは、現在の顧客を満足させるだけでなく、スタッフのトレーニングや潜在的な顧客の獲得にも大きな可能性を秘めています。あなたのウェブサイトにドキュメンテーションを追加するためにあなたが費やした努力は、今後何年にもわたって見事に報われるでしょう。それでは、今日からHeroicKBを始めましょう。