デジタルドキュメンテーション:情報提供とインスピレーションのためのベストプラクティス
Product Documentation Best Practices

Digital Documentation: Best Practices to Inform and Inspire

Tal F

Tal F

May 04, 2021

デジタルドキュメントの使いやすさと一貫性を高めるために、企業はデジタルドキュメントのベストプラクティスに従うべきです。これには、デジタルドキュメントの設計、フォーマット、ファイルタイプの選択、およびガバナンスが含まれます。


Share this article:

紙からピクセルへ

ほんの数十年前まで、企業はあらゆる文書を紙で管理していました。契約書、ポリシー、会議のメモなど、すべてが紙ベースでした。印刷して手渡しされ、メールで添付・分析されるのではなく、物理的に回覧されていたのです。

テクノロジーの進化に伴い、企業は文書のためのストレージスペースを拡大し、従業員がデジタル文書にアクセスするためのコンピューターシステムを整備しました。これが紙からピクセルへの移行の始まりです。

現代のデジタル文書化には多くのメリットがありますが、問題も残っています。文書は社内スタッフと外部顧客の両方に情報を伝えるために使用されます。つまり、コンテンツの一貫性、アクセスのしやすさ、管理のしやすさが不可欠です。反対に、一貫性がなく、アクセスしにくく、管理が難しいデジタル文書は、ビジネスの情報伝達能力を低下させます。

効率性と一貫性を高めるため、企業はデジタル文書のベストプラクティスに従うべきです。これにはデジタル文書のデザイン、フォーマット、ファイルタイプの選択、ガバナンスが含まれます。

このeBookでは、デジタル文書のベストプラクティスと、これらの変更がもたらす潜在的なビジネスへの影響について説明します。より良いデジタル文書が収益成長を促進し、顧客を引き付けることはできるでしょうか?企業はどのようにして文書管理システム(DMS)を活用し、デジタル文書を改善して顧客により大きな価値を提供できるでしょうか?

これらの疑問に答えていきましょう!

デジタル文書化のメリット

デジタル文書のベストプラクティスの内容と方法について議論する前に、まずデジタル文書化のメリットを理解しましょう:

  • 管理のしやすさ — デジタル文書は紙の文書より管理が容易です。紙の文書はオフィスにファイリングキャビネットのスペースが必要で、各文書の手動アーカイブ作業が必要です。デジタル文書ストレージはオフィススペースを節約し、検索機能とフォルダ構造で管理を簡素化します。

Software Adviceの調査によると、オフィスワーカーは紙の文書を探すのに週平均6時間を費やしています。さらに、紙の文書からレポートを作成するのに週平均8時間を費やし、94%が文書管理システム(DMS)によってこのプロセスが容易になると回答しています。[1]

  • アクセスのしやすさ - デジタル文書はメールやクラウドストレージを通じてほぼリアルタイムで共有できます。これにより郵送が不要になり、郵便料金や配送コストを削減できます。また、受信者が手紙の到着を数日待つ必要がなくなるため、対応速度が向上します。さらに、デジタル文書はウェブサイトやSNSに公開でき、顧客のアクセス性を向上させます。

Gartnerによれば、文書の印刷に1ドル使うごとに、その文書の取り扱いと配布にさらに6ドルかかることをご存知でしょうか?さらに、印刷された文書の半分は24時間以内に捨てられています。[2]

  • セキュリティとガバナンス — 鍵のかかった場所に保管されていない限り、紙の文書はセキュリティに欠けます。誰でも読んだり、コピーを取り、自由に共有したりできます。対照的に、デジタル文書はロールベースのアクセス制御(RBAC)によって管理でき、必要な人だけにアクセス権を付与できます。

政府機関でさえ紙のデータ漏洩から免れません。米国退役軍人省はデータ漏洩の98%が紙の文書が原因だと報告しています。[3]

  • 環境へのメリット — 個人も企業も環境フットプリントを削減する方法を模索しています。デジタル文書化はその一つの手段です。Green Americaによると、紙の消費量は過去40年間で400%増加し、紙産業は世界のエネルギー消費量の4%を占めています。[4] デジタル文書化を選択することで、企業は紙の使用量を減らし、森林破壊に対抗できます。これにより、二酸化炭素を吸収し、動物の生息地を維持する樹木を守ることができます。

Docsieでのデジタル文書のベストプラクティス

