Ska du begränsa åtkomst till dina online-användarhandböcker?

(ClickHelp) (16 dec 2020)

av ClickHelp – verktyg för redigering av professionell hjälp

Att implementera lösenordsskyddade användarhandböcker är något som alla företag kan behöva. Du kan fråga varför någon skulle behöva gömma sin användardokumentation online bakom en inloggningssida? Svaret är enkelt. Dokumentationen kan vara annorlunda. Låt oss säga att vi pratar om en kaffemaskinhandbok – den måste vara offentlig. Ju fler användare har tillgång till det, desto bättre. Så här tar företaget hand om sina kunder. Men om vi pratar om interna dokument som ska vara tillgängliga för ett begränsat antal människor – så är det en helt annan historia. Bör en anställds handbok eller policy och procedurmanual vara offentlig? Definitivt inte. De är inte avsedda för allmän användning. Men samtidigt borde de vara online. Det är då begränsad åtkomst till dokumentation krävs.

Online teknisk dokumentation: Börjar

Hur hände det att människor började använda online-dokumentation istället för den vanliga offline? För inte så länge sedan levererades teknisk dokumentation så: efter att användare installerat ett program fick de PDF- eller CHM-dokument. Inga andra människor kunde få dokumenten, bara användare. Men senare såg leverantörerna att det var obekvämt. Huvudproblemet var att uppdatera användarhandböckerna för att inte säga något om andra nackdelar. Och här kom online-dokumentation med olika förbättringar. Kolla in följande inlägg för att lära dig mer – Kommer tryckta användarmanualer att utrotas?

Först skapade leverantörer bara några sidor om produkt – Vanliga frågor eller handledning, och de var tillgängliga för alla. Vissa företag fick många fördelar med det: SEO-effekt, fallböjning för teknisk support etc. Andra företag insåg att någon form av teknisk dokumentation inte borde vara tillgänglig för alla: dokument för anställda, partners, kunder osv. Att göra dessa dokument allmänheten kan orsaka många problem. För att begränsa tillgången till dokumentation började leverantörer använda ett CMS – några av dem fick skapa lösenordsskyddade sidor. Följande inlägg ger dig mer information – Innehållshanteringssystem för teknisk dokumentation . Att använda ett CMS var bra för att bara skydda ett par sidor. Men om du hade en enorm handbok kunde inte CMS lösa problemet. Specialiserade lösningar som hjälper redigeringsverktyg att bli den bästa vägen. De mest avancerade tillät till och med leverantörer att hantera användare och deras roller, både med hjälp av enkel inloggning (SSO) och inloggningstoken.

Enkel inloggning och begränsade handböcker

I ett nötskal betyder SSO att du använder ett verktyg från tredje part för att autentisera överallt. Du kan till exempel använda ditt Google-konto för att logga in på Facebook eller andra tjänster. Så, SSO sparar dig från att skapa referenser och komma ihåg dem varje gång du vill använda den här eller den här webbplatsen eller applikationen. Fantastiskt, eller hur? Följande inlägg berättar mer om hur SSO-tekniken fungerar – Single Sign-On for Dummies .

Samma mekanism kan användas när vi pratar om tillgång till dokumentation. Hitta en begränsad manual , omdirigeras användare automatiskt till inloggningssidan. Det är upp till dig att bestämma vilka kategorier av användare som får se informationen. Du kan ge åtkomst till alla användare som är autentiserade i din produkt. I det här fallet loggar de in direkt. Eller så kan du till exempel ge åtkomst till kommersiella versionanvändare. Eller så kan du bara ge åtkomst till betatestare om du arbetar med utgivningsdokumentation. En annan fördel förutom skydd är exakt statistik. När användare autentiserar sig för att läsa dokumenten kan du kontrollera vem som exakt har sett det här eller det här ämnet. Baserat på detta kan du skapa olika handledning för användare från olika segment.

Hur man skapar lösenordsskyddad dokumentation i ClickHelp?

Som ett modernt online-dokumentationsverktyg erbjuder ClickHelp många sätt att skapa lösenordsskyddade dokument. Det enklaste är följande: portaladministratören skapar ett användarkonto och anger vad exakt den här eller den andra användaren kan se i portalen. Om du har dussintals användare och inte vill använda den här proceduren för var och en av dem kan du använda power reader-roller för grupper av användare. De kommer att ha identisk tillgång till din dokumentation. Naturligtvis, om du har hundratusentals användare, måste du påskynda denna process.Du kan använda API för att skapa listor över användare och ge dem roller och åtkomst automatiskt. Det är möjligt att integrera din produkt med dokumentationsportalen. Så snart en ny användare dyker upp skapar ditt system en ny användare i dokumentationsportalen.

För SaaS-produkter är integration med SSO den bästa lösningen – användare behöver inte skapa två uppsättningar referenser. Vad händer om du inte är redo att använda SSO? I ClickHelp kan du använda inloggningstoken. De är lätta att implementera men lika pålitliga som SSO. Ditt system visar inte bara länkar till dokument utan länkar med specifika parametrar – tokens. De informerar portalen om att en viss användare kan komma åt manualen. Dessutom kan tokens endast användas en gång och de har en giltighetsperiod. Så man kan inte bara ge andra användare en token – det fungerar inte.

Slutsats

Definitivt är användningen av begränsad dokumentation något som alla företag kan behöva. Det smartaste du kan göra är att välja programdokumentationsverktyget som gör att du kan implementera det. ClickHelp är rätt verktyg för lösenordsskyddade användarhandböcker. Det låter dig skapa både offentliga och begränsade dokument i en portal, visa olika uppsättningar dokument till olika användare och få den mest exakta statistiken.

Lycka till med ditt tekniska skrivande!
ClickHelp Team
Författare, värd och leverera dokumentation över plattformar och enheter

Ursprungligen publicerad på https://clickhelp.com .

Lämna ett svar

Din e-postadress kommer inte publiceras. Obligatoriska fält är märkta *