新製品ドキュメントを立ち上げる際の15のベストプラクティス

新製品を発売する際のベストプラクティスのひとつに、製品リリースの準備を行うことがある。特に、製品発売をサポートする新しい製品ドキュメンテーションの作成に注力したい。これがなければ、潜在的なユーザーは、新しいソリューションを購入した後に参照ポイントとして使用する関連情報を得られません。

より広範なマーケティング戦略の一環として、プロダクトマネージャーやプロダクトチームのメンバーは、次回のローンチ時に従うべき15のベストプラクティスについて学び、読み進めてください。読み終わる頃には、これらの重要な文書を最高のものにする方法を理解していることでしょう！

どのような製品ドキュメントを意識すべきか？

ベストプラクティスのリストに入る前に、どのような種類の製品ドキュメントが存在するのか、そしてそれぞれの意図するゴールを明確にしておきましょう：

• 製品要件文書** - 製品要件文書またはPRDは、企業がリリース基準を満たすために使用される内部製品文書の一種です。これは、最終的な製品がユーザーのために何を達成すべきかを説明するもので、具体的な方法や場所は定義されていません。そして、開発チームとテストチームは、PRDを使用して、リリース準備の整った製品をビジネス要件に合わせます。PRDはソフトウェア製品では一般的ですが、あらゆる製品ロードマップに準拠するために使用できます。

• ユーザーガイドとセルフサービス** - 製品チームは、製品の発売を成功させるためのソフト的な前提条件として、ユーザーガイドを作成する必要があります。その名が示すように、これはエンドユーザーが新製品を使用する際の生産性を最大化するための文書です。ここでは、顧客が最大の価値を得られるように、ユーザー向けの主要な機能をすべて説明する必要がある。さらに良いのは、これらのガイドをセルフサービスの外部ナレッジベースで共有することで、顧客が自らヘルプできるようにすることだ！

• セットアップ、インストール、コンフィギュレーションガイド** - 製品のセットアップ、インストール、コンフィギュレーションが必要な場合、これも作成する必要がある技術的な製品文書資産です。目標は、ユーザーの視点と、該当する場合は開発者の視点から、これらのプロセスを明確に説明することです。ソフトウェアドキュメントの場合、複数のデバイスや複数のオペレーティングシステムにまたがる可能性があります。

• マーケティング資産** - これが製品ドキュメントだとは思わないかもしれませんが、そうなのです！マーケティング資料のスタイルやフォーマットは、顧客が製品を使い始める前に、製品をどのように認識するかに影響します。良い印象を与えることが重要です。製品の新機能をどのように説明していますか？どのような読者を想定しているのか？誰かの仕事や私生活をどのように改善するのか？これは、あなたや広く会社が顧客に考えてもらいたいことなのか？

新製品をリリースするときのドキュメンテーションのベストプラクティス15

製品ドキュメントに関する入門書の次は、ベストプラクティスのリストだ：

1：スタートを切る！

製品ドキュメンテーションを始めたばかりですか？素晴らしい！さあ、ためらわずに始めてください。多くの人は、製品ドキュメントを完璧なものにしようとします。完璧さを追求するあまり、その作業に麻痺してしまうのです。あなたのサービスの基本コンセプトを紙に書き出し、次に顧客に印象づけるための準備に集中しましょう。リリースノートは、基本を定義するのに適している。

2: シンプルに、バカに...

KISSと略されるこの原則は、60年代のアメリカ海軍で（ダジャレで）実際に使われた設計原則です。同じルールが製品ドキュメントにも適用できます。自問してみよう："必要な情報を、どのような層にも理解できるように伝えるにはどうしたらいいか？"

これを製品ビジョンに適用するには、フレッシュ・キンケイドの可読性テストをお勧めする。Grammarlyのようなコンテンツ評価ツールは、一般的にこのシステムを使用しています。これは、書かれたコンテンツを分析する際に、米国の高校の成績に相当するスコアを与えます。コンテンツの解釈可能性を最大化するために、就学年齢として8級または13～14歳を目指しましょう。

その3：ターゲットオーディエンスを理解する

さて、あなたはシンプルな文章を書き始めました。例えば、ソフトウェア会社と自動車メーカーでは、ターゲットとする読者は大きく異なります。