デジタル文書は、ビジネス全体の知識共有、出版、マーケティングを変革する可能性を持っています。この可能性を活かすために、企業はデジタル文書のベストプラクティスに従うべきです:

DMSをビジネスニーズに合わせる

文書管理システム(DMS)は、企業が文書を保存・管理するための基盤です。コンテンツが作成された後、保存と配布のためにDMSにアップロードされます。DMSは文書保存を一元化し、ビジネス全体に単一の知識ソースを提供します。これはデジタルライブラリのように機能し、部門や製品ごとに文書を分類し、検索機能で知識共有を効率化します。ここからマーケティングチームやサポートチームが文書を共有し、ウェブサイトやSNSに公開したり、顧客の問い合わせに応じて提供したりできます。

Docsieは、チームの文書作業を簡素化するDMSです。すべての企業は、社内スタッフが自分の役割について学び、顧客が製品やサービスの使い方を理解できるように、文書を保存・共有する方法が必要です。人事部の入社時研修資料、製品のハウツーガイド、営業コミュニケーションテンプレートなど、これらすべてが適切なDMSソリューションで保存・公開できます。

現在、あなたの製品やサービスにはどのような文書が存在しますか?スタッフは顧客とコミュニケーションする際にテンプレートやフレームワークを使用していますか?文書を簡単に保存、社内共有、外部公開できますか?DocsieのようなDMSソリューションを検討する際には、これらの質問をし、DMSがビジネスニーズに合っているか確認してください。

互換性に重点を置く

デジタル文書はアクセシビリティを向上させますが、高い互換性を持つファイル形式を使用する場合に限ります。これはダウンロード可能な文書において重要です。特定の顧客がファイルを開けない場合があるためです。また、社内文書にも適用され、あるファイル形式でPDFを使う従業員と別の従業員がDOCXを使うと、ファイル形式の断片化が起こり、他の従業員がソフトウェアを切り替えたり、ファイルをアクセス可能にするために別の形式に変換したりする必要が生じる可能性があります。

Microsoft Officeのdocx、xlsx、pptxのようなオープンファイル形式、またはOpenOfficeのオープンドキュメント形式(ODF)は、互換性を最大化するのに最適です。Adobe PDFドキュメントは一般的ですが、PDFビューアが必要なため互換性が低くなります。これらの文書にアクセスする人を考慮し、最も広いユーザー層をカバーする形式で文書を保存してください。

Docsieは幅広い文書互換性に最適なオプションです。テキストがDocsie Book Editorに読み込まれると、オープンソースのJavaScript Object Notation(JSON)ファイル形式で保存されます。文書のエクスポートについて、およびDocsieがDOC、PDF、Markdown(MD)、HTML形式への簡単な変換を可能にする方法についての詳細はこちらでご確認いただけます。

実用的なフィードバック

文書に関するユーザーや従業員からのフィードバックは不可欠です。文書に情報が不足している、不正確な情報が含まれている、または単に読みにくい場合、読者は文書から価値を得るのに苦労します。さらに、フィードバックは既存の文書を改善し、顧客により多くの価値を提供するのに役立ち、質の高い知識共有を通じてビジネスの成功を促進します。

Docsie Vocallyは、フィードバックのモニタリングと対応のためのオールインワンサービスです。読者が個々の文書を1から5の尺度で評価し、その理由をコメントで説明できます。Docsieのオーナーやアドミンはこのフィードバックを読み、文書の成功と欠点について洞察を得ることができます。

セルフサービスのナレッジベースは、サポート要件を最小限に抑えるように設計されていますが、これは顧客が質の低い文書にこだわらない可能性も意味します。代わりに、より良い文書を提供する競合他社のところで代替案を探すでしょう。この問題に対処するため、Docsie Vocallyはユーザーが文書を読むときの操作を記録します。これにより、文書のどこで問題が発生し、どのコンテンツが問題を引き起こしているかが明らかになります。ライターはこのフィードバックを使用して文書を編集し、ユーザーのフィードバックに対応できます。時間の経過とともに、文書知識の質が向上し、顧客が自己解決できるようになります。

顧客のエンパワーメントは、新規ビジネスを獲得し、コストを削減し、顧客を維持する優れた方法です。Zendeskによると、顧客の約67%が電話での会話よりもセルフサービスを好みます。[5] Forrester ResearchとOracleの調査では、セルフサービスは1回の電話あたり11ドルのサポートコスト削減につながることがわかりました。[6] また、Microsoftの調査では、顧客の90%がセルフサービスオプションを期待していることが強調されています。[7]

