この失敗から、私は自分たちの製品をお客様の視点で見る必要があることを学びました。そして、その時、光のスイッチが入ったのです。お客様の悩みを解決する製品を提供し、それをプロフェッショナルな製品ドキュメントでサポートすれば、私たちは勝者になれるのです。
そして、プロフェッショナルで、美しく、読みやすい製品ドキュメントを作成することは、簡単なことではないこともわかりました。しかし、製品ドキュメントを正しく作成することで、顧客を喜ばせ、最終的に収益を上げることができるのです。
プロフェッショナルな製品ドキュメントを作成するためのベストプラクティスとは？
![]（https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_PAtUEFouRAqhgcvnJ/809d42be-d04c-76b1-7895-4348b612a22dbrooke_cagle__uhvrvdr7pg_unsplash1.jpg）
これらのベストプラクティスは、美的感覚に優れ、情報量が多く、使い勝手の良い製品ドキュメントを作成します。これらのガイドラインに従うことで、「良い顧客」を「良い顧客」にすることができる製品ドキュメントを提供することができます。そして、優れた顧客は最終的に企業の収益向上に貢献し、製品ドキュメントは顧客体験の重要な構成要素になります。
1.ターゲットを理解し、彼らが望むものを提供する
オーディエンスが何を期待しているかを知る](https://www.stickyminds.com/article/writing-requirements-documentation-multiple-audiences)ことが肝要です。例えば、製品ドキュメントは管理者向けなのか、エンドユーザー向けなのか。対象者の範囲によっては、管理者向けに技術的に書くか、エンドユーザー向けに明確に定義された用語や手順で書く必要があるかもしれません。
プロフェッショナルな製品ドキュメントを作成するためのベストプラクティスは、管理者またはエンドユーザーレベルで顧客の期待値を理解することです。識別できる聴衆情報を収集する方法には、次のようなものがあります：
-
質問票・調査票
-
視聴者からのフィードバック
-
企業ブレーンストーミング
-
お客様からいただいたご意見をフィードバックしています。
-
お客様座談会
2.ベストプラクティスとして文書化計画を作成する
![]（https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_OpuMo68fDe86GImec/3a718347-9b9e-c209-a4ca-c923253bf756kaleidico_26mjgncm0wc_unsplash.jpg）
ドキュメンテーション計画を作成することで、プロジェクトの実施中に起こりうるボトルネックを予測することができます。製品ドキュメントの作成は難しいものです。ベストプラクティスは、ドキュメンテーション計画を作成することで、ドキュメンテーションプロセス中に出てくる問題を予見することができます。
ドキュメンテーションプランを作成するメリットとして、次のようなものがあります：
-
実施可能な項目 -既存のドキュメントを監査し、新製品のドキュメント計画で再利用可能な 該当する情報をサルベージします。
-
テンプレートやスタイルガイドの遵守 - 製品ドキュメントが新製品の場合、業界の声やスタイルにとどまることを確認し、ドキュメントが既存の製品に関連する場合、ブランドの継続性を確保するために現在のスタイルガイドとテンプレートを維持します。
-
ドキュメントプロセスツーリング - ドキュメントツールは、チームワークの継続性とドキュメント開発プロセスのより良い理解を保証しながら、製品ドキュメントプロセスを定義し、合理化することができます。
3.ベストプラクティスとして製品ドキュメントを簡素化する
2016年に、製品ドキュメントを読んでいるユーザーがどれくらいいるかという調査が行われました。その結果、【25％のユーザーが製品ドキュメントを読んでいない】ことが判明し、目を見張る結果となりました（https://academic.oup.com/iwc/article-abstract/28/1/27/2363584?redirectedFrom=fulltext&login=false）この調査では、エンドユーザーが製品ドキュメントを読んでいないのは、以下のようなことが一因であることが判明しました：
-
ユーザーはせっかちである** - ウェブを通じてすぐに情報が得られるようになったことで、ユーザーは問題に対する答えを見つけるのに、一般的に忍耐強くなくなった。オンラインまたはオフラインで製品ドキュメントを読むのは、特定の製品に必要な情報が大量にあるため、手間がかかることがあります。
-
スキップアヘッド症候群** - ユーザーは、必要な製品ドキュメントをスキップして、製品の使い方の基本に直行することがよくあります。ユーザーは、詳細な説明書を読むよりも、製品との対話を通じて、製品がどのように機能するかを学び、理解します。説明書はできるだけわかりやすく、情報量の多いものでなければなりません。
-
わかりにくいレイアウトや構造 - マニュアルは、理解しにくく、従いにくいフォーマットで書かれていることが多い。多くのユーザーは、製品ドキュメントが分かりにくい、あるいは質問と無関係であることに気づき、イライラしてマニュアルを読む気が失せてしまう。多くの場合、詳細な読者調査を行わず、ユーザーが何を必要としているのかを正しく理解できず、混乱しすぎて読み終えることができなくなったのです。
4.スクリーンショットや画像情報を含む
製品ドキュメントは、製品についてのストーリーを語るロードマップだと考えてください。スクリーンショットやその他のグラフィックで簡単に確認できる道筋(https://theideanest.ca/5-types-graphics/?doing_wp_cron=1666462401.5462460517883300781250)と、それぞれのグラフィックが他のグラフィックとどのように相互作用しているかを説明する。ユーザーが何を見ているのか、ある機能を有効にしたとき、それが製品にどのように反応し、次に何を期待するのか、明確に説明する。各グラフィックが目的を持っており、製品のワークフローが互いに連動していることを確認すること。
5.トピックをより正確に理解するために、クロスリンクを使用する。
製品ドキュメントを読むときに、クロスリンクは貴重な存在だと実感しています。ある機能やプロセスが何をするものかを理解することは、関連するトピックにクロスリンクするのに非常に役立ちます。さらに、関連するデータポイントを相互リンクさせることで、システムの相互作用やワークフローに関する全体像がより明確になります。
6.製品ドキュメントのKISS原則を忘れない。
ドキュメントを作成する際には、KISS（Keep It Simple, Stupid）の原則を使うことを忘れないようにしましょう。ただし、プロセスを徹底的に文書化することは重要ですが、文書が過剰になることはありません。また、ドキュメントの利用者は、特定の項目について特定の情報を探している場合があるので、KISSの原則に従うことで、ドキュメントのナビゲーションと理解をより容易にすることができます。
例えば、機能を説明するには簡単な表記で十分であり、おそらく本題への参照（クロスリンク）が必要であろう。ユーザーが自分のニーズに合った情報を簡単に探せるように、事実を整理し、強調し過ぎないようにします。ユーザーは、製品のあらゆる側面を読むことに興味がない場合もあります。
7.異なる学習スタイルに対応する
![]（https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_uCmkZTtLD7r6Elyg2/b2bb8ece-a1f8-5df4-d5ed-f4392f04d374radek_grzybowski_ebrtyyjwpry_unsplash.jpg）
人はそれぞれ【異なる学習スタイル】(https://www.ukessays.com/essays/social-work/people-learn-in-different-ways.php)を持っています。深い説明を好む人もいれば、グラフィックや視覚的な表現を好む人もいるかもしれません。しかし、集中して読むよりも、実際に手を動かすことでより深く学ぶユーザーもいます。
効果的で有益な製品ドキュメントを作成する際には、すべての学習スタイルを網羅するようにしましょう。例えば、スクリーンショット、グラフ、構造化されたテキスト、ビデオリンクなどのグラフィックを挿入することで、すべての学習スタイルが製品ドキュメントを理解できるようにすることができます。
8.オンボーディングコンテンツのパーソナライズと構造化
製品[聴衆の役割に基づいたドキュメント]をパーソナライズする(https://www.deanhouston.com/news/knowing-audience-document-right-document/).コンテンツをオンボーディングする際に、想定される対象者の役割に基づいて、異なるバージョンのドキュメントを作成します。例えば、管理者の質問は、パワーユーザーのドキュメントに関する質問とは関連性がない場合があります。
ドキュメントは、対象者の役割に合わせて少し異なるバージョンのドキュメントを作成することで、パーソナライゼーションの層を導入することができます。対象者の役割に応じてオンボーディングコンテンツを変更することで、ドキュメントにパーソナライゼーションの要素を持たせることができます。
9.特定の聴衆のために用語を明確に定義する
意図する読者に応じて、文書全体で使用される各用語の意味を説明することは、良い習慣です。読者が社内の人であれば、多少の説明でより複雑な用語を使用することができます。しかし、外部のユーザーがドキュメントにアクセスする場合、そのユーザーの専門知識を知る術はありません。
独自の用語や複雑な用語を明確に定義することで、社内のステークホルダーや社外のユーザーに対して、より良い、より効率的なコミュニケーションを確立します。
10.ユーザーフィードバックを収集する方法を提供する
ドキュメントのフィードバックは、ドキュメントの有効性についての強力な情報を提供します。リンクや "Like/Dislike "付きのシンプルなボタンを用意し、ドキュメントの品質に関する貴重な情報を収集しましょう。ユーザーのフィードバックを集める](https://www.k15t.com/rock-the-docs/documentation-guide/collaborative-writing/collect-user-feedback)ことで、ドキュメントを改良し、改善することができます。
11 フラットな構造を持つドキュメントは避ける
製品ドキュメントを作成する際には、ドキュメントが "フラットな構造" で書かれていないことを確認する。平坦な文章で埋め尽くされたドキュメントを読むのは手間がかかりますし、退屈になることもあります。また、議論されているトピックに関連した情報であれば、読者のドキュメントに対する興味は高まり、読者はすぐにそれを消費することができます。
選択した情報をハイライトしたり、動画、画像、リンクなどを統合することで、連続した平坦なテキストを分断し、より良いUXを提供します。また、ドキュメントコンテンツを「一口サイズ」の塊で提供することで、読者はより楽しい体験ができ、ドキュメントを読むことに抵抗を感じなくなるはずです。
12.SEOに配慮したドキュメントを作成する
![]（https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_JcQwSJ6c9VBPNDxiB/fc593084-5b7f-a9c5-63e1-9b310b83d086nisonco_pr_and_seo_yirdur6hivq_unsplash.jpg）
オンライン製品ドキュメントのベストプラクティスは、ドキュメントSEOフレンドリーであるスタイルで書かれていることを確認することです。ドキュメントがインターネット上の検索結果を最大化するように書かれていることを確認することです。クライアントは、ドキュメントを検索する必要があるかもしれません。ホスティングサイトへの明確なリンクがない場合、検索用語を入力することで、SEOフレンドリーであれば、応答はより速く、より簡潔です。
13.製品ドキュメントを常に最新に保つ
製品ドキュメントのメンテナンスは、主にオンラインでアクセスする場合、非常に重要です。製品の要件が変更されることがよくあり、オンライン・ドキュメントは新しい変更または更新を反映する必要があります。そのため、ユーザーマニュアルは最新のものに更新する必要があり、製品マニュアルの変更について顧客に通知し、認識してもらう必要があります。
14.ユーザーが製品ドキュメントを読まない可能性があることを理解する
2014年の調査]では、ユーザーが製品ドキュメントをすべて完全に読んでいない](https://academic.oup.com/iwc/article-abstract/28/1/27/2363584?redirectedFrom=fulltext&login=false)ことが判明しました。ドキュメントを読まない主な理由は以下の通りです：
-
製品ドキュメントが複雑すぎる
-
ドキュメントは、彼らの疑問を直接的に解決するものではありませんでした。
-
ドキュメントを読まなかったために、ユーザーが製品の多くの機能を使用しなかった。
-
ドキュメントを読むよりも、「体験学習」を好むユーザーが多かった。
15.動的コンテンツと静的コンテンツの両方を管理する
![]（https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_OgArkokVN075yERo3/b97f1b98-62a4-5b80-5e15-a008439ad625shubham_dhage_hatkch_piqm_unsplash.jpg）
製品ドキュメントは、アップデート、新機能、修正された内容、更新されたメンテナンスアラート、その他の項目で継続的に進化しています。このアップデートは、製品の要件に合わせて継続的に進化する、生きたドキュメントと見なされます。
静的コンテンツは、製品のライフサイクルを通じて変化しないデータをユーザーに提供します。静的コンテンツのアイデアは、ユーザー、特に新規ユーザーに、製品のライフサイクルの間、静的なままの情報を参照させることである。静的コンテンツは、豊富なドキュメントに不可欠ですが、通常、動的ドキュメントの後塵を拝することになります。
コンテンツが動的か静的かに分類されていると、ドキュメントセットの維持が容易になります。製品ライフサイクルのドキュメントは、ドキュメントが動的または静的に分類されている場合、より簡単に実装および検証することができます。新機能のアップデート（静的）や製品の詳細なアップデート（動的）のために、ドキュメントに小さな変更が加えられることがあります。
16.製品ドキュメントの可用性に関するベストプラクティス
ユーザーは必ずしも製品のドキュメントを読むわけではありませんが、必要な時にはすぐに欲しいものです。従来のドキュメントの提供方法は、印刷されたマニュアルを製品とともに持ち歩くものでした。しかし、デジタルでオンライン化された現代では、ドキュメントはウェブを通じて提供されることが多くなっています。
製品ドキュメントをどのように提供するにしても、アクセスポイントの確保は不可欠です。そのため、現在のドキュメントの提供方法は、以下のようなものが主流となっています：
-
多くの製品は、印刷されたマニュアルや "クイックスタート "ショートカットシートと一緒にパッケージされています。これらの文書は通常「一回限り」であり、簡単に配布することはできません。しかし、多くのマニュアルは、オプションでカプセル化されたPDFフォーマットで提供され、携帯性やオンデマンド印刷のオプションを促進します。
-
問題に対する答えを探すためにGoogleで検索するたびに、あなたはおそらくオンラインドキュメントの断片をつかんでいることでしょう。ウェブの出現は、エンドユーザーにとって、マニュアルや製品のドキュメント資料を印刷することに取って代わりました。オンラインドキュメントの利点は以下の通りです：
1.テレワーク - パンデミックが私たちに教えてくれたことのひとつは、自宅で仕事をすることで、オフィスと同じように生産性を上げることができるということです。
2.コラボレーション - すぐにアクセスできるオンラインドキュメントポータルがあれば、チームメンバーはその場で情報を共有でき、オフィスでは不可能なことが多いチームワークを生み出すことができます。
3.モバイルフレンドリー - iPadやスマートフォンなどのモバイルデバイスの登場により、日常的なやり取りは徐々にPCに取って代わられつつあります。スマートフォンでオンラインドキュメントに簡単にアクセスでき、ランチ中のお気に入りのカフェでも、製品に関する煩わしい問題を簡単に調査することができます。