Produto

Documentação de software em uma empresa de tecnologia em crescimento acelerado

George Brindeiro
George Brindeiro March 2, 2021
Documentação de software em uma empresa de tecnologia em crescimento acelerado

A VTEX aprendeu muito, nos últimos anos, sobre a importância da documentação para produtos ganharem escala global. Tudo começou em ritmo de força-tarefa, para criarmos a base da nossa documentação pública. Gradualmente entendemos que esse era um esforço importante, que exigia a formação de um time dedicado à evolução da nossa documentação, com diversas iniciativas de investimento na captação de talentos que pudessem transformar o mercado de ecommerce. Com o tempo, conseguimos disseminar a ideia de que a documentação é um dos elementos que compõem nosso produto e deve ser considerada em todas entregas.

Com o surgimento cada vez mais rápido de times e funcionalidades, estamos entrando em uma nova fase de maturidade. Esta fase exige novas estratégias para que a produção de documentação acompanhe esse ritmo acelerado de expansão global. Por enquanto, apostamos em três pilares: capacitação, alinhamento e flexibilidade.

Capacitação: Tudo começa com um time motivado e curioso

Você já ouviu falar em technical writing? Se você não trabalha com isso, provavelmente não. Trata-se de uma disciplina de produto incipiente no Brasil e, por isso, encontrar profissionais no mercado é um grande desafio. Mas nosso posicionamento é não reclamar dessa escassez — decidimos incentivar e capacitar os talentos dispostos a embarcar nessa jornada!

Começamos buscando e aprendendo com as melhores referências globais no assunto em livros8, cursos9, blogs6 e conferências12. Também criamos um encontro semanal dedicado ao compartilhamento de conhecimento2, onde nos revezamos nos papéis de mestre e aprendiz, para que todos permaneçam engajados no aperfeiçoamento das mais diversas habilidades. Essas iniciativas nos ajudaram a entender melhor onde queremos chegar e como podemos enfrentar os obstáculos no caminho.

Skills Sharing é o nome do encontro semanal em que compartilhamos conhecimento

Logo percebemos que não seria suficiente compartilhar esse conhecimento somente entre nós. Preparando os candidatos antes mesmo que chegassem à VTEX (ou a outras empresas) poderíamos acelerar o desenvolvimento desse papel no Brasil — e talvez contribuir para o aumento da diversidade em times de produto. Por isso nos engajamos na criação de um podcast11, uma comunidade brasileira15 e até um curso exclusivo para profissionais negros19.

Aprender e compartilhar conhecimento é o que nos move. Estamos construindo um futuro em que qualquer pessoa que queira fazer parte do ecossistema da VTEX conseguirá aprender tudo que precisa para fazer o melhor uso da plataforma. A documentação ajuda a alcançar o objetivo de acelerar a adoção do nosso produto e guiar nossos clientes para o sucesso, mas outras experiências e formatos de conteúdo virão. Estamos só no começo dessa jornada.

Alinhamento: Comunicação e priorização são essenciais para colaboração efetiva 

No início, nossa maior dificuldade era atender às demandas mais urgentes de documentação com um time reduzido. Essa urgência era definida considerando o número de chamados feitos para o time de suporte a respeito da mesma dúvida. Estávamos apagando incêndios.

Com o crescimento e capacitação do time de Education, responsável pela documentação, passamos a apoiar os times de produto na documentação de novas funcionalidades que estavam sendo lançadas. Persistia, no entanto, um volume significativo de funcionalidades existentes e não documentadas. E aí surgiu a questão: devemos priorizar a construção do futuro ou a correção do passado?

Para responder essa pergunta, buscamos construir pontes mais sólidas com as lideranças globais da VTEX através de um comitê de documentação7. A ideia é simples: uma reunião mensal de 30 minutos para ouvirmos representantes de diferentes regiões e entendermos seus desafios relacionados à documentação da VTEX. Este ritual simples nos permitiu identificar demandas latentes que estavam totalmente fora do nosso radar. E o alinhamento com todos nos permitiu visualizar e priorizar o impacto no negócio, ao invés do volume de entregas.

