11の強力なツールを統合し、クラス最高の製品ドキュメントを実現します。

Avatar of Author
Ciaran Sweet
on July 28, 2021 · · filed under Product Documentation Documentation Portals Best Practices Technical Writing Product Documentation Tutorials

製品チームは、クラス最高の顧客体験を提供するために、製品ドキュメントの素晴らしさを創造する必要があります。ドキュメントそのものは、ビジネス製品の百科事典のようなもので、正確さと読みやすさが高ければ高いほど、顧客は製品を理解し、価値を引き出しやすくなります。

Docsieは、このようなニーズに直接応える強力な文書管理ソリューションです。ライターは、キーボードを数回叩き、簡単なクリックをするだけで、製品ドキュメントの作成、ドキュメントの編集、ウェブへの公開を行うことができます。その結果、整理、グローバル検索、フィードバック照合、リッチメディアをサポートした、一元化されたアクセス可能な製品ドキュメントができあがります。

しかし、Docsieには、Docsieユーザーがワークフローに組み込むことができる優れたツールが存在します。これらのツールは、私たちの製品ドキュメントの作成に役立っています。私たちは、「永久無料スタートアッププラン」(https://www.docsie.io/pricing/)を使って、Docsieでこれらのツールを試してみることをお勧めします!

Let's get writing!

11の強力なツールで、Docsieの体験をレベルアップ。

1.プロライティングエイド

まず、「Pro Writing Aid」。これは、ライターが製品ドキュメントを作成する際に役立つ、文法・スペル・文章構成ツールです。

文章を書くときに、quot;you're" と "your" が思い出せない場合、このツールはエラーをキャッチし、その場で文脈に応じた推奨事項を提供します。

また、読書学年レベル(例:Grade 13)、文型監視(短い文の後に長い文が続く)、受動態("I will do work" vs "The work will be done by me" )も可能です。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_sBDe8ADHXLhzOI7Bt/boo_dqsfhc7ObadQ3xWmV/a876561b-106c-2150-6e2a-5d7a8522eba5ProWritingAidDocsieImage.png)

文法、スペル、文章構成は、多くの人が評価している以上に重要です。文法やスペルミス、段落の長い文章を目にすると、顧客はその製品への信頼を失います。例えば、子供をターゲットにした製品で、読書レベルが高いのは逆効果です。受動態は画面の面積を無駄にしがちで、読者にとって回りくどい印象を与えますが、能動態は短く、甘く、要点を押さえています。

DocsieのワークフローにPro Writing Aidを追加することで、あなたの言葉を向上させ、お客様の心を動かすことができます。

2.クイルボット

言い換えは、コンテンツ開発における一般的な慣行であり、製品ドキュメントを作成する際にも当てはまります。しかし、悲しいことに、そう信じたいのは山々ですが、そのような考えを持ち、紙にペンを走らせたのは、私たちが最初ではありません!

言い換えとは、同じことを違う言葉で言うというシンプルなものです。QuillBotはAIソフトウェアツールで、自動的に言い換えを行い、剽窃やその風評被害、著作権に関わる結果を回避します。

quot;パラフレーズはどのように行うのでしょうか;

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_cwSR1syhFEDnzXYY6/boo_dqsfhc7ObadQ3xWmV/de4f4ee5-a94a-5f35-9b0f-3f6b482f1766QuillBotDocsieImage.png)

文章を入力し、quot;Rephrase"をクリックするだけで、右側に言い換えられた抜粋が表示されます。すてきでしょう?

インターネット上でコンテンツを再利用する場合は、Docsieと一緒にQuillBotを試してみてください。QuillBotは、オリジナリティを自動化するためのツールです。

3.スナジット

製品ドキュメントには、言葉だけでなく、画像やアートワークが必要です。画像とともにステップバイステップの説明を提供することで、ユーザーは製品ガイドに従う際に、より確実で信頼性の高いものになります。

Windowsの場合、Snipping Toolが利用可能です。Linuxの場合、(Shift/Alt)+PrintScreenのキーボードショートカットでスクリーンショットを撮ることができる。macOSでは、Shift+Command+5で撮影することができます。ただし、機能は制限されています。

