オンラインユーザーガイドへのアクセスを制限する必要がありますか?

(ClickHelp)(2020年12月16日)

by ClickHelp —プロフェッショナルヘルプオーサリングツール

パスワードで保護されたユーザーガイドの実装は、どの企業でも必要になる可能性があります。なぜ誰かがログインページの後ろにオンラインユーザードキュメントを隠す必要があるのか​​と疑問に思うかもしれません。答えは簡単です。ドキュメントは異なる場合があります。コーヒーメーカーのマニュアルについて話しているとしましょう。公開する必要があります。より多くのユーザーがそれにアクセスできるほど、より良いです。これは会社が顧客の世話をする方法です。しかし、限られた数の人がアクセスできるはずの内部ドキュメントについて話すと、それはまったく別の話です。従業員ハンドブックまたはポリシーと手順のマニュアルを公開する必要がありますか?絶対にありません。それらは公共の使用を目的としていません。しかし、同時に、それらはオンラインである必要があります。その場合、ドキュメントへのアクセスを制限する必要があります。

オンライン技術文書:はじめに

一般的なオフライン文書ではなく、オンライン文書を使用し始めたのはどうしてですか。少し前まで、技術文書はそのように提供されていました。ユーザーがプログラムをインストールした後、PDFまたはCHMの文書を入手しました。他の人はドキュメントを取得できず、ユーザーだけが取得できました。しかし後で、ベンダーはそれが不便であることに気づきました。主な問題は、他の欠点は言うまでもなく、ユーザーガイドを更新することでした。そして、さまざまな改善をもたらすオンラインドキュメントが登場しました。詳細については、次の投稿を確認してください— 印刷されたユーザーマニュアルは消滅しますか?

最初、ベンダーは、製品— FAQまたはチュートリアルであり、誰でもアクセスできました。 SEO効果、テクニカルサポートのケースの偏向など、多くのメリットを享受している企業もあります。他の企業は、従業員、パートナー、クライアントなどのドキュメントなど、ある種の技術ドキュメントに誰もがアクセスできるわけではないことに気づきました。公衆は多くの問題を引き起こす可能性があります。ドキュメントへのアクセスを制限するために、ベンダーはCMSの使用を開始しました。一部のベンダーは、パスワードで保護されたページの作成を許可していました。次の投稿で詳細を確認できます— 技術文書のコンテンツ管理システム。 CMSを使用することは、数ページだけを保護するのに適していました。しかし、巨大なマニュアルがある場合、CMSを使用しても問題を解決できませんでした。 ヘルプオーサリングツールのような特殊なソリューションが最善の方法になりました。最も高度なものでは、ベンダーはシングルサインオン(SSO)とログイントークンの両方を使用して、ユーザーとその役割を管理することもできました。

シングルサインオンと制限付きマニュアル

簡単に言うと、SSOを使用するということは、サードパーティのツールを使用してあらゆる場所で認証を行うことを意味します。たとえば、Googleアカウントを使用してFacebookやその他のサービスにログインできます。したがって、SSOを使用すると、資格情報を作成して、このWebサイトまたはアプリケーションを使用するたびに資格情報を記憶する必要がなくなります。すごいですね。次の投稿では、SSOテクノロジーの仕組みについて詳しく説明します— ダミーのシングルサインオン

同じメカニズムを使用できます。ドキュメントへのアクセスについて話すとき。 制限付きマニュアルを見つけると、ユーザーは自動的にログインページにリダイレクトされます。どのカテゴリのユーザーが情報を表示できるかを決定するのはあなた次第です。製品で認証されたすべてのユーザーにアクセスを許可できます。この場合、彼らはすぐにログインします。または、たとえば、商用バージョンのユーザーにアクセスを許可することもできます。または、リリースドキュメントで作業している場合にのみ、ベータテスターへのアクセスを許可できます。保護以外のもう1つの利点は、正確な統計です。ユーザーがドキュメントを読むために認証するときに、誰がこのトピックまたはそのトピックを正確に表示したかを確認できます。これに基づいて、さまざまなセグメントのユーザー向けにさまざまなチュートリアルを作成できます。

ClickHelpでパスワードで保護されたドキュメントを作成する方法

最新のオンラインドキュメントツールとして、ClickHelpはパスワードで保護されたドキュメントを作成する多くの方法を提供します。最も簡単なことは次のとおりです。ポータル管理者はユーザーアカウントを作成し、これまたはそのユーザーがポータルで表示できるものを正確に指定します。数十人のユーザーがいて、それぞれにこの手順を使用したくない場合は、ユーザーのグループにパワーリーダーの役割を使用できます。彼らはあなたのドキュメントに同じようにアクセスできるようになります。もちろん、数百、数千のユーザーがいる場合は、このプロセスを高速化する必要があります。APIを使用して、ユーザーのリストを作成し、ユーザーに役割とアクセスを自動的に与えることができます。製品をドキュメントポータルと統合することが可能です。新しいユーザーが表示されるとすぐに、システムはドキュメントポータルに新しいユーザーを作成します。

SaaS製品の場合、SSOとの統合が最善のソリューションです。ユーザーは2セットの資格情報を作成する必要はありません。 SSOを使用する準備ができていない場合はどうなりますか? ClickHelpでは、ログイントークンを使用できます。実装は簡単ですが、SSOと同じくらい信頼できます。システムには、ドキュメントへのリンクだけでなく、特定のパラメーター(トークン)を持つリンクも表示されます。特定のユーザーがマニュアルにアクセスできることをポータルに通知します。また、トークンは1回のみ使用でき、有効期間があります。したがって、単に他のユーザーにトークンを提供することはできません。トークンは機能しません。

結論

確かに、制限されたドキュメントの使用は、どの企業でも必要になる可能性があります。あなたができる最も賢いことは、それを実装することを可能にするソフトウェアドキュメンテーションツールを選択することです。 ClickHelpは、パスワードで保護されたユーザーガイドに適したツールです。 1つのポータルで公開ドキュメントと制限付きドキュメントの両方を作成し、さまざまなユーザーにさまざまなドキュメントセットを表示し、最も正確な統計を取得できます。

テクニカルライティングを頑張ってください!

クリックヘルプチーム
プラットフォームやデバイス間でドキュメントを作成、ホスト、配信

元々は https://clickhelp.com

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です