O processo de busca de outras docs e referências para começar a documentação técnica
O início do processo
Antes de começar a escrever o artigo, busquei referências em outros textos que abordem o processo de criação de uma documentação técnica ou de produto. E percebi que todos tinham um processo parecido. Uns chamam pesquisa, planejamento, plano, apuração, etc.
No final das contas, acredito que não importa o nome, cada um vai desenhar o seu processo, na prática. Mas, o que realmente não podemos deixar de considerar é que um dos primeiros passos antes de iniciar uma nova documentação ou reformular as já existentes é: buscar referências.
Documentação técnica é um termo genérico para as classes de informações criadas para descrever o uso, a funcionalidade ou a arquitetura de um produto, sistema ou serviço.
Sobre a minha experiência
Entrei no mundo de Technical Writing há menos de 1 ano. E todo o início foi demandado por pesquisa antes de colocar a mão na massa em si. Sendo que ainda não havia compreendido que isso fazia parte do meu tempo de trabalho, não era uma atividade à parte.
Aqui no time de Content Design, recebi o desafio inicial de achar melhorias para a plataforma de documentação que já estava em vigor. Na hora parece fácil, mas depois fiquei um tempo compreendendo de onde tiraria ideias, se ainda estava engatinhando no mundo de redação técnica.
Claro que minha bagagem com gestão do conhecimento, já me deu alguns insights, mas aquela era uma documentação para o cliente final, eu precisava atentar as técnicas de UX Writing, usabilidade, facilidade de edição, entre muitos outros pontos, que cada empresa/necessidade informacional traz consigo.
Foi aí que fui apresentada ao benchmarking e tudo fez sentido na minha cabeça.
O benchmarking
Benchmarking é uma análise estratégica das melhores práticas usadas por empresas do mesmo setor que o seu. Benchmarking vem de ‘benchmark’, que significa ‘referência’, e é uma ferramenta de gestão que objetiva aprimorar processos, produtos e serviços, gerando mais lucro e produtividade.
O benchmarking é a estratégia que nós usamos aqui no time, mas existem inúmeras formas de pesquisa e registro da mesma. Ele acaba direcionando que tenhamos mais foco em empresas no mesmo ramo que o nosso.
Alguns dias foram dedicados “apenas” a entender os concorrentes da empresa, como eles abordavam sua documentação, conversavam com o usuário, qual voz e tom, se a plataforma tinha uma boa recuperação na barra de busca, entre outros fatores.
Isso trouxe não só ideias, mas abriu a cabeça para entender o mercado de produtos digitais. Entender mais até a própria atuação da minha empresa.
Dedicar-se a pesquisar antes de começar a documentar para entender melhor suas ideias, objetivos, o que alcançar e registrar isso em algum lugar para levar como base, já é processo de busca de referências.
Em resumo: como nós dividimos as etapas da pesquisa de forma simples.
- Pensamos qual a melhor forma de buscar referências, optamos pelo benchmarking.
- Carol, que é a nossa UX Writer e é ótima em criar padrões, estruturou a pesquisa no Figma. Dividindo os assuntos em: documentações no geral, onboardings, suportes e FAQs. Além de focar em um assunto de cada vez e não ficar confuso.
- Depois, de forma bem direta, temos os campos documentações, observações e prints. Conseguimos colocar além de nossas observações, as imagens do que mais nos chamou atenção.
- No campo de documentações, já colocamos o link da página que pesquisamos, ficamos com todo o conteúdo da pesquisa num só lugar.
- Já no campo observações, as informações eram diretas ou mais detalhadas sobre algo específico. E com alguns recursos do Figma, conseguimos mudar de cores, colocar stickers, que direcionam nosso olhar.
- No final das pesquisas, marcamos um papo e comentamos os pontos mais relevantes da nossa pesquisa.
Somente assim, conseguimos alinhar e comparar o que era possível realizar dentro da documentação. Um filtro importante a se fazer é que nem tudo que achamos de maravilhoso na documentação dos outros, é viável para nossa régua de negócio e objetivos do time e empresa.
Uma vez um professor me disse a seguinte frase (que segundo O Pensador, é de Wigton Gerald): “A pesquisa é o desenvolvimento da curiosidade e do conhecimento com propósitos definidos”.
Hoje, sinto na prática o quanto isso pode fazer a diferença não só na universidade mas também — e muito — no mercado de trabalho e suas atividades diárias.
