ユーザーガイドはデジタルサービス提供の重要な部分です。デジタル顧客は自己解決型のサービスを求め、情報への即時アクセスを期待しています。電話での説明だけでは、もはや十分ではありません。ユーザードキュメントガイドで効果的に説明できることに時間を費やすのは非効率的です。¶

Docsieでは、すべての企業が顧客向けの情報豊富なユーザーガイドライブラリを作成することを推奨しています。これにより、セルフサービスが可能になり、サポート業務の負担が軽減され、顧客が製品やサービスを最大限に活用するために必要な情報に24時間365日リアルタイムでアクセスできるようになります。

Docsieでのユーザーガイドとドキュメント作成のための10のヒント¶

まず始める前に、ドキュメントを保存、作成、公開する方法はありますか？

Docsieオンボーディングページにアクセスして、顧客中心のコラボレーション、幅広い埋め込み機能、カスタマイズされた翻訳、強力な公開機能をすぐに利用できます。

それでは、10のトップヒントを見ていきましょう！

1 - メディアでユーザーガイドを豊かにする¶

テキスト、言葉、文字 – 私たちは毎日これらを使用しています。しかし、文字だけでは動画のリアリティや画像のインスピレーションには及びません。

ユーザードキュメントガイドを作成するときは、ユーザーの視点から読んでみましょう。このセクションはGIF、埋め込み動画、注釈付き画像でより分かりやすく説明できるでしょうか？もしそうなら、追加しましょう！

Docsieでは画像の追加、動画の埋め込み、iFrameコンテンツの統合ができます。ぜひ試してみてください！

2 - 順序を作成する（ジェダイの「オーダー」ではありません！）¶

料理本の基本は、ステップバイステップの手順です！レシピに従うとき、卵と小麦粉を混ぜ合わせますか？そうするべきですが、それは手順に従っているからこそ分かることです！

冗談はさておき、ステップバイステップの手順があるユーザーガイドは必ず実際に試してみてください。その手順に従うと、本当に意図した結果が得られるでしょうか？正確でない指示は顧客にとって大きな警告信号となります。一方、正確な指示は信頼を築き、情報共有を通じて顧客とビジネスに価値を提供します。

Docsieの番号付きリストや、Docsieブック記事を使用してドキュメントをセグメント化し、順序を作成しましょう。

3 - あらゆる読解レベルに対応する¶

顧客がJavaScriptと他の専門用語の違いを理解していると思いますか？専門用語や複雑な用語は、技術的なユーザーガイドでは一般的に推奨されています。しかし、一般の方には、シンプルな言葉がより効果的です！

ほとんどの読者は、やり方を知って繰り返せるようになりたいだけです。一つのアプローチは、複雑な高度な概念を詳細に説明した後、一般の方向けに簡略化したバージョンを提供することです。これにより、技術ユーザーと一般ユーザーの両方に対応でき、一石二鳥です。

「人工知能は生産性追求のための人間知能のアルゴリズム的エミュレーションを含み、コンピュータコードを使用して人間の知能に匹敵する作業の完了を目指す」と「AIはコンピュータプログラムで人間のような判断ができるようにして、仕事を効率化する技術」は同じことを意味していますが、対象とする読者が異なります。

Docsieを使用して、一般ユーザー向けのシェルフと技術ユーザー向けのシェルフを作成しましょう。これにより、両方の読者層をサポートするブックを作成でき、Docsieポータルを通じて完全にホスティングできます。

4 - テンプレートを使用して夜更かしを避ける！¶

毎回ユーザーガイドをゼロから書き直していますか？代わりに、基本的な構成とブランドメッセージを含むテンプレートを作成し、そのコンテンツを基に構築するべきです。

ゼロから書くことは時間と労力がかかり、複数の執筆者が同じプロジェクトで作業している場合、一貫性が失われるリスクがあります。テンプレートは執筆時間を節約する優れた方法であり、ページ間の一貫性を高めます。信頼は一貫したメッセージと価値の創出に基づいて構築され、テンプレートはそれを促進します。

Docsieで「…その他」をクリックしてテンプレートを選択します。ここでテンプレートを保存し、テンプレートをソースとして新しいブックを開始できます！

5 - 素早く書き、頻繁に改良する¶

アジャイルソフトウェア開発では、「素早く失敗し、頻繁に改良する」が標語です。これをユーザードキュメントガイドに適用すると、スタッフは素早く書き、頻繁に改良することを目指すべきです。

これは品質を犠牲にして速度を優先するという意味ではありません。むしろ、初期の労力を少なくして顧客のフィードバックと反応を得ることができます。このフィードバックはユーザードキュメントガイドの改良に活用でき、ビジネスがより顧客中心になるのに役立ちます。

Docsie Vocallyは読者のフィードバックを明確にし、評価と画面録画で読者が読んだ正確なコンテンツを特定します。素早く書き、頻繁に改良する際に試してみてください！

6 - 内部バックリンクで知識を階層化する¶