次に紹介するのは、Snagitです。オールインワンのスクリーンキャプチャツールとして、さらに一歩進んだ機能を備えています。ユーザーは、ディスプレイ全体のスクリーンショット、ウィンドウのスクリーンショット、またはスクリーンショットのキャプチャゾーンを描画することができます。Snagitは、ウェブカメラを通したビデオや音声の記録もキャプチャすることができます。さらに、スクリーンショットに矢印やテキストなどの注釈を付けたり、GIFやビデオにトリミングやサウンドオーバーレイを施すことができる編集機能を備えています。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_SC6oDqX4HD1Py0agJ/boo_dqsfhc7ObadQ3xWmV/46bf6408-a1ae-d79e-5924-8850700ee854SnagitDocsieExample.png)

Snagitは、簡単に言うと、製品ドキュメントのライターのために作られたスクリーンショット、ビデオ編集、コミュニケーションソリューションです。今度、Docsie Booksに使う画像が必要になったら、ぜひ試してみてください!

4.カムタジア

Snagitのメーカーから(これは映画の予告編か)-次にCamtasiaを紹介します!

Camtasiaは、Snagitと似ていますが、画面録画とビデオ編集に重点を置いています。ユーザーは、トランジションやモダンなスタイルを備えたビデオテンプレートを活用し、テンプレートをチームで共有することでビデオ作成のワークフローを効率化することができます。ロイヤリティフリーのCamtasiaアセットライブラリは、著作権の負担なく視覚的なセンスを加えることができます。Snagitと同様に、Camtasiaは注釈、デバイスフレーミング(フルスクリーン、ウィンドウ、領域の描画)、デュアル入力オーディオ録音(マイクとシステムサウンドの両方)をサポートしています。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_47zfmEreV6BA7FICb/boo_dqsfhc7ObadQ3xWmV/f1407819-11cb-74ad-0b1c-66fdd48ee401CamtasiaDocsieExample.png)

YouTubeのCamtasiaは2008年のものですが、Docsieで製品ドキュメントを作成するためにこのツールを使い始めるのは遅くはありません。あなたのドキュメントにブーム・ブーム・パウダーを!

5.タブロー

データは、まさに現代の世界を動かしています!しかし、生データは人間にとって理解しがたいものです。コンピュータは常に生データを扱っている。

Tableauは、生データを美しいビジュアライゼーションに変換し、あらゆる人がパターン、トレンド、その他のデータインサイトを容易に確認し解釈できるようにします。リレーショナルデータベース(RDBMS)、非リレーショナルデータベース(non-RDBMS)、オブジェクト指向データベース(OODBMS)など、幅広い種類のデータベースをサポートしており、事実上無限のデータ可視化の可能性を持っています。

以下は、Docsie Bookに埋め込まれたTableauのビジュアライゼーションの例です。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_mgVz26JU76a3LADfX/boo_dqsfhc7ObadQ3xWmV/8bee7e83-e25a-946d-bca9-08f5ad7588b4TableauforDocsieExample.png)

このビジュアライゼーションを自分でテストしてみましょう!Docsieを開き、製品ドキュメント(Book)を作成し、Docsie EditorでEmbedボタンを選択します。ここから、埋め込みコードを貼り付け、ウェブページに合うようにリサイズします(vizElement.style.widthとvizElement.style.height属性)。