Também buscamos um maior alinhamento com as lideranças de produto da VTEX4, para garantir que teríamos visibilidade do planejamento e desenvolvimento das entregas prioritárias. Isso foi crucial para acompanharmos essas iniciativas estratégicas, enquanto não tínhamos gente suficiente para a integração total de tech writers nos squads de produto. E ajudou também a esclarecer como trabalhamos, como podemos contribuir em cada etapa do desenvolvimento e o que é preciso para entregar uma documentação de qualidade.

Um dos slides que a Beatriz Guerreiro apresentou na Demo Friday (reunião semanal com mais de 500 participantes) para promover a cultura da documentação para toda a empresa

Flexibilidade: Processos estruturados e adaptáveis para superar o desafio da escala

Sem processos estruturados, o volume de demandas de uma empresa em crescimento acelerado se transforma em caos. Pedidos chegam incompletos e em todos canais possíveis. A desorganização resulta em solicitações duplicadas, prazos descumpridos e a sensação geral de que os esforços para correr atrás do prejuízo nunca serão suficientes.

No entanto, processos demais burocratizam o trabalho, gerando barreiras enormes para a colaboração e solução de problemas simples. O desafio da escala requer que sejamos ágeis e flexíveis para nos adaptarmos à realidade de cada time e ao momento da empresa. Por isso, nós limitamos nossos processos a estruturas que promovam clareza, consistência e contexto adequado para colaboração e comunicação precisa entre todos envolvidos.

Uma das primeiras coisas que fizemos foi adotar a prática de reuniões rápidas1, uma rotina comum em times ágeis. E logo percebemos que um formato assíncrono e escrito funcionaria melhor para nós. Trata-se de um bot do Slack, que nos pergunta diariamente:

  • Como você está se sentindo?
  • Qual é a sua tarefa de maior prioridade hoje?
  • Você gostaria de compartilhar mais alguma coisa?

Além de permitir que cada tech writer possa escolher o melhor horário para enviar sua atualização, ganhamos um histórico diário detalhado de todas as reuniões. E a possibilidade de estender ou aprofundar a discussão sobre alguma questão que esteja atrapalhando o progresso de uma tarefa, envolvendo apenas os diretamente envolvidos.

Como ainda não estamos integrados em todos squads de produto, é comum perguntarem: quem é o responsável por determinada documentação? Para dar clareza a essa questão, listamos todos squads de produto em uma página interna disponível para toda a empresa, indicando qual tech writer está alocado naquele time14. Além disso, geramos automaticamente a listagem de todos tutoriais publicados3, onde indicamos o squad de produto mais próximo ao seu conteúdo. Com isso, todos sabem o que está sob a responsabilidade de cada tech writer e podem interagir diretamente, se necessário.

Mas será que interagir diretamente é a melhor forma de trabalhar? Conseguimos acelerar a colaboração através de mais consistência na sinalização e acompanhamento de demandas de documentação. Criamos canais públicos, com nomes padronizados, que funcionam como espaços compartilhados de trabalho com cada time de produto5 na nossa ferramenta de comunicação interna. Neles, replicamos um workflow que sistematiza a abertura de solicitações de documentação17, ilustrado na imagem a seguir.

Como essa dinâmica é consistente em todos canais de documentação, torna-se muito mais fácil explicar nossa forma de trabalhar para outros times. E como o canal é público, nenhum detalhe da discussão é perdido. Mantemos um histórico rico que permite colaboração assíncrona e a mudança do tech writer responsável pela demanda, sem que haja retrabalho.