ユーザーガイドのドキュメントは他のページとバックリンクされていますか？ドキュメントの関連セクションへのリンクを追加することで、読者が製品やサービスを概念レベルで理解し、詳細を把握するのに役立ちます。

特定の機能について言及する場合は、必ずリンクを追加しましょう。読者が自分で検索してページを読み込むのを強いるのではなく、その情報に素早くアクセスできるようにします。アカウントログインについて説明している場合は、ページの「アカウントにログイン」というテキストにログインURLを追加しましょう。ドキュメントを本文内で便利にナビゲート可能にし、無限のライブラリを探し回る必要がないようにします。

Docsieではユーザーガイド作成者が内部バックリンクを作成できます。テキストをハイライトしてDocsieエディタツールバーの🖇️ボタンをクリックするだけです。さらに、相対オブジェクトリンクを使用して、言語やバージョンに依存しないリンクを作成することもできます。

7 - 古いコンテンツを刷新して最新に保つ¶

古いユーザーガイドやドキュメントがオンラインで公開されていませんか？製品がバージョン1.3になっているのに、バージョン1.2のドキュメントが公開されていると、ドキュメントは最新ではなくなります。各バージョンごとに新しいドキュメントを公開するのではなく、Docsieバージョニングを使用しましょう。

Docsieバージョニングを使用すると、ユーザーは過去と現在のドキュメントバージョンにアクセスできます。新しいバージョンがリリースされると、古いバージョンは冗長性のために保管されますが、ドロップダウンメニューからアクセスできます。これはすべて同じWebページ上にあり、ユーザーが関連情報を閲覧し見つけやすくなります。

同様に、2021年のトップヒントガイドが2022年にも公開されている場合は、更新しましょう！名前を変更し、引用や情報源を最新の研究で更新し、情報が依然として関連性があるかどうかを再確認します。古い要素を取り除き、常に最新の状態を保ちましょう。コンテンツは常に再利用できます。

8 - タスクを小分けにして、バッチで完了する¶

執筆時、事前計画なしに一度にページ全体を書いていますか？これは執筆者の個人的な好みにもよります。しかし、タスクを小分けにすることで、作業をより速く、より集中して完了できます。

H1とH2タグと各セクションの簡単な説明を含むシンプルな構造を作成しましょう。これを執筆時に使用し、ページ全体を気にするのではなく、個々のセクションに取り組みましょう。これは執筆業界ではアウトラインと呼ばれています。アウトラインは執筆開始前に編集者からフィードバックを得る機会を提供し、執筆者が書く際のガイドとなります。

Docsieで新しいブックを作成し、アウトライン用の基本的な見出しとテキストを追加しましょう。また、右側のメニューを使用してタスクを追加し、複数のチームメンバーがコンテンツに共同で取り組む際に作業を小さなバッチに分割できます。バージョン履歴により、執筆者が期待以下のコンテンツを追加した場合に戻ることができます – 素早く書き、頻繁に改良するのに最適です！

9 - より多くのコンテンツ読者のための目次¶

複雑で多様なユーザーガイドドキュメントでは、大量のテキストが読者にとって威圧的に感じることがあります。これは包括的な目次で解決できます。百科事典でよく使用されるこの機能は、ユーザーが関連情報を特定してジャンプするのに役立ち、知識ポータル環境に構造を提供します。

Docsieの記事、シェルフ、ワークスペースは目次を作成するために機能します。これは知識ポータルの左側に自動的に表示され、ナレッジベースをナビゲートする簡単な方法を提供します。このトップヒントでは、Docsieが自動的に行ってくれます！

10 - テーマをマスターする¶

執筆者は対象分野の専門家ですか？同様に、執筆者は馴染みのないトピックを調査することに長けていますか？結局のところ、私たちのすべてのヒントにもかかわらず、執筆者がユーザードキュメントガイドの品質を決定します。

製品についての理解が深いほど、その作業はより正確になります。執筆者に製品をテストし、問題を発見する柔軟性を与えましょう。ユーザーも同様の問題に遭遇する可能性があります。さらに良いのは、営業チームと一緒に製品デモを体験させ、営業プロセスとそこに含まれるメッセージについての実践的な経験を与えることです。これにより一貫性が高まり、執筆者をユーザーに変えることができます。すべての執筆者がユーザーになるわけではありませんが、実践的な知識があれば、すべてのユーザーが優れた執筆者になる可能性があります。

これらのヒントをDocsieで実践しましょう！¶

より良いユーザーガイドのための10のトップヒントをお読みいただきありがとうございます。これらのヒントをDocsieのドキュメントに適用してみてください！

Docsieは、ビジネスがWebベースのFAQ、製品ドキュメント、ユーザーガイド、ヘルプドキュメント、ユーザーマニュアルを作成するために使用するエンドツーエンドのドキュメント管理プラットフォームです。このプラットフォームは、顧客中心のコラボレーション、幅広い埋め込み機能、カスタマイズされた翻訳、強力な公開機能を備えています。

今すぐDocsieでオンボーディングを行い、顧客に素晴らしいドキュメント体験を提供しましょう！