![](https://cdn.docsie.io/boo_uyETYF3HNzbtX0KaY/3a781b86-b930-fce7-2bdf-4bfa373b4243add_image_toolbar.png)

エンベッドコード(貼り付けろ!)。

です。 製品ドキュメントに統計やデータを使用する場合、Tableauを使用することで、ユーザーにとってより簡単に(そしてより美しく)表示することができます。DocsieはiFrame技術を使ったTableauの埋め込みに対応していますので、ぜひ試してみてください!

6.ドロー.io

電気工事士は、回路図や図解なしに電気ケーブルの配線を変えたり、ルートを変更したりすることは決してありません。このことを念頭に置いて、図やフローチャートを提供することで、ユーザーは製品の内部と外部をより速く学ぶことができます。

製品ドキュメントのライターは、Draw.ioを使用してフローチャートやダイアグラムを作成できます。このソフトウェア文書作成ツールは、魅力的で視覚的に美しいチャートを作成するためのテンプレートと数百のアセットを提供します。例えば、コンピュータシステムやネットワークのトポロジーでは、ダイアグラムやフローチャートによって、システムの階層やデータの流れが明らかになります。製品も同様に、基本的なワークフローや機能を明確にすることができます。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_jo79eJ1rF0UIUwNSA/boo_dqsfhc7ObadQ3xWmV/e200dcc3-16f1-cd55-b228-1e5e90286f9fDrawioDocsieExample.png)

Draw.ioもiFrameの埋め込みをサポートするツールです。製品ドキュメントを作成し、Docsieのdocsに直接埋め込むことができます!Snagitなどのツールでスクリーンショットを撮ることもできますが、チャートの編集が自動的に反映されるので、iFrameをお勧めします。

7.スタティスタ

統計データは、ドキュメントの権威を高めます。競合他社との比較や、市場の状況、自社製品の取り組み方などを説明するために、統計情報を盛り込んだ製品ドキュメントを作成する際には、Statistaをお試しください!

Statistaは、150カ国以上、170業種のデータを収集し、統計データの最高のデジタルソースの1つとなっています。すべてのデータは査読付きの研究によって裏付けされており、一部のデータチャートには予測や予想まで表示されています。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_RUhjD6bkfd8IBFEKc/boo_dqsfhc7ObadQ3xWmV/34ef079d-93ed-84f0-97fd-f3642905d6b8StatistaMainDocsieExample.png)

StatistaはiFrameの埋め込みに対応しているので、Docsieのドキュメントにグラフやチャートを埋め込むことができるのが魅力です。これらのグラフやチャートは時間と共に更新されるため、統計情報を常に最新の状態に保つことができます!

Statistaのアカウントを作成し、次のDocsie Bookに統計情報を埋め込んでみましょう!

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_huVo7yXmIBx1LAGHf/boo_dqsfhc7ObadQ3xWmV/e97c9506-cfdb-ab1f-828b-114c97dd0003StatistaAltDocsieExample.png)

8.コードペン.io

ソフトウェア製品のドキュメントは、物理的な製品とは異なるものです。特に、一般ユーザーではなく、開発者やエンジニアを対象とする場合は、ハイレベルな技術情報、コードスニペット、依存関係などが含まれます。

しかし、JavaScriptのコードのスクリーンショットは、開発者やドキュメントを読むエンジニアにとってほとんど役に立ちません。Ctrl+Cで操作できるコードも、画像ではできません!そこで必要なのが、ビルド、テスト、共有機能を備えたフロントエンドのコードサンドボックスです。

CodePen.ioは、数あるソフトウェアのドキュメントツールの中でも、特にサンドボックス化されたコードの実行と図解に優れています。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_k5vSeT7kpOHl4UjHP/boo_dqsfhc7ObadQ3xWmV/804fb7d8-95fe-777e-ea16-3ebea86bdcbdCodepenDocsieExample.gif)

CodePenのコードは、ページ上でリアルタイムに実行され、あなたのコードがユーザーに何をするのかが正確に示されます。これは、あなたの製品がカスタムコードをサポートしている場合、ユーザーが楽しめるようにテンプレート化された機能のライブラリを共有することができるため、素晴らしいことです。最後に、サンドボックス環境は実験を促し、ユーザーが新しいことを試したり、製品の限界を完全に探ったりすることを促します。

エンベッドコード(貼り付けろ!)。

です。

DocsieにCodePen.ioを埋め込んで、ネイティブコードのハイライト機能を活用し、開発者ユーザーがドキュメントをより活用できるようにしましょう!

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_vvYoRQeiL3LCUVDAS/boo_dqsfhc7ObadQ3xWmV/66d06474-e719-fcc0-7823-994eb242ba28CodeHighlightingDocsieExample.png)