要約すると、顧客は質の高いセルフサービスを好み、期待しており、このオプションを提供することでサポートコストを大幅に削減できます。Docsieでセルフサービスナレッジベースを作成し、Docsie Vocallyを通じたフィードバックで文書の質を向上させることで、デジタル文書を通じて進化する顧客の要求に応えることができます。Docsie Vocallyの詳細はこちらをご覧ください。

文書のバージョン管理

特にテクノロジー企業では、新しいソフトウェアやサービスのバージョンが文書に問題を引き起こす可能性があります。新バージョンでは以前のバージョンとは異なるワークフローや用語が使われ、ユーザーを混乱させる可能性があります。同時に、新しい文書がサービスの古いバージョンに適用されない場合、顧客をイライラさせ、離反させる可能性のある知識ギャップが生じます。

これはデジタル文書におけるベストプラクティスとして重要です。顧客はハードウェアとの互換性のためにソフトウェアの古いバージョンを必要とするか、単に新しいバージョンに更新しないことを選択するかもしれません。したがって、企業は使用されているバージョン番号に関係なく、常にユーザーベースに対応する必要があります。

Docsieは文書バージョン管理でこの問題に対処します。Docsieで文書を更新する際、冗長性の目的で以前のバージョンを保持できます。サービスのバージョン2を使用している顧客は適切な文書を選択でき、バージョン1を使用している顧客も古い文書にアクセスできます。これはフラグメンテーションと呼ばれ、顧客ベースが同じソフトウェアの複数のバージョンに分散している状態です。Docsieはフラグメンテーションの影響を軽減し、使用されているバージョンに関係なく知識が利用可能であることを保証します。

文書のバージョン管理により、必要なときに適切な情報が利用できます。また、複数のライターが同じコンテンツに取り組んでいる場合、トレーサビリティの向上にも役立ちます。バージョン管理はまた重複を減らし、アクセスを容易にするために文書を統合します。

あなたの企業は定期的に文書を更新していますか?顧客はソフトウェアやサービスの現在および過去のバージョンに関する適切な情報を見つけるのに苦労していますか?もしそうなら、DocsieのようなDMSを通じて文書バージョン管理のベストプラクティスを適用する時期かもしれません。Docsieの文書バージョン管理についての詳細はこちらでご確認いただけます。

従業員の文書作成習慣

人々は文書を作成しますが、文書に関する問題も作り出します。ドラフト段階で、ライターは異なるフォントサイズやタイプを使用したり、古いアイコンやアートワークを使用したりする場合があります。これらの違いは毎日コンテンツを扱う従業員には見逃しやすいですが、顧客はより気づきやすいものです。結果として、コンテンツ作成と公開のアプローチの不整合によって、一貫性のない文書が生まれます。

Docsieは、Docsie Documentation Hubで企業がコンテンツの一貫性の問題に対処するのに役立ちます。デフォルトのフォントタイプとサイズを設定し、会社のロゴやアートワークを追加し、企業のウェブサイトやナレッジベースで使用するためのCSSスタイルシートのパラメータを定義できます。これらの選択はDocsieから埋め込みコンテンツを持つすべてのウェブページに伝播し、コンテンツが公開されるすべての場所で同じ色、フォント、ロゴを使用します。

これによりコンテンツ管理と公開のワークフローが簡素化されます。個々のページを編集する代わりに、企業はDocsieでコンテンツデザインフレームワークを一度設定し、それらの変更をすべての場所に適用できます。これは集中管理またはオーケストレーションとして知られています。各文書やページを個別に編集するプロセスは、小規模なコンテンツライブラリでは実行可能に思えるかもしれませんが、ライブラリが幅と深さで成長するにつれ、このプロセスは効率的にスケールしません。

要約すると、Docsieは低レベルの管理作業を最小限に抑えることで、コンテンツ管理ワークフローの将来性を確保します。スケールを念頭に置いて始めることで、大規模なコンテンツライブラリをシンプルに管理でき、コンテンツデザインフレームワークを一度設定し、Docsieですべての場所に展開できます。Docsie Managerを使用したDocsieカスタマイズドキュメンテーションハブの詳細はこちらでご確認いただけます。

