Sollten Sie den Zugriff auf Ihre Online-Benutzerhandbücher einschränken?

(ClickHelp) (16. Dezember 2020)

von ClickHelp – professionelles Hilfe-Authoring-Tool

Die Implementierung kennwortgeschützter Benutzerhandbücher ist möglicherweise etwas, das jedes Unternehmen benötigt. Sie fragen sich vielleicht, warum jemand seine Online-Benutzerdokumentation hinter einer Anmeldeseite verstecken müsste? Die Antwort ist einfach. Die Dokumentation kann unterschiedlich sein. Nehmen wir an, wir sprechen über ein Kaffeemaschinenhandbuch – es muss öffentlich sein. Je mehr Benutzer Zugriff darauf haben, desto besser. So kümmert sich das Unternehmen um seine Kunden. Wenn wir jedoch über interne Dokumente sprechen, die nur einer begrenzten Anzahl von Personen zugänglich sein sollten, ist das eine ganz andere Geschichte. Sollte ein Mitarbeiterhandbuch oder ein Richtlinien- und Verfahrenshandbuch öffentlich sein? Definitiv nicht. Sie sind nicht für den öffentlichen Gebrauch bestimmt. Gleichzeitig sollten sie jedoch online sein. In diesem Fall ist ein eingeschränkter Zugriff auf die Dokumentation erforderlich.

Technische Online-Dokumentation: Beginn

Wie kam es, dass Benutzer Online-Dokumentation anstelle der üblichen Offline-Dokumentation verwendeten? Vor nicht allzu langer Zeit wurde die technische Dokumentation so geliefert: Nachdem Benutzer ein Programm installiert hatten, erhielten sie PDF- oder CHM-Dokumente. Keine anderen Personen konnten die Dokumente erhalten, nur Benutzer. Später sahen die Anbieter jedoch, dass dies unpraktisch war. Das Hauptproblem bestand darin, die Benutzerhandbücher zu aktualisieren, um nichts von anderen Nachteilen zu sagen. Und hier kam die Online-Dokumentation mit einer Reihe von Verbesserungen. Weitere Informationen finden Sie im folgenden Beitrag: Werden gedruckte Benutzerhandbücher aussterben?

Zunächst erstellten die Anbieter nur wenige Seiten über die Produkt – FAQs oder Tutorials, und sie waren für alle zugänglich. Einige Unternehmen haben viele Vorteile daraus gezogen: SEO-Effekt, Ablenkung der Fälle für technischen Support usw. Andere Unternehmen haben erkannt, dass einige Arten von technischer Dokumentation nicht für jedermann zugänglich sein sollten: Dokumente für Mitarbeiter, Partner, Kunden usw. Erstellen dieser Dokumente Öffentlichkeit könnte viele Probleme verursachen. Um den Zugriff auf Dokumentation einzuschränken, begannen Anbieter, ein CMS zu verwenden. Einige von ihnen durften passwortgeschützte Seiten erstellen. Der folgende Beitrag enthält weitere Informationen: Content-Management-Systeme für die technische Dokumentation . Die Verwendung eines CMS war gut, um nur einige Seiten zu schützen. Wenn Sie jedoch ein umfangreiches Handbuch hätten, könnte die Verwendung eines CMS das Problem nicht lösen. Spezielle Lösungen wie helfen beim Erstellen von Tools wurden zum besten Ausweg. Die fortschrittlichsten ermöglichten es Anbietern sogar, Benutzer und ihre Rollen mithilfe von Single Sign-On (SSO) und Anmeldetoken zu verwalten.

Single Sign-On- und eingeschränkte Handbücher

Kurz gesagt bedeutet die Verwendung von SSO, dass Sie ein Tool eines Drittanbieters verwenden, um sich überall zu authentifizieren. Sie können beispielsweise Ihr Google-Konto verwenden, um sich bei Facebook oder anderen Diensten anzumelden. SSO erspart Ihnen also das Erstellen und Speichern von Anmeldeinformationen, wenn Sie diese oder jene Website oder Anwendung verwenden möchten. Erstaunlich, nicht wahr? Im folgenden Beitrag erfahren Sie mehr über die Funktionsweise der SSO-Technologie: Single Sign-On für Dummies .

