魅力的な製品ドキュメントの作り方

Avatar of Author
Tal F.
on July 22, 2021 · · filed under Product Documentation Product Management Best Practices Product Documentation Tutorials

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_fnrc6e2hqBPbGE5DG/boo_NbQ7i8LYu6f7q4rnn/13a8cb93-d20f-41ad-1e5e-6e888f610ea7corinne_kutz_tMI2__r5Nfo_unsplash.jpg)

多くのテクノロジー系SaaS企業が、製品ドキュメント(ユーザーマニュアル、ユーザーガイド、チュートリアル)を開発し、消費者に配布するプロセスに苦労しています。

このような事態は、マニュアルの適切な取り扱いや作成方法、さらにはマニュアルの責任者についての知識やプロセスが欠如していることが原因であることが少なくありません。

道具やソフトウェアがこの世に存在する限り、その使い方、開発、機能、構造などを効果的に相手に伝えるための効果的なコミュニケーションが必要です。なぜだろうと考えてみると、答えは簡単です。テクニカルコミュニケーションのスキルは、情報を収集し、聴衆が製品や技術をより効果的に理解できるようにするために重要であるという事実があるからです。

現実の世界でのコミュニケーションは、音声やボディランゲージ、感情表現によって行われますが、仮想世界でのテクニカルコミュニケーションは、技術的な製品ドキュメントを通じて行われます!

技術製品ドキュメントの唯一の目的は、製品や技術の動作力学やアーキテクチャをユーザーが理解するのを促進することです。新入社員やユーザー、顧客など、作業方法を知る必要のある人たちのための「使い方」ハンドブックというよりは、製品のナット&ボルトを徹底的に説明するものです!

プロダクトマネージャーは、洗練された製品ドキュメントを作成、管理、発行、維持するためのチームを育成する責任を負うことが義務です。

プロダクトマネージャーなら誰でも、自分の部署で次のようなことを言ったり聞いたりしたことがあるのではないでしょうか:"製品ドキュメントはプロダクトオーナーの義務の一要素である"、"各開発チームは自分たちのアプリをドキュメント化すべきだ"、"機能がデプロイされたが、マニュアルは更新されているか?"、もっとひどいのは、"技術ドキュメントに誤りがある"。

明らかに、技術的な製品のドキュメントは、それが見えるようにストレートとして少し不可解かもしれません!前項のセリフを個人が解決しようとしたり、議論したりしているうちに、マニュアルやチュートリアルが劣化してしまい、「製品・会社」のイメージを悪くしてしまうのです。

同じような問題を経験されている方のために、製品ドキュメントを最適化するために実施すべき手順をご紹介します。

プロダクトドキュメントの目的は何ですか?

技術的な製品やサービスの製品ドキュメントといえば、それを説明する情報やそれに関連するデータのことを指します。

技術文書、すなわち製品ドキュメントは、聴衆や顧客が製品を活用し、読み、理解し、活用することを支援するためのものである。製品ドキュメントの多くは、もちろん、エンジニアリング、医療、IT、マーケティングなど多様な領域で制作されています。

技術的な製品ドキュメントを作成することで、ユーザーは製品について理解し、複雑な手続きなしに製品を使用することができます。

もうひとつ、テクニカルドキュメントは顧客支援に不可欠であり、企業のブランディングと信頼に大きく貢献するものです。最も困っているとき、ユーザーは技術文書を検索します。聴衆は、プロセスを学び、問題に対処するためにあなたの製品を使用します。

つまり、検索機能を備えた動的な製品ドキュメントを徹底的かつ包括的に作成することが非常に重要なのです。

異なる製品のドキュメントはどうなっているのか

このセクションでは、顧客や取引先に対してどのような製品ドキュメントが必要かを確認することができます。

製品ドキュメントの種類は、ユースケースやユーザーニーズの違いにより、さまざまなニーズに対応したものがあります:

製品ユーザードキュメント: ユーザーマニュアル、ハウツーガイド、チュートリアル、FAQ、リリースノート、トレーニングマニュアル、および操作手順から構成されています。

企業文書: 調査結果調査対象1000社のうち、10社中8社以上が正式な方針・手続きマニュアルを使用していることがわかりました。