De forma similar, centralizamos todas pequenas correções e sugestões relacionadas a documentação publicada em um só canal: o formulário de feedback disponível nas nossas plataformas de documentação10. Não importa se a sinalização vem de um cliente, parceiro ou de alguém da VTEX. Recebemos o feedback por um formulário específico, um resumo é publicado em um canal dedicado a isso e a solicitação é registrada como tarefa. Esse processo facilita a organização de demandas, para que possamos nos concentrar na execução.

Garantir a qualidade da documentação é um outro desafio relevante, quando falamos de um time que cresce rápido e ainda está descobrindo como atuar. Acreditamos em liberdade com responsabilidade: cada um de nós é capaz de determinar a melhor forma de investir seu tempo e energia, mas deve responder pela qualidade das suas entregas. Para compartilharmos o mesmo contexto de qualidade, criamos diretrizes básicas de documentação16 e UX writing18 que guiam o time. E se alguém precisar de ajuda, é possível solicitar a revisão dos seus pares13 por mais um processo simples que foi integrado na nossa ferramenta de comunicação interna.

A única certeza é que tudo muda o tempo todo

Aqui, resumi algumas das estratégias que adotamos nos últimos meses para que nossos esforços de documentação acompanhem nosso ritmo acelerado de expansão global. Aprendemos muito com essa experimentação, mas a principal lição foi a seguinte: não existe uma solução única que funcione para todas situações. 

Cada momento apresenta novos desafios, que frequentemente tornam obsoletos os processos e práticas do passado. Por isso, é essencial que times de documentação nunca parem de aprender, se alinhem continuamente às necessidades do negócio e sejam flexíveis para adaptar seus processos sempre que fizer sentido. Isso é o que viabiliza entregas de impacto para todos que dependem de documentação para atingir seus objetivos. 

Continue lendo: artigos relacionados
Produto

“Kon’nichiwa Japan!” Agora a plataforma da VTEX também está disponível em japonês

Depois de abrir um escritório em Singapura para melhor atender os clientes globais na região da Ásia Pacífico,…

Cassiane Vilvert
Cassiane Vilvert
Produto

Pix e o impacto no ecommerce: do lançamento à Black Friday

O novo meio de pagamento instantâneo do Banco Central, o Pix, entrou em vigor dia 16 de novembro.…

Juliana Sales
Juliana Sales
Produto

Além do esperado: os times de produto poderosos da VTEX

Como pessoas comprometidas, um mindset de produto e uma linguagem baseada no futuro geram resultados além do que…

Guilherme Rodrigues
Guilherme Rodrigues
Estrategia

Conversational commerce: o potencial de conversas relevantes e humanizadas para o varejo

Já sabemos que a transformação digital vem provocando mudanças substanciais em todos os segmentos de mercado ao longo…

Take Blip
Take Blip
Produto

Como o Pix promete eliminar cinco ineficiências operacionais do e-commerce

O Pix é o novo meio de pagamentos instantâneos do Banco Central (Bacen) que entra em vigor dia…

Juliana Sales
Juliana Sales
Marketing

Black Friday: ajude seu cliente a encontrar o que procura com o VTEX Intelligent Search

Como ajudar seu cliente a encontrar o que procura? Melhorando a Busca do seu e-commerce! Neste artigo, você…

Gustavo Vedotti
Gustavo Vedotti
Gestão

Black Friday: o guia definitivo para criar Promoções na VTEX

Estamos há poucas semanas da Black Friday, um dos maiores evento de vendas do ano no Brasil. A…

Natalie Tang
Natalie Tang
Estratégia

Marketplace e a magia em vender através dos Shoppings virtuais

Vender pela internet nunca esteve tão em alta como nos tempos atuais.  Termos como “Quero vender mais”, “Como…

Caetano Maffra
Caetano Maffra
Produto

Pix no e-commerce: tudo o que você precisa saber

Neste artigo, você encontrará todas as informações necessárias para entender o impacto do Pix no e-commerce, para lojistas,…

Cassiane Vilvert
Cassiane Vilvert
Veja Mais
Registro feito com sucesso