Der gleiche Mechanismus kann verwendet werden wenn wir über Dokumentationszugriff sprechen. Wenn Benutzer ein eingeschränktes Handbuch finden, werden Benutzer automatisch zur Anmeldeseite weitergeleitet. Es liegt an Ihnen, zu entscheiden, welche Benutzerkategorien die Informationen anzeigen dürfen. Sie können allen in Ihrem Produkt authentifizierten Benutzern Zugriff gewähren. In diesem Fall melden sie sich sofort an. Sie können beispielsweise Benutzern kommerzieller Versionen Zugriff gewähren. Sie können Beta-Testern nur dann Zugriff gewähren, wenn Sie an der Release-Dokumentation arbeiten. Ein weiterer Vorteil neben dem Schutz ist die genaue Statistik. Wenn sich Benutzer zum Lesen der Dokumente authentifizieren, können Sie überprüfen, wer genau dieses oder jenes Thema angezeigt hat. Auf dieser Grundlage können Sie verschiedene Tutorials für Benutzer aus verschiedenen Segmenten erstellen.

So erstellen Sie eine passwortgeschützte Dokumentation in ClickHelp?

Als modernes Online-Dokumentationswerkzeug bietet ClickHelp viele Möglichkeiten zum Erstellen passwortgeschützter Dokumente. Am einfachsten ist Folgendes: Der Portaladministrator erstellt ein Benutzerkonto und gibt an, was genau dieser oder jener Benutzer im Portal anzeigen kann. Wenn Sie Dutzende von Benutzern haben und dieses Verfahren nicht für jeden von ihnen verwenden möchten, können Sie für Benutzergruppen Power Reader-Rollen verwenden. Sie haben identischen Zugriff auf Ihre Dokumentation. Wenn Sie Hunderte und Tausende von Benutzern haben, müssen Sie diesen Prozess natürlich beschleunigen.Mithilfe der API können Sie Benutzerlisten erstellen und ihnen Rollen und Zugriff automatisch zuweisen. Es ist möglich, Ihr Produkt in das Dokumentationsportal zu integrieren. Sobald ein neuer Benutzer angezeigt wird, erstellt Ihr System einen neuen Benutzer im Dokumentationsportal.

Für SaaS-Produkte ist die Integration in SSO die beste Lösung. Benutzer müssen nicht zwei Sätze von Anmeldeinformationen erstellen. Was ist, wenn Sie nicht bereit sind, SSO zu verwenden? In ClickHelp können Sie Anmeldetoken verwenden. Sie sind einfach zu implementieren, aber genauso vertrauenswürdig wie SSO. Ihr System zeigt nicht nur Links zu Dokumenten an, sondern auch Links zu bestimmten Parametern – Token. Sie informieren das Portal, dass ein bestimmter Benutzer auf das Handbuch zugreifen kann. Darüber hinaus können Token nur einmal verwendet werden und haben eine Gültigkeitsdauer. Man kann anderen Benutzern also nicht einfach ein Token zur Verfügung stellen – es funktioniert nicht.

Schlussfolgerung

Auf jeden Fall ist die Verwendung eingeschränkter Dokumentation etwas, das jedes Unternehmen möglicherweise benötigt. Am klügsten können Sie das Softwaredokumentationstool auswählen, mit dem Sie dies implementieren können. ClickHelp ist das richtige Tool für kennwortgeschützte Benutzerhandbücher. Sie können damit sowohl öffentliche als auch eingeschränkte Dokumente in einem Portal erstellen, verschiedenen Benutzern unterschiedliche Dokumentensätze anzeigen und die genauesten Statistiken erhalten.

Viel Glück beim technischen Schreiben!
ClickHelp-Team
Verfassen, Hosten und Bereitstellen von Dokumentation über Plattformen und Geräte hinweg

Ursprünglich veröffentlicht unter https://clickhelp.com .

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.