企業文書には、上記の調査にあるように、企業の方針と手続きに言及した文書、取扱説明書、技術実践、行動と倫理に関する文書など、他にも多くの文書があります。また、パスワードで保護されている法的文書もあります。また、企業の構造、ベストプラクティス、手順、メンテナンスマニュアルなどもあります。

開発者向けドキュメント:このタイプのドキュメントは、ソフトウェア製品開発のための指示、機能仕様、技術仕様、ドキュメント、開発者のワークフローを支援するツールなどを提供します。

技術文書と製品文書の種類を理解したところで、製品文書の開発プロセスをしっかりと管理するための最初のステップを説明しましょう。

製品ドキュメントの開発責任者を探し出す

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_PsI4RmXQikpEACQlf/boo_NbQ7i8LYu6f7q4rnn/eccf743b-f84f-655a-e8cb-52655df7bc4ccampaign_creators_gMsnXqILjp4_unsplash.jpg)

典型的な例としては、製品ドキュメントをただ更新するのではなく、製品の品質と成功に責任を持つ担当者を決めるというものがあります。

プロダクトオーナーやプロダクトマネージャーが製品ドキュメントに責任を持つと考える企業もありますが、開発部門やサポート部門など他の部門も、ユーザーマニュアルやユーザーガイドなど製品ドキュメントのあらゆる面を最新かつ効果的に維持する責任を任されている場合があります。

製品ドキュメントの開発には多くの可動部分がありますが、ここではそのうちの2つをポイントに紹介します:

1.製品の操作方法をすべてのレベルで理解している人(これは、製品開発チームや仕様チームも含みます)。

2.製品ドキュメントを見ながら、手元の製品ドキュメントを理解する上での苦労や感想、悩みを聞いてくれるお客様からの意見を受ける方。

1つ目の工程では、手持ちの知識で決められた製品のドキュメントを作成し、それをお客さまにお送りし、フィードバックをいただくことで、ドキュメントの最適化を図る2つ目の工程を開始します。

この2点が完璧に整っていないために、製品ドキュメントに必要な配慮がなされないという事態が発生することがあります。

一つのアプローチは、、、製品ドキュメント、製品マニュアル、ユーザーガイドの "パフォーマンス" に対して責任を持つ人を指定することである。プロダクト・ドキュメンテーション」を担当商品とする発注書を考えてみましょう。彼は、会社のすべてのチームを調べ、各製品がどのようにガイドを生成するかをスケッチし、そのプロセスに関連する課題を特定する責任を負います。

このプロダクトオーナーとプロダクトマネージャーがマニュアルの作成・修正に全責任を持つのではなく、各チーム内の個人がドキュメント管理を行うことを支援することを意図しています。

この担当者は、ユーザーがどのようにドキュメントと接しているかを調査し、更新をよりスムーズにする方法を提案し、フィードバックを集めて、各製品のドキュメントや説明書をその意図する対象者に合わせて強化する方法を決定する必要があります。

製品ドキュメントを完成させるために必要なワークフローやさまざまな部門を管理する担当者を置くことは、社内の生産性を高め、製品に関するナレッジポータルで顧客を教育し、製品理解の合理化を図ることにつながります。

製品ドキュメントを製品そのものと見なす。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_JdDBUtqTll6qYQgc9/boo_NbQ7i8LYu6f7q4rnn/cd6029ed-9933-9a5f-4007-c4d28888fa5ebram_naus_n8Qb1ZAkK88_unsplash.jpg)

