Tech Writers

Habemus Confluence!

7 minutos

Como estruturamos a nova Central de Ajuda do Projuris Empresas utilizando o Confluence.

Que a documentação é um processo importante na gestão de produtos, todo mundo sabe. Ela guarda legado, registra decisões e serve como uma grande coletânea para que no futuro todos entendam o quê foi feito e por quê foi feito. Dito isso, ela também assume o papel de comunicadora e educadora, levando ao usuário todas as informações sobre o produto.

Ok, mas como alcançar esse propósito e entregar ao usuário tudo que ele precisa sem a necessidade de “sair catando informação”? A resposta é bem simples: estruturando uma Central de Ajuda.

Por onde começar?

Escolha a ferramenta certa.

Aqui o importante é que ela seja dedicada a documentação, pensada com esse propósito, isso faz toda diferença. Anteriormente, aqui no Projuris Empresas, nós utilizávamos o Movidesk, uma ferramenta de suporte que disponibilizava uma pequena funcionalidade de base de conhecimento, o que engessava a estruturação de uma organização mais intuitiva do conteúdo, que fizesse sentido ao usuário e possuía uma usabilidade que limitava a disponibilização de recursos durante a consulta. Entendemos o que precisava melhorar e buscamos ferramentas que atendessem essa expectativa e tivessem no centro das funcionalidades: a documentação. Foi assim que chegamos no Confluence (que já era utilizada e exaltada pelos nossos colegas do Projuris ADV), ele tem como objetivo ser uma ferramenta de documentação e inclusive é uma das referências neste quesito (Habemus Confluence!).

Desenhe a sua estrutura

Agora que a ferramenta está definida, é hora de pensar na estrutura. Em como apresentar esse conteúdo de uma forma que fará sentido ao usuário e facilitará o acesso às informações. Nós resolvemos isso literalmente desenhando (muito artistas elas): sentamos e pensamos em todo o conteúdo pré-existente e em como apresentá-lo, a ideia principal era que ele deveria refletir o nosso produto e ser intuitivo. Desta forma, criamos grandes categorias que serviram de agrupadores para os artigos e demais conteúdos. Isso também ajudou no momento da migração, pois como já tínhamos o “esqueleto” foi necessário apenas mover os conteúdos para sua categoria correta.

Inicie migração

Chegou o momento mais esperado: a migração. Depois que a estrutura foi definida nós iniciamos o processo de migração, transferimos exatos 618 artigos (meus amigos, foi suado!) e infelizmente, como Movidesk não disponibilizava um backup em um formato compatível com o Confluence, tivemos que recorrer ao bom e velho “copy & past”. E aqui temos um ponto importante: se a ferramenta escolhida não fosse pensada para documentação esse processo seria ainda mais moroso, como o Confluence é pensado para isso, ao colar o conteúdo ele já ia se adaptando necessitando de pouca interferência.

Apesar de todo esse trabalho, ainda assim, concluímos toda a migração em menos de duas semanas. Ah e consideração importante: hoje se precisarmos exportar todo nosso conteúdo, isso pode ser feito rapidamente em poucos minutos, isso porque o Confluence permite a exportação nos formatos “.pdf, .docx, html e xml”, se necessário (uma nova migração hoje seria pá-pum!).

Alinhe os detalhes

Após a migração, foi hora de cuidar dos pormenores, ou seja, olhar para estrutura do conteúdo em si. Validamos links, imagens, gifs, definimos títulos, padrões, e etc. Nesta fase é importante que você coloque o usuário no centro das decisões, pois o conteúdo tem que conversar com a estrutura pensada:

  • Verifique se a apresentação das informações nos artigos é lógica e clara;
  • Se os artigos estão inseridos na estrutura correta;
  • E principalmente, se são pesquisáveis e fáceis de localizar.

Detalhes que fazem a diferença na hora da entrega como um todo. Aqui nós contamos com a ajuda da IA para revisar e criar artigos essenciais, principalmente os que tinham como objetivo o onboarding do usuário.

