Korlátoznia kell-e az online felhasználói útmutatóihoz való hozzáférést?

(ClickHelp) (2020. december 16.)

a ClickHelp – professzionális súgószerző eszköz

A jelszóval védett felhasználói útmutatók megvalósításához minden vállalatnak szüksége lehet. Megkérdezheti, miért kell valakinek elrejteni online felhasználói dokumentációját egy bejelentkezési oldal mögött? A válasz egyszerű. A dokumentáció különböző lehet. Tegyük fel, hogy egy kávéfőző kézikönyvről beszélünk – annak nyilvánosnak kell lennie. Minél több felhasználó fér hozzá, annál jobb. A vállalat így gondoskodik ügyfeleiről. De ha belső dokumentumokról beszélünk, amelyeknek korlátozott számú ember számára hozzáférhetőnek kell lenniük – ez egy teljesen más történet. Nyilvánosnak kell-e lennie egy alkalmazott kézikönyve vagy házirendje és eljárási kézikönyve? Határozottan nem. Nem nyilvános használatra szánják őket. Ugyanakkor online állapotban kell lenniük. Ekkor korlátozott hozzáférés szükséges a dokumentációhoz.

Online műszaki dokumentáció: kezdet

Hogyan történt, hogy az emberek online dokumentációt kezdtek használni a közös offline dokumentáció helyett? Nem olyan régen a technikai dokumentációt így adták le: miután a felhasználók telepítettek egy programot, PDF vagy CHM dokumentumokat kaptak. Senki más nem kaphatta meg a dokumentumokat, csak a felhasználók. De később az árusok látták, hogy ez kellemetlen. A fő probléma a felhasználói útmutató frissítése volt, hogy más hátrányokról ne is beszéljünk. És itt jött az online dokumentáció, amely különféle fejlesztéseket hozott. További információért tekintse meg a következő bejegyzést – Kihalnak-e a nyomtatott felhasználói kézikönyvek?

Eleinte a gyártók csak néhány oldalt készítettek a termék – GYIK vagy oktatóanyagok, és mindenki számára elérhetőek voltak. Egyes vállalatok rengeteg előnyt kaptak: SEO-effektus, a technikai támogatás esetleges elhajlása stb. Más vállalatok rájöttek, hogy bizonyos típusú műszaki dokumentációknak nem szabad mindenki számára hozzáférhetőnek lenniük: dokumentumok alkalmazottaknak, partnereknek, ügyfeleknek stb. sok problémát okozhat. A dokumentációhoz való hozzáférés korlátozása érdekében a gyártók CMS-t kezdtek használni – némelyikük engedélyezte jelszóval védett oldalak létrehozását. A következő bejegyzés további információkat tartalmaz – Tartalomkezelő rendszerek a műszaki dokumentációhoz . A CMS használata jó volt, ha csak pár oldalt védett. De ha hatalmas kézikönyve lenne, a CMS használata nem oldhatja meg a problémát. Az olyan speciális megoldások, mint a help authoring tools lettek a legjobb kiút. A legfejlettebbek még a gyártók számára is lehetővé tették a felhasználók és szerepeik kezelését, egyszeri bejelentkezés (SSO) és bejelentkezési tokenek segítségével.

Egyszeri bejelentkezés és korlátozott kézikönyvek

Dióhéjban az egyszeri bejelentkezés használata azt jelenti, hogy harmadik féltől származó eszközt használ a hitelesítéshez mindenhol. Például Google-fiókjával bejelentkezhet a Facebook-ba vagy más szolgáltatásokba. Tehát az egyszeri bejelentkezés megóvja a hitelesítő adatok létrehozásától és azok emlékezésétől minden alkalommal, amikor ezt vagy azt a webhelyet vagy alkalmazást szeretné használni. Elképesztő, nem? A következő bejegyzés többet megtud az SSO technológia működéséről – Egyszeri bejelentkezés a bábukhoz .