製品は、顧客の期待に応える、あるいは期待を超える価値を提供するために存在します。D2WorldWideが作成した統計](https://www.d2worldwide.com/product-documentation-why-do-customers-still-want-it-and-retailers-still-need-it/)によると、購入を検討している製品の情報を探す際に、ビデオやパッケージ、販売員よりもドキュメントの方が役に立つと評価する人の割合は73.7%です。

製品の魅力を高める要因を考える。製品の魅力に影響を与える要因はいくつかあるが、今回は3つに絞って考えてみることにする。価値の面で期待を超えている」「使い方が満足を生む」「競争力がある」。

さらに、同じコンセプトは、優れたオンライン製品ドキュメントにも当てはまります。期待値を超える」製品ドキュメントでは、指定されたアイテムの使い方だけでなく、クライアントが気づいていない、あるいは可能性を感じていない解決策を提示することができます。他社がどのように製品ドキュメントを作成しているのか、その成功例や失敗例から学ぶことは、常に必要なことです。

他社に先駆けたユニークで高品質なソフトウェアを開発する会社があっても、技術的な製品ドキュメントを統合する開発者や顧客がそれを把握できないのでは意味がないのです。

製品のドキュメントを読む人は、その製品が提供する可能性のあるソリューションの範囲や市場(技術的なSaaS製品によくあること)に精通していない可能性があるため、それらのソリューションや製品に関連するさまざまな選択肢について「教育」されなければならないと考えてください。

使いやすさが満足を生む」製品ドキュメントとは、対象読者に適した論理的な読み方をしているものです。世界一詳しいマニュアルがあっても、それが500ページのPDFであったり、Codeの例題がなく、検索機能などで動的に作成されていないのでは、意味がありません。製品マニュアルのユーザーやサポート担当者からフィードバックを集めましょう。そうすることで、報告されたデータとリンクしているストレスの主な領域を確認することができます。

競争力のある製品ドキュメントとは、最も効果的な情報交換技術を使用して継続的に更新されているものです。検索機能、翻訳、異なるバージョン、埋め込み画像、動画など、驚くような機能が搭載されています!

たとえ、あなたの統合ガイドがあらゆるテクノロジービジネスの中で最もよく書かれていたとしても、ビデオや、技術的なSaaS製品を購入する技術に精通した顧客が使いやすいようにコピー&ペーストできる画像やコードを追加しなければ、魅力に欠けることになります。

他の企業がどのように論文を作成しているのか、その成功例や失敗例から学ぶことは常に必要である。

他社に先駆けたユニークで高品質なソフトウェアを開発する会社があっても、そのドキュメントを統合する開発者や顧客がその全容を把握できなければ意味がないのです。

Product Documentation feedback

効果的なテクニカルドキュメントは、製品を理解するためのプロセスを磨き、問題があればすぐに利用できる解決策を示すことで、エンドユーザーの体験を向上させます。顧客から信頼され、製品の使い方を理解することで、将来的に必要な時にまた来てくれるかもしれません。

SDLの新しい調査は、世界のマーケットプレイスにおけるドキュメントの役割が高まっていることを証明しています。この調査によると、約53%のバイヤーが、製品を試す前に技術資料を用いて購入することが分かっています。また、94%のバイヤーが、製品情報が1カ所にまとまっていることを便利だと感じていることも、この調査から得られた統計データです。このような背景から、最近では各企業が製品の開発・テストと同様に、製品ドキュメントを重視しています。

たとえ、文書作成チームを管理するオーナーがいて、ユーザビリティを向上させるために改訂・評価され、適切に更新された製品文書を作成したとしても、ユーザーや消費者に技術製品を理解してもらうことに苦労し続けます。これは、ユーザーや読者が、文書がどのように読まれているのか、あるいは、彼らが本当に問いかけていることを理解できないために起こるかもしれません。そのため、文書作成の最も難しい側面の1つは、読者の立場に立って考えることです。やはり、製品ドキュメントを作成する人は、その製品についてしっかりと理解している必要があります。

このような専門的な知識は、一般的なユーザーにとってそれほど明白でないことを見落としてしまう可能性があります。典型的な例としては、製品を作る側にとっては自明なことでも、製品を購入し使用する側にとってはよくわからないということがあります。

これは、さまざまな形で起こります:

文章構成や形式:主観的な言葉に見えるかもしれませんが、ハンドブックの書き方一つで混乱が生じることがあります。開発者は説明的な文章よりも例を好む」「例やビジュアルがあるにもかかわらず、当社のドキュメントは明確でない」といった言葉が出てくる可能性があるため、ドキュメントを読む読者がどのような人かを特定することが重要です。

マニュアルで整理されたテーマ: 同じ市場で事業を展開する企業が、標準的な文書形式を開発することがあります。会社案内がそれに準拠していない場合、読者は奇妙な感覚を抱くかもしれません。

Excessive use of implicit terms: ハンドブックに適用する場合、たとえそのフレーズが頭字語でなくても、略語はほとんど意味をなさないかもしれません。認識しにくいですが、「status」「id」「credentials」など、明示的な意味を装った暗黙の意味が含まれている言葉もあります。"UID "ではなく "UserID "など、特定の呼称を活用する。

有効な翻訳: 翻訳は、グローバルリーチの大きな部分を占めています。多くの場合、企業は、特定の国の文化にマッチしていない、あるいは単に単語がその特定の国に英語で翻訳されるのと同じように翻訳されていない、不十分なユーザーマニュアルや製品ドキュメントを作成します。このような微妙なニュアンスの違いを理解することで、読めない情報から完全に包括的で翻訳された製品ドキュメントへと、長い道のりを歩んでいくことができます。

そのような状況を回避するために、ユーザーのフィードバックやナビゲーションパターンを収集・分析するソリューションを開発することを目的としています。

Vocally a Docsieのようなフィードバックツールは、ナビゲーションパターンを評価し、顧客が製品ドキュメントをどのように閲覧しているかを調査するのに最適な方法です。フィードバックを集めるための7つの黄金律はこちら

この情報は、ユーザーガイド、ユーザーマニュアル、製品ドキュメントを更新・最適化し、お客様が製品についてよりシームレスに学べるようにするために重要です。新製品を導入したときに、マニュアルの不備が原因でサポート依頼が増えることほど、悔しいことはありません。

How to Write Comprehensive Product Documentation(包括的な製品ドキュメントの書き方

質の高い製品ドキュメントは、魅力的で、有用で、力強いものです。私は、優れたドキュメント作成は、優れたプロダクトマネジメントに必要な要素であると主張します。プロダクトマネージャーは製品開発において大きな役割を果たしますが、成功の重要な要素は、顧客が理解し、製品に関する知識を深めるために使用できる、素晴らしく洗練された製品ドキュメントを作成することです。

ほとんどの製品のドキュメントはどうなっているのでしょうか?

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_6UrbmSp116NpfVK1l/boo_NbQ7i8LYu6f7q4rnn/64a68ac0-4ef1-308c-ad6b-5ce4525f5301jeshoots_com__2vD8lIhdnw_unsplash.jpg)

多くのプロダクトマネージャーは、製品ドキュメントを作成することに嫌悪感を抱いています。しかし、そのような製品ドキュメントを作るには、より魅力的で、読みやすく、親しみやすいものにする必要があります。

しかし、多くの場合、企業は素晴らしい製品ドキュメントを作成するために必要な注意を払わないことがあります。劣悪な製品ドキュメントは、ただ書かれることだけを目的に書かれています。曖昧な表現が多く、レイアウトが悪いため、見る人の興味をそぐような内容になっています。劣悪な製品ドキュメントは、作者を批判から守るために作られ、すべての人の時間を完全に無駄にしています。そして、その顧客もこの理由で読むのを嫌がる。

どうすれば、お客様に喜んで読んでいただけるような、より良い製品ドキュメントを書くことができるのでしょうか。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_NSTKBpS5BKDoj224Y/boo_NbQ7i8LYu6f7q4rnn/d83ce28b-38c3-bb53-8a14-2e1212d0fc5cscott_graham_5fNmWej4tAA_unsplash.jpg)

