Moet u de toegang tot uw online gebruikershandleidingen beperken?

(ClickHelp) (16 dec 2020)

door ClickHelp – professionele hulp bij het schrijven van tools

Het implementeren van met een wachtwoord beveiligde gebruikershandleidingen is iets dat elk bedrijf nodig kan hebben. U vraagt ​​zich misschien af ​​waarom iemand zijn online gebruikersdocumentatie achter een inlogpagina zou moeten verbergen? Het antwoord is simpel. Documentatie kan verschillen. Laten we zeggen dat we het hebben over een handleiding voor een koffiemachine – die moet openbaar zijn. Hoe meer gebruikers er toegang toe hebben, hoe beter. Dit is hoe het bedrijf voor zijn klanten zorgt. Maar als we het hebben over interne documenten die voor een beperkt aantal mensen toegankelijk moeten zijn, is dat een heel ander verhaal. Moet een personeelshandboek of een beleids- en procedurehandboek openbaar zijn? Zeker niet. Ze zijn niet bedoeld voor openbaar gebruik. Maar tegelijkertijd zouden ze online moeten zijn. Dat is het moment waarop beperkte toegang tot documentatie vereist is.

Online technische documentatie: begin

Hoe kwam het dat mensen online documentatie begonnen te gebruiken in plaats van de gebruikelijke offline documentatie? Nog niet zo lang geleden werd technische documentatie zo aangeleverd: nadat gebruikers een programma hadden geïnstalleerd, kregen ze pdf- of CHM-documenten. Geen andere mensen konden de documenten krijgen, alleen gebruikers. Maar later zagen verkopers dat het lastig was. Het grootste probleem was het bijwerken van de gebruikershandleidingen om nog maar te zwijgen van andere nadelen. En hier kwam online documentatie met een verscheidenheid aan verbeteringen. Bekijk het volgende bericht voor meer informatie – Zullen gedrukte gebruikershandleidingen uitsterven?

Aanvankelijk creëerden leveranciers slechts een paar paginas over de product – Veelgestelde vragen of tutorials, en ze waren voor iedereen toegankelijk. Sommige bedrijven hebben daar veel voordelen van: SEO-effect, case deflection voor technische ondersteuning, etc. Andere bedrijven realiseerden zich dat sommige soorten technische documentatie niet voor iedereen toegankelijk zouden moeten zijn: documenten voor werknemers, partners, klanten, enz. Het maken van deze documenten public kan veel problemen veroorzaken. Om de toegang tot documentatie te beperken, begonnen leveranciers een CMS te gebruiken – sommigen van hen mochten met een wachtwoord beveiligde paginas maken. Het volgende bericht geeft je meer informatie – Content Management Systemen voor technische documentatie . Het gebruik van een CMS was goed om slechts een paar paginas te beschermen. Maar als je een enorme handleiding had, kon het gebruik van een CMS het probleem niet oplossen. Gespecialiseerde oplossingen zoals helpen bij het schrijven van tools werden de beste uitweg. Met de meest geavanceerde versies konden leveranciers zelfs gebruikers en hun rollen beheren, beide met behulp van Single Sign-On (SSO) en login-tokens.

Single Sign-On en beperkte handleidingen

Kort samengevat, SSO gebruiken betekent dat u een tool van derden gebruikt om overal te authenticeren. U kunt bijvoorbeeld uw Google-account gebruiken om in te loggen op Facebook of andere services. SSO zorgt er dus voor dat u geen inloggegevens hoeft aan te maken en deze elke keer dat u deze of gene website of applicatie wilt gebruiken, moet onthouden. Verbazingwekkend, is dat niet? Het volgende bericht zal je meer vertellen over hoe de SSO-technologie werkt – Single Sign-On voor Dummies .

Hetzelfde mechanisme kan worden gebruikt als we het hebben over toegang tot documentatie. Door een beperkte handleiding te vinden, worden gebruikers automatisch omgeleid naar de inlogpagina. Het is aan jou om te beslissen welke categorieën gebruikers de informatie mogen bekijken. U kunt toegang geven aan alle gebruikers die in uw product zijn geauthenticeerd. In dat geval loggen ze meteen in. Of u kunt bijvoorbeeld toegang geven aan gebruikers van commerciële versies. Of u kunt alleen toegang geven tot bètatesters als u aan release-documentatie werkt. Een ander voordeel naast bescherming zijn nauwkeurige statistieken. Terwijl gebruikers zich verifiëren om de documenten te lezen, kunt u controleren wie dit of dat onderwerp precies heeft bekeken. Op basis hiervan kunt u verschillende tutorials maken voor gebruikers uit verschillende segmenten.

Hoe maak je met een wachtwoord beveiligde documentatie aan in ClickHelp?

Als een modern online documentatiehulpmiddel biedt ClickHelp veel manieren om met een wachtwoord beveiligde documenten te maken. Het eenvoudigste is het volgende: de portalbeheerder maakt een gebruikersaccount aan en geeft aan wat deze of die gebruiker precies in de portal kan zien. Als u tientallen gebruikers heeft en u deze procedure niet voor elk van hen wilt gebruiken, kunt u power reader-rollen gebruiken voor groepen gebruikers. Ze krijgen identieke toegang tot uw documentatie. Als u honderden en duizenden gebruikers heeft, moet u dit proces natuurlijk versnellen.U kunt API gebruiken om lijsten met gebruikers te maken en ze automatisch rollen en toegang te geven. Het is mogelijk om uw product te integreren met het documentatieportaal. Zodra een nieuwe gebruiker verschijnt, maakt uw systeem een ​​nieuwe gebruiker aan in het documentatieportaal.

Voor SaaS-producten is integratie met SSO de beste oplossing – gebruikers hoeven niet twee sets inloggegevens aan te maken. Wat moet u doen als u nog niet klaar bent om SSO te gebruiken? In ClickHelp kunt u inlogtokens gebruiken. Ze zijn eenvoudig te implementeren, maar net zo betrouwbaar als SSO. Uw systeem toont niet alleen links naar documenten, maar ook links met specifieke parameters – tokens. Ze informeren het portaal dat een bepaalde gebruiker toegang heeft tot de handleiding. Bovendien kunnen tokens slechts een keer worden gebruikt en hebben ze een geldigheidsduur. Je kunt dus niet zomaar andere gebruikers een token geven – het zal niet werken.

Conclusie

Zeker, het gebruik van beperkte documentatie is iets dat elk bedrijf nodig kan hebben. Het slimste dat u kunt doen, is de softwaredocumentatietool kiezen waarmee u dat kunt implementeren. ClickHelp is de juiste tool voor gebruikershandleidingen met wachtwoordbeveiliging. Hiermee kunt u zowel openbare als beperkte documenten in één portaal maken, verschillende sets documenten aan verschillende gebruikers tonen en de meest nauwkeurige statistieken verkrijgen.

Veel succes met uw technische schrijven!
ClickHelp-team
Auteur, host en lever documentatie op verschillende platforms en apparaten

Oorspronkelijk gepubliceerd op https://clickhelp.com .

Geef een reactie

Het e-mailadres wordt niet gepubliceerd. Vereiste velden zijn gemarkeerd met *