文書ストレージの一元化

一元化に関連して、文書の保存場所は管理と公開のワークフローを助けたり妨げたりします。イントラネットやSharePointサイト、DropboxやGoogleドライブ、オンプレミスやクラウドストレージパーティションに文書を保存している場合があります。これらの選択肢はそれぞれ単独では機能しますが、同時に使用すると混乱を招く可能性があります。

ある従業員が文書にアクセスする必要があります。その文書はSharePointサイトに保存されています。従業員はそれをダウンロードし、自分のアカウントストレージパーティションに保存します。ビジネスのファイル同期ツールがこれを自動的にクラウドにアップロードします。従業員はSlackを通じて同僚に文書を送信します。これでITネットワーク上に同じ文書の4つのコピーが流通し、4つの異なるサービスやツールに分散されています。

Docsieは単一のストレージ場所に文書を一元化することで、この分散した混乱に対処します。文書をアップロードすると、Docsieはそれを「棚」に配置します。私たちは文書を「本」と呼び、各棚に本が並んでコンテンツライブラリを形成します。従業員はDocsieにログインして、すべての文書を見つけることができ、ロールベースのアクセス制御(RBAC)を使用して部門や役職によって関連する文書をフィルタリングできます。ここから従業員は文書をウェブサイトに直接公開したり、文書のテキストを編集したり、異なるバージョンを確認したり、顧客や同僚からのフィードバックを閲覧したりできます。

今では、従業員が文書にアクセスする必要があるとき、Docsieを開くだけです。文書を検索し、一般的なファイル形式でエクスポートし、Docsieの本や棚への直接リンクを共有できます。外部ユーザーについては、オーナーとアドミンがセキュリティを損なうことなく、承認されたDocsieの本と棚に直接アクセスするために招待できます。これはハードドライブ上のフォルダとファイルのようですが、Docsieの魔法が加わっています!Docsieの棚と本についての詳細はこちらでご確認いただけます。

文書のガバナンス、リスク、コンプライアンス

ほとんどの文書はパブリックドメイン用に作成されますが、一部の文書は機密情報である場合があります。これはガバナンス、リスク、コンプライアンス(GRC)管理の必要性を示しています。GRCポリシーは、機密文書へのアクセスを管理し、ライターと読者の文書権限を制御し、ドラフト段階での文書の誤った公開を防ぐために使用できます。

Docsieはロールベースのアクセス制御(RBAC)を使用してプラットフォーム上の権限を管理します。これはDocsieが役割に基づいてユーザー権限を定義し、役職や部門に基づいて権限を割り当てることで、企業がGRCワークフローを管理するのを支援する方法です。これらの役割には、閲覧者、編集者、管理者、オーナーが含まれます。閲覧者には文書の読み取り専用アクセス権が付与され、編集者には読み取りと書き込みの権限が付与されます。管理者は役割を割り当てて、本ごとまたは棚ごとに誰が読み取り、書き込み、またはその両方を許可されるかを管理できます。オーナーはDocsie組織内のすべてのユーザーと文書を管理でき、組織全体を削除できる唯一のユーザー役割です。この例では、組織はDocsieであり、棚にはDocsieのさまざまな機能に関する本が含まれています。

結論として、GRCは文書へのアクセス管理に重要です。アクセスが少なすぎると、従業員は文書の作業ができなくなります。アクセスが多すぎると、従業員が未完成の文書を誤って公開したり、エグゼクティブやマネージャー向けに予約されている機密文書にアクセスしたりする可能性があります。Docsieはアクセスとセキュリティのバランスを取るのに役立ち、あらゆるタイプの文書を保存するのに適したプラットフォームにします。

この文書は機密情報ですが、どのように不正アクセスを防止できますか?チームに書き込み権限を与え、他のチームには読み取り専用アクセスを与えるにはどうすればよいですか?フリーランスのライターがこの文書を編集する権限が必要です、どうすればよいですか?あなたの企業がこれらの質問をしているなら、Docsieに答えがあります!Docsieの権限管理についての詳細はこちらでご確認いただけます。

チームコラボレーション

コンテンツはめったに一人で作成されません。複数のライターが文書ライブラリに取り組んでいる場合、コラボレーションは不可欠です。