優れた製品ドキュメントは、読まれることを想定して書かれています。簡潔である。優れた製品マニュアルは、書式が整っており、社内や顧客の誰もが3分以内に読んで理解することができます。専門用語を使わず、ビジネスレベルの視点を示すか、言及する。優れた製品ドキュメントでは、顧客が理解し、製品の強化された使用に適用できるような具体的な使用例を概説することに時間を費やしています。読者を引きつけ、よく練られた解決策で根本的な問題に注意を向けさせる。

よくできた製品資料の効力について

中小企業や大企業があるところでは、書式の整った技術製品ドキュメントがあれば、時間を大幅に節約でき、従業員がより生産的に働けるようになるかもしれません。これは一般的に、ほとんどの製品ベースのビジネスに当てはまることで、テクニカルライターの雇用や技術製品ドキュメントの作成に予算の大きな割合を費やしています。

もし、あなたのビジネスが製品ドキュメントの作成に2人以上の人を雇っているなら、優れたドキュメントの文化を確立することは全く価値のあることです。製品ドキュメントの作成、管理、公開をチームに求める理由はたくさんありますが、以下のセクションでは、効果的な製品ドキュメントが顧客体験を向上させるための低コストなアプローチであることを説明します。

効果的な製品ドキュメントは、顧客体験を向上させるための低コストなアプローチである。

