Você deve restringir o acesso aos seus guias do usuário online?

(ClickHelp) (16 de dezembro de 2020)

da ClickHelp – ferramenta de ajuda profissional para criação

Implementar guias do usuário protegidos por senha é algo que qualquer empresa pode precisar. Você pode perguntar por que alguém precisaria ocultar sua documentação de usuário online atrás de uma página de login? A resposta é simples. A documentação pode ser diferente. Digamos que falemos sobre um manual de máquina de café – tem que ser público. Quanto mais usuários tiverem acesso a ele, melhor. É assim que a empresa cuida de seus clientes. Mas se falamos sobre documentos internos que devem ser acessíveis a um número limitado de pessoas – a história é totalmente diferente. Um manual do funcionário ou manual de políticas e procedimentos deve ser público? Definitivamente não. Eles não se destinam ao uso público. Mas, ao mesmo tempo, eles deveriam estar online. É quando o acesso limitado à documentação é necessário.

Documentação técnica online: início

Como aconteceu que as pessoas começaram a usar a documentação online em vez da offline comum? Não muito tempo atrás, a documentação técnica era entregue assim: depois que os usuários instalavam um programa, eles recebiam documentos em PDF ou CHM. Nenhuma outra pessoa poderia obter os documentos, apenas usuários. Mais tarde, porém, os fornecedores perceberam que era inconveniente. O principal problema era atualizar os guias do usuário para não falar de outras desvantagens. E aí veio a documentação online trazendo uma variedade de melhorias. Confira a postagem a seguir para saber mais – Os manuais do usuário impressos serão extintos?

No início, os fornecedores criaram apenas algumas páginas sobre o produto – FAQs ou tutoriais, e eles eram acessíveis a todos. Algumas empresas obtiveram muitos benefícios com isso: efeito de SEO, desvio de caso para suporte técnico, etc. Outras empresas perceberam que alguns tipos de documentação técnica não deveriam ser acessíveis a todos: documentos para funcionários, parceiros, clientes, etc. Criação desses documentos público pode causar muitos problemas. Para limitar o acesso à documentação, os fornecedores começaram a usar um CMS – alguns deles com permissão para criar páginas protegidas por senha. A postagem a seguir fornecerá mais informações – Sistemas de gerenciamento de conteúdo para documentação técnica . Usar um CMS era bom para proteger apenas algumas páginas. Mas se você tivesse um manual enorme, usar um CMS não resolveria o problema. Soluções especializadas como ferramentas de criação de ajuda tornaram-se a melhor saída. Os mais avançados até permitiam que os fornecedores gerenciem usuários e suas funções, tanto com a ajuda de Single Sign-On (SSO) e tokens de login.

Single Sign-On e Manuais restritos

Em poucas palavras, usar SSO significa que você está usando uma ferramenta de terceiros para autenticar em qualquer lugar. Por exemplo, você pode usar sua conta do Google para fazer login no Facebook ou outros serviços. Portanto, o SSO evita que você crie credenciais e lembre-se delas sempre que quiser usar este ou aquele site ou aplicativo. Incrível, não é? A postagem a seguir contará mais sobre como a tecnologia SSO funciona – Single Sign-On for Dummies .

O mesmo mecanismo pode ser usado quando falamos sobre acesso à documentação. Ao encontrar um manual restrito , os usuários são redirecionados para a página de login automaticamente. Cabe a você decidir quais categorias de usuários terão permissão para visualizar as informações. Você pode dar acesso a todos os usuários autenticados em seu produto. Nesse caso, eles farão o login imediatamente. Ou você pode dar acesso aos usuários da versão comercial, por exemplo. Ou você pode dar acesso a testadores beta apenas se trabalhar na documentação de lançamento. Outro benefício além da proteção são estatísticas precisas. Conforme os usuários se autenticam para ler os documentos, você pode verificar quem exatamente visualizou este ou aquele tópico. Com base nisso, você pode criar diferentes tutoriais para usuários de diferentes segmentos.

Como criar documentação protegida por senha no ClickHelp?

Como uma ferramenta de documentação on-line moderna, o ClickHelp oferece várias maneiras de criar documentos protegidos por senha. O mais simples é o seguinte: o administrador do portal cria uma conta de usuário e especifica o que exatamente este ou aquele usuário pode visualizar no portal. Se você tiver dezenas de usuários e não quiser usar este procedimento para cada um deles, pode usar funções de leitor avançado para grupos de usuários. Eles terão acesso idêntico à sua documentação. Claro, se você tem centenas e milhares de usuários, precisa acelerar esse processo.Você pode usar a API para criar listas de usuários e dar a eles funções e acesso automaticamente. É possível integrar seu produto ao portal de documentação. Assim que um novo usuário aparece, seu sistema cria um novo usuário no portal de documentação.

Para produtos SaaS, a integração com SSO é a melhor solução – os usuários não terão que criar dois conjuntos de credenciais. E se você não estiver pronto para usar o SSO? No ClickHelp, você pode usar tokens de login. Eles são fáceis de implementar, mas tão confiáveis ​​quanto o SSO. Seu sistema mostrará não apenas links para documentos, mas links com parâmetros específicos – tokens. Eles informam ao portal que um determinado usuário pode acessar o manual. Além disso, os tokens podem ser usados ​​apenas uma vez e têm um período de validade. Portanto, não se pode simplesmente fornecer um token a outros usuários – não funcionará.

Conclusão

Definitivamente, o uso de documentação restrita é algo que qualquer empresa pode precisar. A coisa mais inteligente que você pode fazer é escolher a ferramenta de documentação de software que permitirá que você implemente isso. ClickHelp é a ferramenta certa para guias de usuário protegidos por senha. Ele permite que você crie documentos públicos e restritos em um portal, mostre diferentes conjuntos de documentos para diferentes usuários e obtenha as estatísticas mais precisas.

Boa sorte com sua redação técnica!
Equipe ClickHelp
Crie, hospede e forneça documentação em plataformas e dispositivos

Originalmente publicado em https://clickhelp.com .

Deixe uma resposta

O seu endereço de email não será publicado. Campos obrigatórios marcados com *