新製品リリース時に欠かせない文書作成のベストプラクティス¶

新製品をローンチする際のベストプラクティスの一つが、製品リリースの準備作業です。特に重要なのは、製品ローンチをサポートする新しい製品ドキュメントの作成です。これがなければ、潜在ユーザーは購入後の参考情報を得ることができません。

マーケティング戦略の一環として、プロダクトマネージャーやプロダクトチームは次のローンチに向けて守るべき15のベストプラクティスについて、ぜひこの記事を読み進めてください。最後まで読めば、これらの重要な文書を最高のものにする方法が理解できるでしょう！

どのような種類の製品ドキュメントがあるのか？¶

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

• 製品要件ドキュメント – 製品要件ドキュメント（PRD）は、企業がリリース基準を満たすために使用する社内向け製品ドキュメントです。最終製品がユーザーのために何を達成すべきかを、「どのように」「どこで」という具体的な定義なしに説明します。開発チームとテストチームはPRDを使用して、製品をビジネス要件に合わせてリリースの準備をします。PRDはソフトウェア製品でよく使われますが、あらゆる製品ロードマップに沿うために使用できます。

• ユーザーガイドとセルフサービス – 製品チームは成功するローンチのための必須条件として、ユーザーガイドを作成する必要があります。名前が示す通り、これはエンドユーザーが新製品を使用する際の生産性を最大化するためのドキュメントです。主要なユーザー向け機能をすべて詳しく説明し、顧客が最大限の価値を得られるようにします。さらに良いのは、これらのガイドを外部のナレッジベースでセルフサービス形式で共有し、顧客が自分で問題を解決できるようにすることです！

• セットアップ、インストール、設定ガイド – 製品にセットアップ、インストール、設定が必要な場合、これは作成すべきもう一つの技術ドキュメント資産です。目標はユーザーの視点から、そして該当する場合は開発者の視点からも、これらのプロセスを明確に説明することです。ソフトウェアドキュメントの場合、複数のデバイスや複数のオペレーティングシステムにまたがる可能性があります。これは念頭に置いておくべきことです。

• マーケティング資産 – これを製品ドキュメントと考えないかもしれませんが、実際にはそうです！マーケティング資産のスタイルや形式は、顧客が製品を使い始める前に、その製品をどう認識するかに影響します。良い印象を与えることは極めて重要です。新機能をどのように説明していますか？どのようなユーザーを対象としていますか？これによって仕事や私生活がどのように向上するでしょうか？これはあなたや会社全体が顧客に持ってほしいと考えるイメージですか？

新製品リリース時のドキュメント作成に関する15のベストプラクティス¶

製品ドキュメントの基本を理解したところで、次はベストプラクティスのリストです：

1: まずは始めること！¶

製品ドキュメントを始めたばかりですか？素晴らしい！躊躇せずに始めましょう。多くの人は製品ドキュメントを「完璧」にしたいと考え、完璧を追求するあまり、タスクに麻痺してしまいます。まずはサービスの基本コンセプトを紙に書き出し、顧客に印象づけるための整理に集中しましょう。リリースノートは基本を定義するのに最適で、そこから内容を広げていくことができます。

2: シンプルに、愚かにならないように…¶

KISSと略される「Keep it Simple, Stupid」は、60年代の米海軍で流行した実際のデザイン原則です。同じルールを製品ドキュメントにも適用できます。自問してみてください：「必要な情報をすべての層の人が理解できる方法で伝えるにはどうすればよいか？」

この原則を製品ビジョンに適用するには、Flesch-Kincaidの読みやすさテストをお勧めします。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のエクスポートです。

• 理解 – 研究とも呼ばれ、すでに主題について実用的な知識を持っているが、より深く理解したいと考えているお客様向けです。

• 情報 – 主体は質問を持ち、特定の回答を求めています。これは、特定の場所のリアルタイムの天気や、「ツリーハウスの作り方」についてのビデオのように簡単なものかもしれません。

9: 検索可能にする¶

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

できない場合は、これをサポートするドキュメントプラットフォームを見つけることをお勧めします。ユーザーにとって最大の抑止力は、情報をすぐに見つけられないことです。これにより、情報が見つからない場合は顧客サポートチームの作業負荷が増加し、全体的な顧客体験（CX）にマイナスの影響を与えます。ちなみに、Docsieはグローバル検索をサポートしています！

10: 実用的なフィードバックを収集する準備¶

ドキュメントライターは、コンテンツの初期バージョンが後々変更される可能性が高いことを認識しているでしょう。一般の人がドキュメントを見るまでは、ライターは互いにアイデアやフィードバックを交換するしかありません。

ドキュメントが公開されたら、フィードバック収集の仕組みを整えることが不可欠だと考えています。これにより、ライターは実際の顧客やエンドユーザーの声を聞くことで、コンテンツ関連のネガティブな点をポジティブに変えることができます。他を探す必要はありません。Docsieでフィードバック収集機能を活用できます！

11: トピックに言及する際はページにリンクする¶

このベストプラクティスはSEOとウェブページのナビゲーション構造に関連しています。

キーワードに言及するとき、それにリンクしていますか？他のトピックに言及する場合、ユーザーは現在のページのコンテキストで他のトピックをまだ理解していない可能性があります。ドキュメントが存在する言及されたトピックすべてにリンクするべきです。これにより、読者はメイントピックについて学びながら、サブトピックを素早く参照できます。

12: 明確さ、曖昧さを避ける¶

製品ドキュメントを書く際は、曖昧さよりも明確さが重要です。曖昧さを避けるために平易な言葉を使用できます。つまり、絶対に必要でない限り、専門用語や技術的な言葉を避けるということです。専門用語を使用する場合は、素人の読者のために、すぐ後に簡略化された定義を書くようにしましょう。

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

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

どちらが好ましいですか？

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

新製品のローンチに伴い、ドキュメント作成プロセスを迅速化することが優先事項です。テンプレートを使用してこれを実現できます。

テンプレートはページの再利用可能な構造を定義し、ライターがより速く、より一貫性を持ってコンテンツを作成するのに役立ちます。また、異なるコンテンツスタイル用に複数のテンプレートを作成することもできます。Docsieでは、使用できる様々な事前構築されたテンプレートとカスタムテンプレートのサポートを提供しています。

14: ライターのためのトーン・オブ・ボイスとスタイルガイドを確立する¶

ライターにどれだけの自由を与えていますか？

ライターを統制することは重要です。それがないと製品ドキュメントの最終稿に一貫性がなくなる可能性があります。これはトーン・オブ・ボイス（ToV）ガイドラインとコンテンツ作成スタイルガイドで実現できます。

• トーン・オブ・ボイス – 何を言ったかではなく…どのように言ったかが重要です。ライターにフォーマルで適切な表現を求めるか、よりカジュアルな表現を求めるか？ユーモアは許容されるか、それともトピックはより真面目なものか？あなたのコンテンツは会話的で情熱的か、それとも冷静な事実だけを求めるか？

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

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

あなたの書いたコンテンツが燃料なら、どんな乗り物でメッセージを届けますか？

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

既存のドキュメントをインポートし、社内チームとコンテンツで協力し、新しいドキュメントを作成・編集し、動的なリッチコンテンツを埋め込み、ナレッジサイトに公開する機能が必要です。バージョン管理は長期的なドキュメント更新にも不可欠であり、グローバルコンテンツのローカライズのための言語管理と自動翻訳も重要です。

ご想像の通り！これらの機能はすべてDocsieで利用できます。これらの機能を試してみたい方は、無料プランで始めてみましょう！