Redesenhando a documentação do DigibeeCTL

White lights create a blurry, abstract cluster.
Pesquisa, arquitetura e revisão de conteúdo
Contexto

O DigibeeCTL é a interface CLI do SaaS da Digibee, permitindo que usuários executem por linha de comando todas as fases do produto.

A documentação da funcionalidade estava defasada em relação às atualizações do produto Saas em UI.

Mudanças estratégicas e considerações da gestão de produto sobre a continuidade da funcionalidade motivaram minha inserção nas discussões e avaliação do conteúdo do produto no portal de documentação.

Pesquisa 

A partir da necessidade de entender a funcionalidade para reconstruir o histórico da documentação, meu foco foi fazer o levantamento do conteúdo publicado no portal e de versões anteriores no repositório interno da empresa.

Desse ponto em diante, fiz o mapeamento de SMEs de referência e, em parceria com uma desenvolvedora front-end e um Product Designer, realizamos entrevistas semiestruturadas para aprofundar a compreensão global sobre o produto, seu funcionamento e contexto de uso.

As entrevistas foram organizadas e analisadas com uso do Marvin, facilitando o registro, a recuperação e a análise dos insumos levantados.

Conduzi pesquisas com usuários internos para melhoria da documentação, mapeamento de insumos, levantamento de métricas de usabilidade da funcionalidade e análise de dados para desdobramento e produção de conteúdo.

Análise e validações

Com base nos dados e insumos levantados, a análise foi apresentada à gestão do produto. Com a avaliação conjunta do valor estratégico do produto, a gestão optou pela continuidade do DigibeeCTL.

A partir daí, iniciei a análise da estrutura do Portal de Documentação para definir em que seção o conteúdo deveria ficar e como se relacionaria com as demais áreas do portal, considerando a perspectiva de usuários externos. Como apoio, também foram ouvidos nessa etapa SMEs e usuários internos.

Os insights dessa etapa permitiram identificar, além de gaps na documentação, a demanda de atualizações específicas de sintaxe e operações do produto.

Assim, delineei um roadmap da minha atuação em conjunto com o Product Lead do time para as validações técnicas necessárias da documentação.

Com a estrutura definida, atualizei a documentação em português a partir dos insumos levantados, das evidências coletadas e das validações feitas ao longo do processo. A revisão considerou as mudanças de sintaxe e operações identificadas para a funcionalidade, além da consistência com a organização do Portal de Documentação.

O conteúdo passou por revisão por pares e revisão técnica, com ajustes incorporados antes da publicação. Após a aprovação da versão em português, desenvolvi a versão em inglês, preservando a equivalência entre os conteúdos e a consistência terminológica entre os dois idiomas.

O resultado foi uma documentação atualizada, validada, publicada e localizada para inglês, alinhada à estratégia da empresa para o DigibeeCTL.

interface do DigibeeCTL

Documentação publicada em português e inglês

Produção

© 2026, Samanta Rodrigues