確かな顧客体験は、ロイヤルカスタマーを維持・継続するための最重要課題です。多くのプロジェクトマネージャーは楽観主義者であり、コンセプトを思いつき、熱中し、実行に移します。情熱は賞賛に値するものであり、実行は生産的であるように見えますが、適切な製品ドキュメントを作成する前にゲームプランを持つことが重要です。

ブレーンストーミングの後の最初のステップは、デザインサイクルを開始し、製品ドキュメントの内容を、顧客にとって徐々に読みやすくなるように構造化することです。

また、顧客から現在のドキュメントに関するフィードバックを得ることは、顧客のニーズに合わせてドキュメントを再構築するために必要な重要なステップです。このように、プロジェクトマネージャーは、ドキュメントの作成、管理、維持、公開、最適化を、認識と自動化で行うことができます。これは単純で小さな作業ではなく、製品ドキュメントを効果的に作成するための多くのプロセスを自動化するDocsieのような素晴らしいツールを持つことは、成功のために非常に必要です。

魅力的で、魅力的で、ナビゲートしやすい技術文書は、消費者が製品をより短時間で習得するのに役立ち、製品を正しく設定し、正しく使用する可能性を高めます。

このように、製品の評価やレビューの向上、売上アップにつながるドキュメント制作は、すべて連動しているため、結果として売上アップにつながるのは言うまでもありません。

How to create well-crafted product documentation?

効果的なドキュメントを作成し、それが標準となる文化を醸成するにはどうしたらよいでしょうか。効果的なドキュメントを書くことは難しいことですが、Docsie には、よく練られたダイナミックな製品ドキュメントポータルを作るこのプロセスの種明かしに役立つ、優れた機能がたくさんあります。以下は、私たちがこの問題にどのようにアプローチしているかのハイレベルな要約です。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_yl3vJ0vYDWgB1AnFf/boo_NbQ7i8LYu6f7q4rnn/7b97f8c4-af64-8ddc-c06b-93e6f28fea96dayne_topkin_y5_mFlLMwJk_unsplash.jpg)

では、さっそく始めましょう:

ページ数の制限で読みやすさを確保する まともな文書を書くには、読みにくく、精神的に処理しにくいものであってはなりません。長引く、蛇行するフレーズは、明確さの欠如を示すことが多い。もしコミュニケーションが1ページで適切にまとめられないのであれば、それはプロダクトマネージャーがおそらく戻って状況をさらに分解する必要があることを示すものである。

**フォーマットは品質を向上させます。製品ドキュメントの構成が悪いと、書き手が手探りになる可能性が高くなります。書式の整ったセクション、表、文書ヘッダーを備えたテンプレートを作成しましょう。高配当の可能性を秘めた一回限りの投資です。

テンプレートは、時間を節約するのに役立ちます。テンプレートからセクションを削除するのは、追加するのを忘れないようにするよりもはるかに簡単です。これは恩着せがましいことではなく、むしろ効果的で時間を節約することができます。書き手が大まかな背景から始め、測定値や危険な仮定について具体的に説明することを思い出させるシンプルなセクションは、より正確な文章と意思決定の階層を可能にします。

コメントとタスクの割り当て スタッフが質の高いドキュメントを作る意欲をなくすのに、コメントをしないことほど確実な方法はないでしょう。コメントには気の利いたものは必要ありません。むしろ、関与していることを示し、模範となるものでなければなりません。フィードバックをデジタルで提供し、社内の他の人が非同期で会話から利益を得られるようにするのが理想的ですが、Docsieのシンプルな機能で、コメントやチームとのコラボレーションができるようにすると、製品ドキュメントチームは素晴らしい仕事ができます!

Docsieが製品ドキュメントのコラボレーションにどのように役立っているかについては、こちらのブログをご覧ください。

https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/

Document Types should be scalable to meet your demands of company. 製品開発プロセスに関わるステークホルダーが増えるにつれ、コミュニケーションを複数のドキュメントに分ける必要があります(特に1ページの「簡潔さ」基準を満たす場合)。Docsieは、成長する製品ドキュメンテーションチームにとって、便利で持続可能なソリューションを可能にします。

