ユーザーガイドは、デジタルサービス提供の重要な要素です。デジタルの顧客は、セルフサービスへのアクセスを期待し、情報への即時アクセスを要求しています。ユーザーガイドで説明できることを、何時間もかけて説明するのは、もう電話によるウォークスルーでは不十分なのです。
Docsieでは、すべての企業が顧客向けに有益なユーザーガイドのライブラリを作成することを提唱しています。これにより、セルフサービスが可能になり、サポート業務が軽減され、顧客が製品やサービスを楽しみながら利用するために必要な情報に、24時間365日リアルタイムでアクセスできるようになります。
Docsieでユーザーガイドとドキュメンテーションを作成するための10の秘訣
。 その前に、ドキュメントを保存し、書き、ホストする方法はありますか？
Docsie Onboarding](https://app.docsie.io/onboarding/)ページでは、顧客中心のコラボレーション、幅広い埋め込み、カスタマイズされた翻訳、パワフルなパブリッシングを指先一つで実現できます。
それでは、10個の秘訣をご紹介しましょう！
1 - ユーザーガイドをメディアで充実させる
。 文字、言葉、手紙......私たちは毎日それらを使っています。しかし、悲しいかな、文字というものは、映像の迫力や画像の感動にはかなわないものです。
ユーザードキュメントのガイドを作成するときは、ユーザーの視点から読みましょう。このセクションは、GIF、埋め込みビデオ、注釈付き画像でよりよく説明できますか？もしそうなら、1つ追加してください！
Docsieで画像の追加、動画の埋め込み、iFrameコンテンツの統合が可能です。試してみてください！
2 - ジェダイのようなものではなく、騎士団を作ろう！
。 ステップバイステップの説明は、どこの料理本にもある柱です！レシピに従うとき、卵と小麦粉を混ぜ合わせる？そうすべきなのは、手順を追うからこそわかることなのです！
冗談はさておき、ステップバイステップで説明されているユーザーガイドがあれば、必ず読んでみてください。そのステップに従った場合、実際に意図した結果が得られるかどうか？意図した結果が得られない不正確な説明書は、顧客にとって大きな赤信号です。一方、正確な説明書は、信頼を与え、情報の共有を通じて顧客とビジネスに価値をもたらします。
Docsieの番号付きリスト、またはDocsie Book Articlesを使用して順序を作成し、ドキュメントをセグメント化することができます。
!!!【ドクシィの記事・棚・ワークスペース】(https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_O4Ux6ERzhyIS0eB1X/boo_dqsfhc7ObadQ3xWmV/aa925138-ab48-e18b-ff33-50557a2897cfArticlesShelvesWorkspacesinDocsie.png)
3 - すべての読書レベルに対応
。 あなたは、顧客があなたのトップヒントから自分のJavaScriptを知ることを想定していますか？専門用語や複雑な用語を使うことは、一般的に技術的なユーザーガイドの文脈では推奨されています。しかし、一般人にとっては、言葉は簡単であればあるほどいいのです！
多くの読者が求めているのは、「どうすればいいのか」「どうすればいいのか」を繰り返すことです。そこで、複雑で高度なコンセプトを紙に書き出し、それを素人向けに簡略化したものを再度作成するという方法があります。これは、1本のペンで2つのページにインクを塗ることで、テクニカルユーザーと一般ユーザーを一度にカバーするものです。
「人工知能は、コンピュータコードを用いて人間の知能と一致させることで、仕事を成し遂げることを目的としている」。- どちらも同じ意味だが、ターゲットとする読者は異なる。
Docsieを使って、一般ユーザー用の棚と技術ユーザー用の棚を作りましょう。そうすれば、Docsieポータルを通じて完全なホスティングが可能で、両方のユーザーを支援するブックを持つことができます。
4 - テンプレートを使って、夜更かしをやめよう！
。 すべてのユーザーガイドを一から書き直すのでしょうか？そうではなく、基本的な構成とブランドメッセージの入ったテンプレートを作成し、このコンテンツを中心に構築することが必要です。
一から書くとなると、時間も労力もかかるし、複数のライターが同じプロジェクトで作業する場合、一貫性がなくなる危険性もある。テンプレートは、文章を書く時間を短縮し、ページ間の一貫性を高めるのに最適な方法です。信頼は、一貫したメッセージと価値の創出によって築かれるものであり、テンプレートはそれを促進します。
...Moreをクリックし、DocsieのTemplatesを選択します。ここでは、テンプレートを保存し、テンプレートをソースとして新しいブックを開始することができます！
!!!【Docsie Editorでライブテンプレート】(https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_jdf9iWL3NXlFFePHx/boo_dqsfhc7ObadQ3xWmV/2bfcea18-df94-30ff-4931-799345e4ae74Templates2inDocsie.png)
5 - 速く書き、頻繁に反復する
。 アジャイルソフトウェア開発では、「速く失敗し、頻繁に反復する」ことが信条とされています。これをユーザー・ドキュメント・ガイドに当てはめると、担当者は「速く書いて、頻繁に反復する」ことを目指すべきでしょう。
これは、スピードのために品質を犠牲にすることを意味するものではありません。その代わり、より少ない労力で顧客からのフィードバックとレスポンスを得ることができます。このようなフィードバックは、さらにユーザー文書ガイドを作成する際に活用することができ、ビジネスがより顧客中心になることを支援します。
Docsie Vocallyは、読者からのフィードバックを、評価やスクリーンレコーディングによって、読者が読んだ内容を正確に把握することができます。速く書き、頻繁に反復するために、ぜひ試してみてください！
6 - 内部バックリンクによる知識の入れ子
。 ユーザーガイドのドキュメントは、他のページとバックリンクされていますか？ドキュメントに関連する部分へのリンクを追加することで、読者が製品やサービスをより具体化し、概念的に理解できるようになります。
特定の機能や特徴に言及する場合は、必ずリンクを付けましょう。読者が自分でページを検索して読み込むことを強いるのではなく、その情報にすぐにアクセスできるようにします。アカウントのログインについて話している？あなたのページや他のすべてのページの「アカウントにログインする」テキストにログインURLを追加してください。ドキュメントを、無限のライブラリから探し出すのではなく、本文の中で便利でナビゲートしやすいものにするのです。
Docsieでは、ユーザーガイドの作成者が内部バックリンクを作成することができます。テキストをハイライトして、Docsie Editorのツールバーにある🖇️ ボタンをクリックするだけです。さらに、相対オブジェクトリンクを使って、言語やバージョンに依存しないリンクを作成することができます。
7 - クモの巣を取り除き、古いコンテンツをリフレッシュする
。 古いユーザーガイドとドキュメントをオンラインで公開していませんか？製品がバージョン1.3であるにもかかわらず、バージョン1.2のドキュメントが公開されている場合、そのドキュメントはもはや適切ではありません。バージョンごとに新しいドキュメントを発行するのではなく、Docsie Versioningを使用してください。
Docsieのバージョン管理機能により、ユーザーは過去と現在のドキュメントのバージョンにアクセスすることができます。新しいバージョンがリリースされると、古いバージョンは冗長性のためにアーカイブされ、ドロップダウン・メニューからアクセスできるようになります。これはすべて同じウェブページ上にあり、ユーザーは関連する情報を簡単に閲覧・検索することができます。
同様に、2021年に作成したトップチップガイドが2022年になっても発行されている場合は、更新しましょう！名前を変え、引用や出典を最新のものにし、情報がまだ適切であることを再確認しましょう。コンテンツはいつでも再利用できるのです。
8 - タスクを細分化し、一括で完了させる
。 文章を書くとき、事前計画ゼロで一気に全ページを書き上げるか？これは、作家の個人的な好みに帰結する部分もあります。しかし、タスクを細分化することで、より早く、より集中して仕事をこなすことができます。
H1、H2タグと各セクションの簡単な説明でシンプルな構造を作りましょう。これを文章を書くときに使い、ページ全体を気にするのではなく、個々のセクションに取り組みます。これは、ライティング業界ではアウトラインと呼ばれています。アウトラインは、執筆前に編集者にフィードバックする機会を提供し、執筆時の指針として機能します。
Docsieで新しいブックを作成し、基本的なヘッダーとテキストを追加して、アウトラインを作成します。また、右側のメニューからタスクを追加し、複数のチームメンバーが共同でコンテンツを作成する際に、作業を小分けにすることができます。バージョン履歴があるので、ライターがあまり良くないコンテンツを追加した場合でも、元に戻すことができます！
Docsieのタスク担当者用カレンダー](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_4JCx9FdXnyXu3quMX/boo_dqsfhc7ObadQ3xWmV/d3468298-7bc2-7f51-7afe-2437f6321658TaskMiniaturizeCalendarDocsie.png)
9 - より多くのコンテンツ読者のための目次
。 複雑で多様なユーザーガイドの文書では、テキストの壁が読者を威圧してしまうことがあります。このような場合は、包括的な目次を作成することで解決できます。百科事典でよく使われる「目次」は、ユーザーが関連情報を識別してジャンプするのに役立ち、ナレッジポータル環境に構造を提供します。
Docsieのアーティクル、シェルフ、ワークスペースは、目次を作成するために機能します。これは、ナレッジポータルの左側に自動的に表示され、ナレッジベースを簡単にナビゲートする方法を提供します。このヒントでは、Docsieがあなたのためにそれを行ってくれます！
10 - テーマをマスターする
。 あなたのライターは、その分野の専門家でしょうか？また、ライターが知らないトピックを調べたりするのは得意でしょうか？結局のところ、どのようなヒントがあっても、ユーザー文書ガイドの品質を左右するのは書き手なのです。
製品をより深く理解することで、より正確な作業を行うことができます。ユーザーが同じような問題に遭遇する可能性があるため、ライターが製品をテストしたり、壊したりできるように柔軟性を持たせてください。さらに、営業チームと一緒に製品のデモを行い、セールスパイプラインやメッセージングを実際に体験してもらうとよいでしょう。こうすることで、ライターがユーザーとなり、一貫性を保つことができます。すべてのライターがユーザーになるわけではありませんが、すべてのユーザーが実践的な知識を持つことで、優れたライターになることができます。
Docsieでこれらのヒントを実践してください！
。
より良いユーザーガイドのための10のヒントをお読みいただきありがとうございます。ぜひ、これらのヒントをあなたのDocsieドキュメントに適用してください！
Docsieは、WebベースのFAQ、製品ドキュメント、ユーザーガイド、ヘルプドキュメント、ユーザーマニュアルを作成するために使用されるエンドツーエンドのドキュメント管理プラットフォームです。このプラットフォームは、顧客中心のコラボレーション、広範な埋め込み、カスタマイズされた翻訳、そして指先での強力なパブリッシングを特徴としています。
今すぐDocsieでオンボードし、顧客にドキュメントの喜びを提供しましょう！