9.ドキシジェン

あまり知られていないツールですが、開発者やソフトウェア・ドキュメントの書き手には便利です。Doxygen(Docsieとは関係ありません!)は、コードをスキャンしてパラメータ、属性、コメントなどを特定し、ソフトウェア文書を自動的に作成します。

Doxygenの拡張機能として、Doxygenドキュメントの出力をコード編集ビューでリアルタイムに表示できるCLionがあります。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_2cPEUGCErPeWsXEGC/boo_dqsfhc7ObadQ3xWmV/f892b701-5578-e660-2045-67bacdad9bf8DoxygenCLIONDocsieExample.png)

ここでは、iTunes COM Interfaceを探索する例を示します。ソースコードを提供することで、ドキュメントが自ずと作成されます!

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_rtD8sCQOi1D4bB7jZ/boo_dqsfhc7ObadQ3xWmV/9a57672a-6b0c-65c9-d40c-117b548f0ebbDoxgenOutputDocsieExample.png)

Doxygenを使ってみて、その結果をDocsieにコピーしてください。その後、私たちのコードハイライトプラグインや他のフォーマットオプションを使用することができます!

10.Pixlr E

Snagitで画像をキャプチャする方法については、すでに説明しました。しかし、デスクトップやモバイルで画像を編集する強力な方法が不足しています。Adobe Photoshopは強力ですが、ハードウェア要件やライセンス費用から、デザイナー、アーティスト、クリエイティブプロフェッショナルに限定されています。

Pixlrは、Photoshopと同様の機能を持ちながら、デバイスにインストールする必要がないWebベースの製品ドキュメントツールです。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_DDQflhicLbRwoBg51/boo_dqsfhc7ObadQ3xWmV/c25d3546-c21e-994c-793c-9ae51a701733PixlrEDocsieExample.png)

テキストの追加、ピクセルの投げ縄とコピー、ぼかし、色の塗りつぶし(16進数またはRGBカラーホイールを使用)、切り取り、ブラシ、ペン、液化、自動回復、レイヤーの追加と削除など、多くのことができます!編集した画像はクラウドに保存され、アクセスしたり共有したりすることができます。

スクリーンショットを撮りながら、Pixlr Eを試してみてください!その後、エクスポートした画像を直接Docsieにコピー&ペーストすることができます!

11.JotForm

Docsieには、すでにドキュメントのためのフィードバックフォーム - Docsie Vocallyがあります。ただし、これはDocsie Booksに関する読者のフィードバックのみで、一般的なフィードバックには対応していません。

JotFormのような製品ドキュメントツールでは、動的なWebフォームを作成し、Docsie Booksに直接埋め込むことができます。例えば、ナレッジベースでは、各記事の下に、ITサービスチケットのフォームを入れることができます。

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_PilAiIswkzAypwYPD/boo_dqsfhc7ObadQ3xWmV/2712e505-5066-1206-005b-b41a3a907d28JotformDocsieExample.png)

ZenDeskとの連携により、フォームの回答をITサービスデスクのチケッティングソフトウェアに自動的に読み込むことができます!

![](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_B0XeGkP8hxM7CC5rP/boo_dqsfhc7ObadQ3xWmV/49b6ff57-5a3d-0dbe-ab79-13d2d5e41545JotformtwoDocsieExample.png)

あなたのDocsie BooksにJotFormsを追加してみてください!フィードバックフォームは、優れたドキュメントを追求する上で非常に貴重なものです!

今日からDocsieでこれらのツールを使ってみてください!

上記の製品ドキュメントツールは、どれもDocsieと互換性があります!効率と生産性を最大化するために、これらのツールをDocsieで試すことを強くお勧めします!

Docsieを使えば、お客様の業務に役立つドキュメントを作成することができます。スタートアッププラン ](https://www.docsie.io/pricing/)(forever free!) にご登録いただき、Docsieで楽しいドキュメントをお届けしてください!


Subscribe to the newsletter

Stay up to date with our latest news and products