Docsieを、素晴らしい製品ドキュメントの作成をスピードアップさせる方法として使う

Docsieは、製品ドキュメントやナレッジポータルの作成をあらゆる側面から支援する、非常に便利なプラットフォームです。Docsieには、製品ドキュメントの作成、公開、維持、管理プロジェクトを本当に簡単で楽しいものにするための機能がたくさん組み込まれています!ここでは、Docsieの機能の中から、これらの目標を達成するために役立つものをいくつかご紹介します:

編集機能: Docsieでは、すべてのユーザーが、公開後に製品ドキュメントを編集できるように、アクティブになるまで公開されない代替バージョンを作成しています。これは、製品管理チームが、HTMLやCSSのフープを飛び越えることなく、製品ドキュメントの編集や変更に取り組み、その準備が整った時点でライブ化することができるため、素晴らしいことです。また、準備が整えば、ノブを押すだけで自動的に製品ドキュメントをレンダリングします。

検索する能力:製品ドキュメントが豊富であるか、または多くの機能がある場合、Docsies検索プラグインは、顧客が製品ドキュメントをプレビューして情報を吸収するプロセスをスピードアップするために必要な情報を見つけるために、迅速かつ容易にあなたのドキュメントを介して検索することができます便利なボーナス広告を提供します。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_O7z6SBtXluhBFZBAw/boo_NbQ7i8LYu6f7q4rnn/18e9ab61-27d1-ffc9-0c46-86a5a75bda33image.png)

リンクを貼ることができます:Docsieは、製品ドキュメントをSEOに対応させることができます。あなたの会社のウェブサイトの特定のページにバックリンクすることができますし、単にあなたの製品に基づいてキーワードを書くと、オンライン検索可能で、あなたが持っている同じ製品を見つけるために探している新しい顧客を引き付けることができる場所です。

Ability to have different translations: Docsies state of the art ghost translator allows our users to translate their product documentation into various languages.また、Docsieの言語選択機能により、顧客はどの言語が最も適しているかを選択することができます。これは、グローバルリーチや企業の顧客基盤の拡大に非常に有効であり、新しく設立された顧客や海外の顧客との信頼関係を構築することができます。

シームレスなコラボレーションのためのタスクとコメントを割り当てることができます:Docsieは、製品ドキュメント作成チームとコラボレーションするための素晴らしいツールを持っています。コメントを割り当てたり、タスクを設定したり、ロールを割り当てたりすることができるので、Docsieを使用して製品ドキュメントプロジェクトに取り組んでいるどのユーザーがどのタスクを達成したかをよりよく管理することができます。もっと詳しく知りたい方は、こちらのブログをご覧ください。

フィードバックの生成製品ドキュメントやナレッジポータルをより楽しく理解できるように、顧客のニーズに合わせて製品ドキュメントを最適化する方法を知るには、顧客があなたのドキュメントについて何を考えているかを知ることが唯一の方法です 製品ドキュメントのフィードバックの重要性についてもっと知りたい方は、こちらのブログをご覧ください

また、Docsieには他にも多くの機能があり、製品管理チームが素晴らしい製品ドキュメントを作成するために使用することができます。この記事では、Docsieのナレッジポータルと製品ドキュメントに追加できるプラグインを紹介し、ドキュメントを強化し、使いやすさを向上させたいと思います。

Docsieプラグインでドキュメントポータルをダイナミックに!Docsieには、ドキュメントをより魅力的にするために使えるプラグインがたくさんあります。このブログでは、それを3つのパートに分けて紹介します。

ここでは、これらのナレッジポータル・プラグインの説明を3つに分けて説明します。

Part 1: 最初のパートでは、「Display Version Picker」、「Display Language Picker」、「Display Section Anchors」、「Display Footer Navigation」について紹介します。

PART 2: このパートでは、「コードハイライト」、「検索」、「ソーシャルネットワークへの共有」プラグインを紹介します。

PART 3:第3部では、「画像プレビュー」「ドキュメントメタデータ」「セクションの自動ハイライト」プラグインを紹介します。

プラグインに入る前に、Docsieプラットフォーム内でこれらのプラグインにアクセスする方法について説明します。

まず、ワークスペース内で、右上の3つの点をクリックし、アカウントを開く必要があります:

そして、「Configure a new deployment+」で新しいDeploymentを作成すると、Deployments内でPluginsにアクセスすることができます。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_EyeRwNDqJuiL6yclc/boo_NbQ7i8LYu6f7q4rnn/c3aa28de-aeff-0f8e-5b66-3e0f7cbdc564Snag_fb8dbd4.png)

次に、「その他のオプション」をクリックすると、これらのプラグインを、埋め込みスクリプトまたはDocsieポータルを通じて、デプロイされたドキュメントに追加することができるようになります。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_3BNU4lygMNvB6VhgK/boo_NbQ7i8LYu6f7q4rnn/c16fe2e1-c05b-4574-1b90-5beb78b1ccceSnag_fb8f18f.png)

もう一つの方法は、すでに公開されているドキュメントの下にある「展開設定の更新」ボタンから、Docsieのナレッジポータル・プラグインにアクセスすることです。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_yyBINqSBGXHuXCVFM/boo_NbQ7i8LYu6f7q4rnn/683c9259-3895-8af4-44c4-bfd25e802bc7image.png)

このダッシュボードを開き、あとは適当にプラグインを追加したり削除したりして、デプロイメントを更新してください。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_8LSwF7TSbZcIAXkeg/boo_NbQ7i8LYu6f7q4rnn/df9df9ae-e562-9d25-2bdd-8253a7af8668image.png)

PART 1:

さて、Docsie Plugginへのアクセス方法がわかったところで、PART 1に入りましょう。

パート1のチュートリアルを見るには、こちらのビデオをご覧ください:

</iframe

まずは「Display version Picker」と「Display Language Picker」から始めましょう。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_9F8xevNxryqXJuual/boo_NbQ7i8LYu6f7q4rnn/3539432f-5e55-7c68-c8ff-6e10ccaaf16fimage.png)

この2つがアクティブになると、ナレッジポータルの左下にフローティングタブとして表示されます。 これにより、顧客や製品ドキュメントを読む人は、異なる言語やバージョンで製品ドキュメントを閲覧することができます。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_15B6AEHxast4mhcXQ/boo_NbQ7i8LYu6f7q4rnn/3dc1ff60-4be8-3457-f12c-be1f2bbff93aimage.png)

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_l5TJuQjEKYHFB1uKf/boo_NbQ7i8LYu6f7q4rnn/67756830-5264-edcc-cc47-ff4f83901882image.png)

ユーザーが言語ピッカー内の言語を押すと、読んでいる文書全体がその言語に変更されます。

セクション表示アンカーを有効にすると、各ヘッダーの横にリンクが表示され、ドキュメントの特定のセクションへのリンクが表示されるようになります。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_xfEuNCfFm3uRLsjgt/boo_NbQ7i8LYu6f7q4rnn/970f06ac-8fee-01f0-31fd-9b86800347aeimage.png)

これらのリンクが押されるたびに、ヘッダーの一部が変化し、お客様がこのhtmlをコピーして貼り付けると、送信先がドキュメントのこの特定のセクションに誘導されます。

次に「フッターナビゲーションを表示する」です。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_OUljvQnuFNAphGApN/boo_NbQ7i8LYu6f7q4rnn/aa4b47a1-72d2-3218-9cb6-96c7afe5d813image.png)

このプラグインは、ドキュメントBookの右下にナビゲーションボタンを追加します。以下のような感じです。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_56mbG9THAGa94XROc/boo_NbQ7i8LYu6f7q4rnn/90593fea-48fa-92d7-b3de-dbc4955c7c0fimage.png)

そうすることで、お客様はより快適にドキュメントを閲覧することができます。

PART 2:

第2部チュートリアルをご覧になるには、こちらのビデオをご覧ください:

</iframe

このパートでは、「コードハイライト」、「検索」、「ソーシャルネットワークへの共有」プラグインを紹介します。

それでは、「Code Highlighting」プラグインについて説明します。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_HLyqacquYY5uqmuC5/boo_NbQ7i8LYu6f7q4rnn/0afe135b-47fa-0e1a-f94f-5460bf448c5fimage.png)

このプラグインは、顧客に様々なコードを表現する必要がある技術製品に最適です。このプラグインは、「コピー」ボタンを追加することで、顧客がエディター上で使いやすいように、割り当てられたコードをコピー&ペーストできるようにします。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_W2SjxQvvsp5Vut9t4/boo_NbQ7i8LYu6f7q4rnn/86322d6d-d84a-3e3d-80b2-33a74fef6d64image.png)

それでは、Searchプラグインに潜入してみましょう。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_p3P3TLvZzKG3maz4h/boo_NbQ7i8LYu6f7q4rnn/67acc913-8ece-2d3d-70d1-37a278f118e9image.png)

Docsieのナレッジポータルを有効化すると、顧客はナレッジポータルの右上にある検索ナビゲーションを使って、ドキュメントを検索することができます。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_7jrRLle6xCtIb3FiY/boo_NbQ7i8LYu6f7q4rnn/f39bac8d-787f-aa59-34b0-d86b3f505004image.png)

検索をクリックすると、洗練されたダッシュボードが表示され、お客様が棚や本の中の特定の情報をピンポイントで見つけることができるようになります。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_8G9KP4zImdeOeNVMG/boo_NbQ7i8LYu6f7q4rnn/5e64c628-aa23-b6c3-d17c-499a87ea0265image.png)

これにより、お客様が商品に関する必要な情報を探し出すまでのプロセスが非常に速くなります。

次に、Share To Social Networksプラグインです。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_0drhefPXvSjuyfjVF/boo_NbQ7i8LYu6f7q4rnn/382f6e99-41cc-698a-b66a-81ac9175b29cimage.png)

このプラグインを使用すると、顧客が製品ドキュメントのハイライト部分を取得し、ソーシャルメディア内で共有することができます。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_dbo2n8uLjl1G1ivb4/boo_NbQ7i8LYu6f7q4rnn/0ae0c1e2-c3eb-d412-44d5-84602d468dccimage.png)

これは、トラフィックを増やし、新しい潜在顧客を増やし、ブランドに対する信頼を高めることができるからです。

PART 3:

パート3のチュートリアルを見るには、こちらのビデオをご覧ください:

</iframe

第3回では、「画像プレビュー」、「ドキュメントメタデータ」、「セクションの自動ハイライト」プラグインを紹介します。

まずは、Image Preview Pluginから。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_WsjaGzvZNJCeVogpa/boo_NbQ7i8LYu6f7q4rnn/1e5d8465-ee7c-9b49-36e7-274d1aa37919image.png)

画像プレビューは、お客様が製品ドキュメントの画像をよりよく見るために、拡大・縮小することができます。

次は「ドキュメンテーション・メタデータ」です。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_t4meZdddAnNiSkpdK/boo_NbQ7i8LYu6f7q4rnn/341fcd12-a920-d275-5366-8c5808669d08image.png)

これにより、お客様は、製品ドキュメントやナレッジポータルの側面が更新されたときのタイムスタンプを確認することができます。これは、文書化されたドキュメントの上部と下部に配置される予定です。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_XuX34nMuBsiRqXWVJ/boo_NbQ7i8LYu6f7q4rnn/89db1bbb-c9bf-50e9-5344-36717448c436image.png)

それでは、「Auto-Highlight Section Plugin」を見てみましょう。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_BT0Tl9oKw8ORPmbb5/boo_NbQ7i8LYu6f7q4rnn/f5e51dc0-9b5a-5f40-bd76-4eac82b0611bimage.png)

このシンプルなプラグインは、お客様がナレッジポータル内の特定のドキュメントでどの位置にいるかを追跡できるようにします。

![](https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_C0MHe1cC9uGOioVSP/boo_NbQ7i8LYu6f7q4rnn/46c6358b-22fb-75b1-dc80-0ba258a87a29image.png)

ナレッジポータルの中で、各拠点がハイライトされ、yo8ruのお客様は、自分がどのセクションにいるのかを把握し、他のセクションに簡単に移動することができます。

これらのツールやその他のものはすべて、Docsieのプラットフォームによってあなたに提供されます。まだお試しになっていない方は、ぜひお試しください。ここをクリック

また、ご不明な点がございましたら、hello@docsie.ioまでお気軽にご連絡ください。


Subscribe to the newsletter

Stay up to date with our latest news and products