例えば、若い学生が段階的にコンセプトを学ぶためのシンプルなツールに焦点を当てた教育ソフトウェア会社を想像してみよう。あなたの頭の中では、「つまり、ターゲット・オーディエンスは子供たちなんだな」と最初に思うかもしれない。そうとは限らない。ターゲットとなる読者は、幼稚園や高校のソフトウェア・パッケージの主要な意思決定者、たとえばIT部門や調達担当の内部関係者です。二次的な読者層は若い生徒たちであり、彼らは教育用ソフトウェアを実際に目にし、学校での利用を提唱するかもしれない。

その4：ストーリーよりも価値に焦点を当てる

誰もが良いストーリーを好むが、顧客はあなたの製品がどのような価値を提供するのかを知りたがっている。タスクやワークフローを簡素化するのか？競合他社はオンラインのみだが、御社の製品はオフラインでも利用できるのか？あなたの製品は、他の競合製品よりも早くそのことを実現できますか？

このような例が、特定の製品における独自のセールスポイント（USP）となる。USPに焦点を当て、それを強調することで、見込み客を誘惑し、市場シェアを拡大するために、他社にはないものをあなたが持っていることを理解させることができる。USPは、同業他社との競合分析を行うことで定義することができます。

その5：フォーマットを活用して情報を分類する

ドキュメントは大きなテキストの塊であってはならない。これでは、エンドユーザーが目を通し、ナビゲートするのは難しい。その代わりに、見出しやその他のフォーマットオプションを使ってテキストを分割しましょう。

H1見出しは、ページをクリックしたときに最初に目に入る見出しです。H2とH3は、そのページで扱われているトピックの小見出しとして機能します。箇条書きや番号付きリストを使って、読みやすいようにコンテンツをまとめることができ、SEOとSERPSの可視性を向上させるリッチスニペットの対象にもなります。Markdownの知識があれば、DocsieのようなオンラインのMarkdownエディタが、あなたの製品ドキュメントを際立たせるための数多くのフォーマットオプションを提供します！

6: ドキュメントを一元管理する

技術的なドキュメントをリリースした後に、長期的なモニタリングや管理がいかに複雑になるかを思い知ることほど、最悪なことはありません。ドキュメントの更新が必要になったらどうしよう？元のドキュメントはどこにあるのか、新しいバージョンのページをどうやってリリースすればいいのか。このコンテンツを他の言語に翻訳するのはどうだろう？

このベストプラクティスには、Docsieを挙げなければならない！オンライン・ナレッジベース・ソフトウェアを使えば、ドキュメントをクラウド上の一元管理された場所に保存することができる。ここから、従業員や請負業者がコンテンツについて共同作業を行い、発売準備の完了を早めることができます。Docsieは、ナレッジの更新が必要な場合のバージョン管理、グローバルコンテンツのローカライゼーションのための言語管理を提供します。グローバルコンテンツの作成を自動化したい場合は、バックグラウンドで正確に翻訳してくれる、AI言語翻訳ボットもご利用いただけます！

その7：百聞は一見に如かず

長ったらしい説明文を書くのは効果的ですが、エンドユーザーに教えるには効果的ではありません。その代わり、絵や、動く絵で見せましょう！

各製品ドキュメントに付随するビデオチュートリアルを作成してみてください。そうすれば、読むことを好む人はテキストに目を通し、視覚学習者はビデオを選ぶことができる。同様に、GIFや画像は、特にソフトウェアのユーザーインターフェース（UI）内で、ユーザーが何を参照しているかを確認するのに役立ちます。さまざまな学習スタイルに対応することは、より幅広いユーザーを支援することにつながり、あなたの製品の可能性を広げることになります。

8：学習 vs 目標 vs 理解 vs 情報

ドキュメントの意図は何か？ユーザーの意図は、オンライン製品のドキュメントでは非常に重要であり、ユーザージャーニーのセクションにコンテンツを合わせるのに役立ちます。

• 学習** - 初めて見るものであれば、学習コンテンツは基本原則を理解するのに役立ちます。

• このタイプのコンテンツは、「DocsieからPDFファイルをエクスポートする方法」のように、ユーザーがゴールに到達するのを助ける必要があります。最後には、ユーザーはPDFをエクスポートするというゴールを達成することになります。

• このタイプのコンテンツは、「DocsieからPDFファイルをエクスポートする方法」のように、ユーザーがゴールに到達するのを助けるものです。

• 情報** - 質問があり、具体的な答えが欲しい場合です。これは、特定の場所のリアルタイムの天気や、「ツリーハウスの作り方」のビデオなど、簡単なものです。

9：検索可能にする

このドキュメントを公開する前に、ユーザーはテキスト内のキーワードを検索できますか？