O único problema significativo que tivemos nesse processo foi em relação as imagens e gifs que são utilizadas para ilustrar nossas documentações, porque esse tipo de arquivo não pode ser copiado e colado como o restante do conteúdo, eles devem ser adicionados individualmente (sim, um a um), do contrário, cria-se um vínculo entre as duas ferramentas e depois de um tempo as imagens quebram, pois perdem as referências de hospedagem, portanto é bom ter atenção e cuidado com relação a isso, principalmente na migração de um número considerável de conteúdo (como foi o nosso caso).

Pense no design

A apresentação é a chave do negócio! Depois que todo o “corpo” da nossa central estava construído nós passamos a nos preocupar com o design em si. Para ajudar nesse item contratamos o Refined que é um plugin que permite a personalização do Confluence, então, foi a vez do nosso Product Designer entrar em ação. Mais uma vez desenhamos a estrutura que queríamos (falei que elas são artistas), e isso serviu para validar visualmente se faria sentido e nortear o especialista. A partir desse desenho ele começou a desenvolver o design da central, considerando a identidade visual do produto e a melhor usabilidade.

Nesse passo, novamente pensamos na correlação entre produto x central, nós trouxemos muitas referências do sistema para ela, não apenas a paleta de cores e logos, mas também ícones, estrutura, nomenclaturas, tudo isso para que usuário se sentisse familiarizado com o contexto e estabelecesse essa relação entre as duas coisas (mais a frente você vai entender porquê isso fez sentido).

Além disso, não nos limitamos a apenas utilizar o conteúdo do Confluence, também vinculamos links de outras plataformas com informações do Projuris, como Youtube, Blog, Site, Portal de Tickets e etc, isso permite que usuário tenha acesso a tudo a respeito desse universo em um único lugar.

Valide antes de lançar

Então pronto, temos a estrutura, o conteúdo, o design e agora? Já podemos colocar no ar? Até poderia… mas como ter certeza que ela está aderente ao que o nosso usuário precisa? Que não há nenhuma possibilidade de melhoria? Só testando não é mesmo?!

Por isso, antes de publicar a nova central no produto, nós decidimos convidar clientes internos e externos para um teste de validação. Definimos um pequeno roteiro de execuções (busca, navegação, validações de nomenclaturas, estrutura, e etc.), pedimos que as pessoas utilizassem feedbacks para alinhar ainda mais a nossa entrega.

O resultado disso? Além de feedbacks que contribuíram para a assertividade do projeto (aquele ok de que tomamos a decisão certa), conseguimos corrigir a rota antes da entrega final, mudando nomenclaturas que não estavam muito claras, reordenando conteúdos na estrutura e criando outros com base nas sugestões.

Lembra que eu falei sobre a intenção de fazer uma relação entre o produto e a central? Isso se confirmou aqui, pudemos perceber que os usuários se localizaram de maneira muito mais fácil porque relacionaram seus módulos contratados com a apresentação existente na central, comprovando a familiaridade.

Lance e divulgue muito!

Agora sim, podemos dizer que ficou tudo “redondinho” (para começar pelo menos) e depois de todas as validações, finalmente é hora de publicar. Nós começamos pedindo para a equipe de engenharia inserir o link da nova central diretamente no Projuris, isso já era uma prática nossa, portanto foi necessário apenas substituir o acesso antigo. Ao mesmo tempo, alinhamos com a equipe de marketing a estratégia de divulgação.

Quando ficou tudo pronto nós divulgamos nos canais internos (teams e e-mail), no produto (através do Beamer), na comunidade Heroes (uma comunidade formada por clientes do Projuris) e no e-mail marketing (uff fizemos barulho!).

Próximos passos

Como eu falei, esse é só começo, a documentação é um trabalho cultural, as pessoas precisam ser educadas tanto para entender importância de produzi-la quanto o hábito de consumi-la.

Então, a partir de agora nossos próximos passos incluem a curadoria da nova central, coleta dos dados para analisar as oportunidades de melhoria, a integração com iniciativas de IA e a produção de novos conteúdos.

Mas a pergunta que fica é: pronto para dar um upgrade na sua central de ajuda? Se você quer ver de perto como fizemos isso no Projuris Empresas, clica aqui para explorar a nossa nova Central de Ajuda e conte o que achou. Adoraria trocar ideias sobre os desafios (e as vitórias!) desse processo. Me manda uma mensagem, vamos juntos construir documentações ainda mais incríveis!

Deixe um comentário

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *