Top 15 Best Practices for Product Release Documentation

このミスから顧客の視点で製品を見ることの重要性を学びました。その時「目からウロコ」という感覚でした。顧客の課題を解決する製品を提供し、それを専門的な製品ドキュメントでサポートすれば、成功間違いないのです。

また、プロフェッショナルで見栄えが良く、読みやすい製品ドキュメントを作ることは簡単ではないことも分かりました。しかし、適切に作成された製品ドキュメントは、満足している顧客をさらに感動させ、最終的に売上を向上させることができます。

プロフェッショナルな製品ドキュメント作成のベストプラクティスとは？¶

これらのベストプラクティスは、見栄えが良く、情報が豊富で使いやすい製品ドキュメントを作成します。これらのガイドラインに従うことで、良い顧客を素晴らしい顧客に変える製品ドキュメントを提供できます。そして素晴らしい顧客は最終的に企業の収益増加に貢献し、製品ドキュメントはカスタマーエクスペリエンスの重要な要素となります。

1. ターゲットとなる読者を理解し、彼らが求めるものを提供する¶

読者の期待を知ることは不可欠です。例えば、製品ドキュメントは管理者向けなのか、エンドユーザー向けなのか。対象読者の範囲によって、管理者向けには技術的な内容を、エンドユーザー向けには明確に定義された用語や手順で書く必要があります。

プロフェッショナルな製品ドキュメントを作成するベストプラクティスとして、管理者レベルやエンドユーザーレベルでの顧客の期待を理解することが挙げられます。読者情報を収集する方法としては以下があります：

• アンケートと調査
• 想定される読者からのフィードバック
• 社内ブレインストーミング
• 一般的な顧客意見のフィードバック
• 顧客との円卓会議

2. ドキュメント計画を作成する¶

ドキュメント計画を作成することで、プロジェクト実施中に発生する可能性のあるボトルネックを予測できます。製品ドキュメントの作成は困難な場合があり、ドキュメント計画を作成することでドキュメント作成プロセス中に発生する問題を予見するのに役立ちます。

ドキュメント計画作成の利点には次のようなものがあります：

• 実行可能な項目 - 既存のドキュメントを監査し、新しい製品ドキュメント計画で再利用できる適用可能な情報を救出すること。

• テンプレートとスタイルガイドの遵守 - 新製品のドキュメントであれば業界の声調やスタイルに合わせ、既存製品のドキュメントであれば現在のスタイルガイドやテンプレートを維持してブランドの継続性を確保すること。

• ドキュメントプロセスツールの文書化 - ドキュメントツールは製品ドキュメントプロセスを定義・合理化し、チームワークの継続性とドキュメント開発プロセスの理解を確保します。

3. 製品ドキュメントをシンプルにする¶

2016年に製品ドキュメントを読むユーザーの割合を調査した結果、ユーザーの25％しか製品ドキュメントを読まないことが分かりました。この調査では、エンドユーザーがドキュメントを読まない理由として以下が挙げられています：

• ユーザーは焦りがち - ウェブによる即時情報の普及により、ユーザーは問題の答えを見つけるのに以前より忍耐力がなくなっています。オンラインやオフラインで製品ドキュメントを読むことは、特定の製品に必要な膨大な情報量のため面倒に感じられます。

• 飛ばし読み症候群 - ユーザーは詳細な指示を読むより、製品の使い方の基本へ直接進むことが多いです。ユーザーは詳細な説明を読むよりも、製品との対話を通じて学び理解します。指示はできるだけ明確で情報豊富である必要があります。

• 紛らわしいレイアウトと構造 - マニュアルは理解しにくく、フォローしにくい形式で書かれていることがよくあります。多くのユーザーは製品ドキュメントが混乱を招くか、質問に関連性がないと感じ、マニュアルを読むことに挫折してしまいます。多くの場合、企業は詳細な読者調査を行わず、ユーザーのニーズを正しく理解していないため、読者は混乱して読み終えられません。

4. スクリーンショットとグラフィカルな情報を含める¶

製品ドキュメントを製品についての物語を伝えるロードマップと考えましょう。顧客をスクリーンショットやその他のグラフィックで簡単に識別できる道筋に導き、それぞれのグラフィックがどのように相互作用するかを説明します。ユーザーが見ているものや、機能が有効になったときにどのように製品に反応するか、次に何が起こるのかを明確に説明します。各グラフィックに目的があり、製品のワークフローが互いに連携していることを確認しましょう。

5. より明確なトピック理解のためにクロスリンクを使用する¶

製品ドキュメントを読む際にクロスリンクは非常に価値があります。機能やプロセスが何をするのかを理解するために、関連するトピックへのクロスリンクが大いに役立ちます。関連するデータポイントをクロスリンクすることで、システムの相互作用とワークフローに関する全体像がより明確になります。

6. 製品ドキュメントにはKISSの原則を忘れない¶

ドキュメントを作成する際は、KISS（Keep It Simple, Stupid）原則を覚えておきましょう。プロセスを徹底的に文書化することは重要ですが、過度に詳細にしすぎないようにします。ドキュメントのユーザーは特定の項目に関する特定の情報を探している可能性があるため、KISS原則を守ることでナビゲーションとドキュメントの理解がより簡単になります。

例えば、機能を説明するには、主要な主題への参照（クロスリンク）を含めた簡単な説明で十分な場合があります。ユーザーが自分のニーズに関連する情報を簡単に検索できるように、事実をわかりやすく、過度に説明しないようにしましょう。ユーザーは製品のあらゆる側面を読むことに興味がない場合があります。

7. 異なる学習スタイルに対応する¶

人によって学習スタイルは異なります。詳細な説明を好む人もいれば、グラフィックや視覚的表現を好む人もいます。また、集中して読むよりも実践的な関与を通じて学ぶユーザーもいます。

効果的で情報豊富な製品ドキュメントを作成する際は、すべての学習スタイルを包含するようにしましょう。スクリーンショットやグラフ、構造化されたテキスト、ビデオリンクなどのグラフィックを挿入することで、あらゆる学習スタイルが製品ドキュメントを理解できるようになります。

8. オンボーディングコンテンツをパーソナライズして構造化する¶

読者の役割に基づいて製品ドキュメントをパーソナライズしましょう。コンテンツをオンボーディングする際、想定読者の役割に基づいてドキュメントの異なるバージョンを作成します。例えば、管理者の質問はパワーユーザーのドキュメントに関する質問とは関連性がない場合があります。

読者の役割に基づいてわずかに異なるバージョンのドキュメントを作成することで、パーソナライゼーションの要素を導入できます。読者の役割に基づいてオンボーディングコンテンツを調整することで、ドキュメントにパーソナライゼーションの要素を与えます。

9. 特定の読者向けに用語を明確に定義する¶

対象となる読者に応じて、ドキュメント全体で使用される各用語の意味を説明することが良い習慣です。読者が社内の場合は、ある程度の説明付きでより複雑な用語を使用できます。しかし、外部ユーザーがドキュメントにアクセスする場合、ユーザーの専門知識を知る方法はありません。

独自または複雑な用語を明確に定義することで、すべての社内関係者と外部ユーザーにとって、より良くより効率的なコミュニケーションが確立されます。

10. ユーザーフィードバックを収集する方法を提供する¶

ドキュメントのフィードバックは、ドキュメントの有効性に関する強力な情報を提供します。「いいね/よくない」のような簡単なボタンやリンクを設けて、ドキュメントの質に関する貴重な情報を収集しましょう。ユーザーフィードバックを収集することで、ドキュメントを改良・改善できます。

11. フラットな構造のドキュメントを避ける¶

製品ドキュメントを作成する際は、「フラット構造」で書かれていないことを確認しましょう。フラットなテキストだけのドキュメントを読むのは骨の折れる作業であり、退屈になることもあります。また、議論されているトピックに関連する情報であれば、読者はすぐに消化できるため、ドキュメントへの関心が高まります。

選択した情報を強調したり、ビデオ、画像、リンクなどを統合したりして、連続的なフラットテキストを分割し、より良いUXを提供しましょう。さらに、ドキュメントの内容を「一口サイズ」のチャンクで提供することで、読者はより楽しい体験をし、ドキュメントを読むことに抵抗を感じなくなります。