もしそうでなければ、これをサポートするドキュメント・プラットフォームを見つけることをお勧めします。ユーザーにとって一番の阻害要因は、情報をすぐに見つけられないことです。これは、フラストレーションや、情報が見つからない場合のカスタマーサポートチームの作業負荷の増加、そして全体的なカスタマーエクスペリエンス（CX）の低下につながります。Docsieはグローバル検索をサポートしています！

その10：実用的なフィードバックを集める準備

ドキュメンテーションのライターは、コンテンツの初期バージョンは将来的に変更されるという事実を認識しているはずです。一般の人がドキュメントを見るまでは、ライターはお互いにアイデアやフィードバックを出し合うことしかできません。

ドキュメントが公開された後は、フィードバックの収集が不可欠です。そうすれば、ライターが実際の顧客やエンドユーザーの声を聞くことで、内容に関連する否定的な意見を肯定的な意見に変えることができます。他を探す必要はありません。Docsieのフィードバック収集機能をご活用ください！

11: トピックに言及する際にページへのリンクを貼る

このベストプラクティスは、SEOとウェブページのナビゲーショナル構造にも関わってきます。

キーワードに言及するとき、そのキーワードにリンクしていますか？他のトピックを参照するとき、ユーザーは現在のページの文脈で他のトピックをまだ理解していないかもしれません。そうすることで、読者はメイントピックについて学びながら、サブトピックを素早く参照することができます。

12: あいまいさではなく、明確さ

製品ドキュメントを書くときは、曖昧さよりも明確さを優先しましょう。曖昧さを避けるために平易な英語を使うことができますが、これは基本的に、絶対に必要な場合を除き、専門用語や技術用語を避けることを意味します。専門用語を使う場合は、その直後に一般読者のために簡略化した定義を書くようにしてください。

"このドキュメントの情報を理解するのに問題がある場合は、カスタマーサポートの担当者に、この理解困難を克服する方法について追加の詳細をお尋ねください。"

"表示された内容が理解しにくい場合は、カスタマーサポートに助けを求めることができます。"

どちらを選びますか？

13: テンプレートを作成してドキュメントを速くする

新製品の発売では、ドキュメントの作成プロセスを迅速化することが優先されます。これにはテンプレートを使います。

テンプレートは、ページの再利用可能な構造を定義し、ライターがより速く、より一貫性のあるコンテンツを作成するのに役立ちます。また、異なるコンテンツスタイル用に複数のテンプレートを作成することもできます。Docsieでは、カスタムテンプレートのサポートに加え、あらかじめ用意されたテンプレートをご利用いただけます。

14: ライターの声のトーンとスタイルガイドを確立する

ライターにはどれくらいの自由裁量権がありますか？

製品ドキュメントの最終ドラフトに一貫性がなくなる可能性があるからです。そのためには、トーン・オブ・ボイス（ToV）ガイドラインやコンテンツ・ライティング・スタイル・ガイドが有効です。

• トーン・オブ・ボイス** - 何を言ったかではなく、どのように言ったかです。ライターにフォーマルできちんとした表現を求めるのか、それともカジュアルな表現を求めるのか。ユーモアは許されるのか、それとも深刻な話題なのか。より会話的で情熱的な内容なのか、それとも冷徹な事実を求めるのか。

• スタイルガイドライン** - この文書は、会社のミッションステートメントを説明し、ライターがページを書いたりフォーマットするときに、どのように一定のスタイルに従うことができるかを説明することができます。ここに含まれるのは、ターゲットとするユーザーペルソナ、メタディスクリプションのようなSEOの原則、引用や参照の要件（シカゴ、APスタイルなど）です。

15: 強力なナレッジベース・プラットフォームを使ってドキュメントを公開する

もし、あなたの書いたコンテンツが燃料だとしたら、メッセージを伝えるためにどのような手段を使っていますか？

強力なナレッジ・ベース・プラットフォームは、質の高い製品ドキュメントを展開するために不可欠です。文書が利用できなくなったり、ページの読み込みが遅くなったりすれば、文書作成に費やした労力はすべて無駄になってしまいます。

既存のドキュメントのインポート、社内チームとのコンテンツ・コラボレーション、新規ドキュメントの作成と編集、動的なリッチ・コンテンツの埋め込み、ナレッジ・サイトへの公開などの機能が必要です。また、長期的なドキュメントの更新には、グローバルなコンテンツのローカライゼーションのための言語管理や自動翻訳と並んで、バージョン管理も不可欠です。

ご想像の通りです！これらの機能はすべてDocsieで利用可能です。まずは無料プランからお試しください！