Měli byste omezit přístup ke svým online uživatelským příručkám?

(ClickHelp) (16. prosince 2020)

od ClickHelp – nástroj pro vytváření profesionální pomoci

Implementace uživatelských příruček chráněných heslem je něco, co může každá společnost potřebovat. Možná se ptáte, proč by někdo musel skrývat svou online uživatelskou dokumentaci za přihlašovací stránku? Odpověď je jednoduchá. Dokumentace se může lišit. Řekněme, že mluvíme o manuálu k kávovaru – musí být veřejný. Čím více uživatelů k tomu má přístup, tím lépe. Takto se společnost stará o své klienty. Ale když mluvíme o interních dokumentech, které by měly být přístupné omezenému počtu lidí – je to úplně jiný příběh. Měla by být příručka pro zaměstnance nebo příručka pro zásady a postupy veřejná? Určitě ne. Nejsou určeny pro veřejné použití. Zároveň by však měly být online. Tehdy je vyžadován omezený přístup k dokumentaci.

Technická dokumentace online: Začátek

Jak se stalo, že lidé začali používat online dokumentaci místo běžné offline? Není to tak dávno, co byla dodána technická dokumentace takto: poté, co uživatelé nainstalovali program, dostali dokumenty PDF nebo CHM. Žádní další lidé nemohli získat dokumenty, pouze uživatelé. Ale později prodejci zjistili, že je to nepohodlné. Hlavním problémem bylo aktualizovat uživatelské příručky, aby nemluvily o dalších nevýhodách. A tady přišla online dokumentace, která přináší řadu vylepšení. Podívejte se na následující příspěvek a dozvíte se více – Vymizí tištěné uživatelské příručky?

Prodejci zpočátku vytvořili pouze několik stránek o produkt – často kladené dotazy nebo návody a byly přístupné všem. Některé společnosti z toho získaly mnoho výhod: SEO efekt, odklon případu pro technickou podporu atd. Jiné společnosti si uvědomily, že některé druhy technické dokumentace by neměly být přístupné všem: dokumenty pro zaměstnance, partnery, klienty atd. Tvorba těchto dokumentů veřejnost může způsobit spoustu problémů. Pro omezení přístupu k dokumentaci začali prodejci používat CMS – někteří z nich mohli vytvářet stránky chráněné heslem. Následující příspěvek vám poskytne další informace – Systémy pro správu obsahu pro technickou dokumentaci . Použití CMS bylo dobré chránit pouze pár stránek. Pokud jste ale měli obrovskou příručku, použití CMS by problém nevyřešilo. Nejlepší cestou se staly specializované řešení, jako je nástroje pro vytváření obsahu . Ti nejpokročilejší dokonce dodavatelům umožnili spravovat uživatele a jejich role, a to jak pomocí jednotného přihlášení (SSO), tak přihlašovacích tokenů.

Single Sign-On a Restricted Manuals

Stručně řečeno, použití jednotného přihlášení znamená, že k ověření všude používáte nástroj jiného výrobce. Například můžete použít svůj účet Google k přihlášení k Facebooku nebo jiným službám. Jednotné přihlášení vám tedy ušetří vytváření pověření a jejich zapamatování pokaždé, když budete chtít použít ten či onen web nebo aplikaci. Úžasné, že? Následující příspěvek vám řekne více o tom, jak technologie SSO funguje – Single Sign-On for Dummies .

Stejný mechanismus lze použít když mluvíme o přístupu k dokumentaci. Po nalezení omezeného manuálu jsou uživatelé automaticky přesměrováni na přihlašovací stránku. Je pouze na vás, které kategorie uživatelů budou mít přístup k informacím. Můžete dát přístup všem uživatelům ověřeným ve vašem produktu. V takovém případě se hned přihlásí. Nebo můžete dát přístup například uživatelům komerční verze. Nebo můžete beta testerům poskytnout přístup, pouze pokud pracujete na dokumentaci k vydání. Další výhodou kromě ochrany jsou přesné statistiky. Když se uživatelé při čtení dokumentů autentizují, můžete zkontrolovat, kdo přesně si prohlédl toto nebo dané téma. Na základě toho můžete vytvořit různé výukové programy pro uživatele z různých segmentů.

Jak vytvořit dokumentaci chráněnou heslem v ClickHelp?

ClickHelp jako moderní online dokumentační nástroj nabízí mnoho způsobů vytváření dokumentů chráněných heslem. Nejjednodušší věc je následující: administrátor portálu vytvoří uživatelský účet a určí, co přesně tento nebo ten uživatel může na portálu zobrazit. Pokud máte desítky uživatelů a nechcete použít tento postup pro každého z nich, můžete pro skupiny uživatelů použít role čtečky energie . Budou mít stejný přístup k vaší dokumentaci. Samozřejmě, pokud máte stovky a tisíce uživatelů, musíte tento proces urychlit.Pomocí rozhraní API můžete vytvářet seznamy uživatelů a automaticky jim přidělovat role a přístup. Je možné integrovat váš produkt s dokumentačním portálem. Jakmile se objeví nový uživatel, váš systém vytvoří nového uživatele na portálu dokumentace.

U produktů SaaS je nejlepším řešením integrace s jednotným přihlášením – uživatelé nebudou muset vytvářet dvě sady pověření. Co když nejste připraveni použít SSO? V ClickHelp můžete použít přihlašovací tokeny. Jsou snadno implementovatelné, ale stejně důvěryhodné jako SSO. Váš systém bude zobrazovat nejen odkazy na dokumenty, ale také odkazy se specifickými parametry – tokeny. Informují portál, že konkrétní uživatel má přístup k příručce. Tokeny lze navíc použít pouze jednou a mají dobu platnosti. Nelze tedy jednoduše poskytnout ostatním uživatelům token – nebude to fungovat.

Závěr

Použití omezené dokumentace je určitě něco, co může každá společnost potřebovat. Nejchytřejší věcí, kterou můžete udělat, je zvolit nástroj pro dokumentaci softwaru, který vám to umožní implementovat. ClickHelp je správný nástroj pro uživatelské příručky chráněné heslem. Umožňuje vám vytvářet veřejné i omezené dokumenty na jednom portálu, zobrazovat různé sady dokumentů různým uživatelům a získat nejpřesnější statistiky.

Hodně štěstí při technickém psaní!
ClickHelp Team
Autor, hostujte a doručujte dokumentaci napříč platformami a zařízeními

Původně publikováno v https://clickhelp.com .

Napsat komentář

Vaše e-mailová adresa nebude zveřejněna. Vyžadované informace jsou označeny *