12. SEOに優れたドキュメントを作成する¶

オンライン製品ドキュメントのベストプラクティスは、ドキュメントがSEOに対応したスタイルで書かれていることを確認することです。インターネット全体でドキュメントの検索結果を最大化するスタイルでドキュメントを作成します。クライアントがドキュメントを検索する必要があり、ホスティングサイトへの明示的なリンクがない場合、検索語を入力することで、SEO対応のドキュメントならより迅速で簡潔な回答が得られます。

13. 製品ドキュメントを最新の状態に保つ¶

製品ドキュメントのメンテナンスは、特にオンラインでアクセスする場合、非常に重要です。多くの場合、製品の要件が変更され、オンラインドキュメントには新しい変更や更新が反映されている必要があります。そのため、ユーザードキュメントは最新の状態に保ち、最近の更新のために更新し、顧客に製品ドキュメントの変更を通知して認識させる必要があります。

14. ユーザーが製品ドキュメントを読まない可能性を理解する¶

2014年の調査では、ユーザーが製品ドキュメントを完全に読まないことが分かりました。ドキュメントを読まない主な理由は：

• 製品ドキュメントが過度に複雑
• ドキュメントが質問に直接対応していない
• ドキュメントを読まないため、多くの製品機能を使用しない
• 多くのユーザーはドキュメントを読むよりも「ハンズオン」学習を好む

15. 動的コンテンツと静的コンテンツの両方を管理する¶

製品ドキュメントは、更新、新機能、修正コンテンツ、メンテナンスアラートの更新などで継続的に進化します。この更新は、製品の要件に合わせて継続的に進化する生きた文書と考えられています。

静的コンテンツは、製品のライフサイクルを通じて変更されないデータをユーザーに提供します。静的コンテンツの目的は、特に新しいユーザーに、製品のライフサイクル全体を通じて静的なままである情報を提供することです。静的コンテンツは豊かなドキュメントにとって重要ですが、通常は動的ドキュメントに比べると二次的な位置づけです。

コンテンツを動的または静的に分類すると、ドキュメントセットの維持が容易になります。製品ライフサイクルのドキュメントは、動的または静的として分類されていると、より簡単に実装および検証できます。新機能の更新（静的）や詳細な製品更新（動的）のためにドキュメントにわずかな変更がある場合があります。

16. 製品ドキュメントの可用性のベストプラクティス¶

ユーザーは必ずしも多くの製品ドキュメントを読まないかもしれませんが、必要なときにはすぐに入手したいと考えています。従来のドキュメントの配信方法は、製品と一緒に印刷されたマニュアルを提供することでした。しかし、今日のデジタルオンライン世界では、ドキュメントはウェブを通じて配信されることが多いです。

製品ドキュメントがどのように配信されるかに関わらず、すぐにアクセスできるポイントを用意することが重要です。今日のドキュメント提供の主な方法は以下の通りです：

• オフラインドキュメント - 多くの製品は印刷されたマニュアルや「クイックスタート」ショートカットシートと一緒に梱包されています。これらのドキュメントは通常「一回限り」のものであり、簡単に配布できません。ただし、多くのマニュアルはPDF形式でオプションとして提供され、携帯性や必要に応じて印刷するオプションを促進しています。

• オンラインドキュメント - Googleで問題の答えを検索するたびに、おそらくオンラインドキュメントの一部を取得しています。ウェブの普及により、エンドユーザー向けのマニュアルや製品ドキュメント資料の印刷が取って代わられました。オンラインドキュメントの利点のいくつかは：

• テレワーク - パンデミックから学んだことの1つは、特に質問がオンラインドキュメントで回答される場合、在宅勤務はオフィスと同じくらい生産的になり得るということです。

• コラボレーション - アクセスしやすいオンラインドキュメントポータルがあれば、チームメンバーはその場で情報を共有し、オフィスでは不可能なことが多いチームワークを生み出すことができます。

• モバイル対応 - iPadやスマートフォンなどのモバイルデバイスの普及により、日常的な操作にはPCが徐々に取って代わられています。スマートフォンでオンラインドキュメントに簡単にアクセスでき、気になる製品の問題もランチ中にお気に入りのカフェで簡単に調査できます。