Ugyanez a mechanizmus használható amikor a dokumentációhoz való hozzáférésről beszélünk. Ha egy korlátozott kézikönyvet talál, a felhasználókat a rendszer automatikusan átirányítja a bejelentkezési oldalra. Ön döntheti el, hogy a felhasználók mely kategóriái láthatják az információkat. Hozzáférést adhat a termékében hitelesített összes felhasználónak. Ebben az esetben azonnal bejelentkeznek. Vagy hozzáférést adhat például a kereskedelmi verzió felhasználói számára. Vagy csak akkor adhat hozzáférést a béta-tesztelőknek, ha a kiadási dokumentáción dolgozik. A védelem mellett egy másik előny a pontos statisztika. Amikor a felhasználók hitelesítik a dokumentumok elolvasását, ellenőrizhetik, hogy ki nézte meg pontosan ezt vagy azt a témát. Ennek alapján különböző oktatóanyagok készíthetők különböző szegmensekből álló felhasználók számára.

Hogyan hozhatunk létre jelszóval védett dokumentációt a ClickHelp-ben?

Modern online dokumentációs eszközként a ClickHelp sokféle lehetőséget kínál jelszóval védett dokumentumok létrehozására. A legegyszerűbb a következő: a portál rendszergazdája létrehoz egy felhasználói fiókot, és meghatározza, hogy ez vagy az a felhasználó mit nézhet meg pontosan a portálon. Ha több tucat felhasználója van, és nem akarja mindegyikükhöz használni ezt az eljárást, használhatja a teljesítményolvasó szerepköröket a felhasználók csoportjai számára. Ugyanolyan hozzáférést kapnak az Ön dokumentációjához. Természetesen, ha több száz és ezer felhasználóval rendelkezik, fel kell gyorsítania ezt a folyamatot.Az API segítségével létrehozhatja a felhasználók listáját, és automatikusan szerepeket és hozzáférést adhat nekik. A termék integrálható a dokumentációs portálba. Amint megjelenik egy új felhasználó, rendszere új felhasználót hoz létre a dokumentációs portálon.

A SaaS-termékek esetében az SSO-val való integrálás a legjobb megoldás – a felhasználóknak nem kell két hitelesítő adatsort készíteniük. Mi van, ha még nem áll készen az egyszeri bejelentkezés használatára? A ClickHelp alkalmazásban bejelentkezési tokeneket használhat. Könnyen megvalósíthatók, de ugyanolyan megbízhatóak, mint az egyszeri bejelentkezés. A rendszere nemcsak a dokumentumokhoz vezető linkeket, hanem a megadott paraméterekkel – tokenekkel – való kapcsolatokat is megmutatja. Tájékoztatják a portált, hogy egy adott felhasználó hozzáférhet a kézikönyvhöz. Ezenkívül a tokenek csak egyszer használhatók, és érvényességi idejük van. Tehát nem adhatunk egyszerűen más felhasználóknak tokent – ez nem fog működni.

Következtetés

A korlátozott dokumentumok használatára minden vállalatnak szüksége lehet. A legokosabb, amit tehet, az, hogy kiválasztja a szoftverdokumentációs eszközt, amely lehetővé teszi ennek megvalósítását. A ClickHelp a megfelelő eszköz a jelszóval védett felhasználói útmutatókhoz. Ez lehetővé teszi nyilvános és korlátozott dokumentumok létrehozását egy portálon, különböző dokumentumkészletek megmutatását a különböző felhasználók számára, és a legpontosabb statisztikák megszerzését.

Sok sikert a technikai íráshoz!
= “728a006b2d”>

ClickHelp Team
Szerző, tárolja és szállítja a dokumentációt platformokon és eszközökön keresztül

Eredetileg a https://clickhelp.com .

Vélemény, hozzászólás?

Az email címet nem tesszük közzé. A kötelező mezőket * karakterrel jelöltük