Os recursos de documentação e conhecimento economizam dinheiro das organizações, aumentam a satisfação do cliente e aumentam a adoção e a fidelidade do produto. Com a documentação adequada, os help desks podem oferecer suporte ao cliente consistente e oportuno e capacitar os usuários a expandir seus recursos com um produto de software.
Mas, apesar de sua importância, a documentação pode ser problemática para projetos de DevOps. Paradigmas de desenvolvimento iterativo produzir alterações e atualizações frequentes, e traduzi-las em documentação oportuna exige atenção constante aos detalhes para evitar a introdução de erros e lacunas de conhecimento. As equipes de DevOps devem adotar as práticas e ferramentas necessárias para fornecer documentação de software atualizada e abrangente ao suporte técnico.
Funções modernas de help desk
Os help desks são o primeiro ponto de contato entre um usuário e os recursos de uma organização. Na maioria dos casos, os help desks oferecem suporte para a infraestrutura, endpoints e aplicativos que uma empresa oferece à sua clientela. Existem três tipos principais de help desk:
- Help Desks de suporte de TI são voltados para dentro e ajudam a organização funcionários com uma ampla gama de problemas de hardware e software. Os exemplos incluem redefinições de senha, uso de recursos da empresa – como impressoras, laptops e outros dispositivos de endpoint atribuídos – e tarefas complexas, como resolver problemas de rede.
- Central de atendimento ao cliente normalmente oferecem suporte a usuários externos, como parceiros de negócios, no uso de um produto ou serviço pago pelo cliente – por exemplo, uma oferta de SaaS baseada em assinatura. Isso limita o escopo da assistência que os balcões de atendimento ao cliente podem fornecer.
- Central de atendimento para empresas são outro recurso interno que fornece serviços específicos de negócios aos funcionários e são operados por uma equipe que não é de TI, como finanças, RH, jurídico ou vendas. Por exemplo, helpdesk de RH oferecem orientação aos funcionários para eleições de benefícios e folha de pagamento, enquanto os help desks financeiros podem ajudar com questões envolvendo relatórios de despesas ou contas a pagar.
Os help desks podem fornecer uma combinação de interação humana, respostas automatizadas e acesso a ferramentas e documentação, mas não há diretrizes que definam ou exijam qualquer um desses componentes. Consequentemente, cada configuração de help desk é diferente, oferecendo uma combinação única de recursos adaptados às necessidades de sua organização e usuários.
Alguns help desks permitem acesso 24 horas por dia a ferramentas, documentação e uma base de conhecimento pesquisável, mas restringem os serviços de assistência humana via chat, e-mail e telefone ao horário comercial normal. Outro tipo de help desk, comumente conhecido como self-service desk, concentra-se exclusivamente em documentação e recursos de conhecimento.
Independentemente de seu tipo e recursos, um help desk geralmente executa as quatro funções principais a seguir:
- Estabeleça um ponto de contato comum ou único.
- Responda perguntas ou resolva problemas.
- Economize tempo e dinheiro.
- Melhore a experiência do usuário ou melhore a satisfação do usuário.
Acesso e gerenciamento de documentação
Uma parte fundamental de qualquer help desk é a documentação. A documentação atualizada e bem preparada é um recurso econômico que responde a uma vasta gama de perguntas para os usuários a qualquer momento. Mesmo as empresas com pouca ou nenhuma equipe de suporte ao vivo podem fornecer assistência ao usuário por meio de documentação abrangente e pesquisável. Um help desk típico inclui quatro categorias principais de documentação de produtos ou serviços: documentos, artigos de conhecimento, vídeos e fóruns.
Um help desk abrangente também pode incluir recursos além da documentação:
- ferramentas para download para testar e diagnosticar problemas potenciais;
- acesso a patches e atualizações de software relevantes;
- assistência humana via chat, e-mail, telefone ou ferramentas de colaboração, como Zoom e Microsoft Teams; e
- métricas sobre o sucesso do suporte e a satisfação do usuário.
Help desks vs. service desks
Os help desks são os principais responsáveis por lidar com incidentes relacionados a TI, como solução de problemas e correções de bugs. Balcões de atendimento, ao contrário, fornecem suporte e orientação para questões mais rotineiras ou menos agudas e solicitações de usuários. Por exemplo, um service desk pode atribuir dispositivos de endpoint, como laptops, e criar contas SaaS durante a integração de funcionários. Os service desks são frequentemente vistos como “help desk lite” ou como um subconjunto de help desks.
Na prática, Central de Ajuda e balcão de atendimento são às vezes usado de forma intercambiável. Embora os especialistas possam debater a precisão técnica desse uso, a diferença entre os dois geralmente é uma questão de interpretação, pois não há requisitos claros ou amplamente adotados para help desk ou service desk. As definições, componentes e capacidades dos recursos de suporte variam muito entre as organizações.
Embora os service desks possam oferecer os mesmos tipos de documentação disponíveis por meio de um help desk, sua natureza não crítica geralmente leva a uma ênfase no conteúdo de instruções e de autoatendimento. Por exemplo, um service desk pode oferecer guias ou vídeos sobre como usar o DevOps ou aplicativos de terceiros que o service desk configurou para o usuário.
Documentação de ferramentas para DevOps
Embora a documentação raramente seja incluída no ciclo de DevOps, é uma parte crucial de qualquer versão de software. Commits e sprints acontecem rapidamente, mas as equipes de DevOps devem sempre reservar um tempo para documentar alterações e adições às próximas versões.
Não há padrões ou requisitos para ferramentas de documentação – as equipes de DevOps podem usar qualquer coisa, desde o Microsoft Word até wikis, para criar documentos adequados para uma nova compilação. No entanto, algumas ferramentas comumente usadas podem acelerar e automatizar partes do processo de documentação:
- Apiário (desenvolvimento e documentação de API)
- APIMatic (documentação da API)
- LeiaMe (documentação da API)
- Semáforo (design e documentação da API)
- SwaggerHub (design e documentação da API)
- ProProfs (base de conhecimento)
- Tettra (base de conhecimento)
- KnowAll (tema da base de conhecimento do WordPress)
- Document360 (base de conhecimento de autoatendimento)
- iA Writer (editor de texto e base de conhecimento)
- Dropbox Paper (wiki)
- Bit.ai (plataforma de colaboração de documentos)
- Nuclino (plataforma de colaboração e documentação)
- Whatfix (criador passo a passo e guia)
- Typora (editor Markdown)
- SimpleMDE (editor Markdown)
- MarkdownPad (editor Markdown)
- ClickHelp (documentação do software)
- Doxygen (gerador de documentação de código)
- Sphinx (gerador de documentação de código)
- GitHub Pages (gerador de sites)
- Leia os Documentos (documentação do software)
Gerenciando a documentação do DevOps
A documentação tem um prazo de validade – ela exige atenção e gerenciamento regulares das equipes de suporte e serviço. Os esforços de colaboração comuns ao DevOps geralmente incluem equipes de help e service desk que podem oferecer insights sobre a disponibilidade e a qualidade da documentação existente.
Os esforços de gerenciamento de documentação podem incluir o seguinte:
- Formalizar os processos de documentação e gestão do conhecimento. Isso pode incluir a definição de padrões para a estrutura e o conteúdo do documento e a revisão regular da documentação para garantir sua pontualidade e precisão.
- Torne a documentação pesquisável. É mais fácil encontrar documentos relevantes em plataformas de documentação que filtram os resultados por tags, rótulos, tipos, palavras-chave ou outros critérios. A adição de datas de criação ou outras designações relacionadas ao tempo pode agilizar o processo de verificação da atualização da documentação.
- Reúna o feedback do usuário. A classificação da documentação com um sistema de classificação do usuário ajuda as organizações a identificar e priorizar os documentos mais relevantes e úteis – e a priorizar aqueles que são menos significativos para os usuários.
Os ciclos de vida da documentação são notoriamente curtos em ambientes DevOps movimentados. Isso é especialmente verdade no início do desenvolvimento do produto, quando as alterações e adições de software chegam rapidamente – às vezes diariamente. Mas a adoção de produtos de software pode depender de uma documentação sólida, o que torna essencial que as equipes de DevOps criem uma documentação precisa, completa e atualizada.