従業員が文書に取り組む際にどのようなプロセスに従っていますか?一例として、ネットワークドライブで既存の文書を検索し、コンピュータにダウンロードします。次に、ライターは最終ドラフトをメールで同僚に送信し、さらに校正してもらいます。承認されたドラフトはコンテンツ管理システム(CMS)にアップロードされ、公開の準備が整います。その日の後半に、誰かが問題に気づき、注釈付きのバージョンをSlack経由でライターに送り返します。このワークフローは機能するかもしれませんが、単純化できます。

Docsieは包括的なチームコラボレーション機能で必要なツールの数を減らします。Docsieで文書を見つけ、書き、編集し、チームメンバーと変更を共有し、チャットし、注釈を付け、Docsieダッシュボードから出ることなくインターネットに公開できます。これにより、ダウンロード、アップロード、メール、CMSの管理が不要になり、Docsieで文書を簡単に管理できます!チームメンバーは@メンションを使用してタグ付けでき、チャットの会話は各Docsieブックに分離され、外部のフリーランサーも簡単に招待でき、どこでも完全なチームコラボレーションが可能です。

必要なツールの数を最小限に抑えることで、従業員はソフトウェアを切り替えるのではなく、コンテンツの作成に集中できます。これにより無駄なクリックを最小限に抑え、右側のツールバーから同僚のコメントや提案に簡単にアクセスできるため、コンテンツ作成のワークフローが迅速化されます。リンクの共有、文書の古いバージョン、失われたメールやチャットメッセージはもうありません。文書に関するすべてのことがDocsieに一元化されています。

Docsieでドキュメントのベストプラクティスを適用する

紙からピクセルへと移行する中で、優れた文書管理は不可欠です。これらのベストプラクティスをデジタル文書に適用することで、企業はコンテンツワークフローを効率化し、コストを削減しながら、顧客に実質的な価値を提供する知識を作成・共有できます。唯一の疑問は、これらのベストプラクティスをどのように適用するかです。

そこでDocsieの出番です。Docsieはこれらの文書ベストプラクティスに基づいて設計されており、コンテンツの作成、管理、公開ワークフローを自動的に効率化します。このプラットフォームはあらゆる種類の文書と連携するように設計されており、一般的な企業のDMS要件に緊密に適合します。インポートとエクスポート時に、Docsie文書はオープンで互換性のあるファイル形式を使用してアクセシビリティを高めます。企業はDocsie Vocallyを使用して顧客の文書フィードバックを読み、対応し、知識の質を向上させ、コンテンツのエラーを減らすことができます。文書バージョン管理により、情報の冗長性のために過去のバージョンを保持できます。ブランディングとコンテンツデザインフレームワークはカスタマイズされた文書ハブで一度設定し、どこでも適用できます。すべてが一箇所、Docsieポータルに保存されているため、従業員はコンピュータ、クラウドドライブ、メールを検索する代わりに、すぐに文書を見つけることができます。権限を設定してGRCを管理し、機密文書への不正アクセスを防止できます。最後に、同僚はDocsieで集中的なチームコラボレーションのためにチャット、共有、リンク、添付、アクセス権の付与ができます。

顧客が喜ぶ文書を、複雑さなしに作成しましょう。あなたの企業がDMSソリューションを探しているなら、Docsieを試してみることを検討してください!当社の営業チームにお問い合わせいただければ、Docsieプラットフォームの15分間のデモをご案内します。


[1] <https://www.softwareadvice.com/cms/industryview/go-paperless-with-document-management-software/>

[2] <https://www.stopwaste.org/at-work/reduce-and-reuse/reduce-paper-use/the-impact-of-paper-waste#2>

[3] <https://fcw.com/articles/2013/08/08/va-data-breaches.aspx>

[4] <https://www.greenamerica.org/sites/default/files/inline-files/Paper%20Facts%202017.pdf>

[5] <https://www.zendesk.com/blog/searching-for-self-service/>

[6] <https://www.slideshare.net/UniWeb/the-total-economic-impact-of-click-to-call-and-click-to-chat>

[7] <https://download.microsoft.com/documents/en-us/dynamics/Global_State_of_Multichannel_Customer_Service_Report.pdf.pdf>

Related Articles

Ready to Transform Your Documentation?

Discover how Docsie's powerful platform can streamline your content workflow. Book a personalized demo today!

Book Your Free Demo
4.8 Stars (100+ Reviews)
Tal F

Tal F

VP of Customer Success @ Docsie