Clube do Livro VTEX: The Product is Docs - Encerramento

Este post faz parte de uma série de conteúdos produzidos pelo time de tech writers da VTEX em nosso projeto do clube do livro.

A comunidade Technical Writing BR surgiu em 2020 com o objetivo de unir os profissionais da área para acelerar nossa capacitação, promover oportunidades e produzir conteúdo em português. Quase um ano após a criação da nossa comunidade, a discussão sobre acessibilidade, e conteúdo em inglês, voltou a surgir em nosso grupo de Whatsapp. Perguntas como “por que todo o conteúdo sobre a área é em inglês?” e “se eu não souber inglês, não posso ser tech writer?” entraram na conversa.

A iniciativa de criar esses artigos sobre a experiência do clube do livro da VTEX, com a leitura do The Product is Docs, é nossa contribuição para a acessibilidade do conteúdo para o público brasileiro.

Foram 20 encontros onde exercitamos nosso pensamento crítico, aprofundamos nosso conhecimento em tech writing e pudemos fazer um benchmarking minucioso sobre como um dos maiores times de tech writers no mundo opera. E por fim, compartilhamos com a comunidade Tech Writing BR o que tiramos dessa experiência.

Os artigos que publicamos incluem:

Escrita (Writing)

• Autoria colaborativa (Collaborative Authoring)
• Decisões de documentação (Documentation Decisions)
• Edição técnica (Technical Editing)

Aprender (Learning)

• Objetivos de aprendizado (Learning Objectives)

Processos e ferramentas (Processes and tools)

• Mantendo conteúdo existente (Maintaining Existing Content)
• Pesquisa para technical writers (Research for technical writers)

Colaborando com outros times (Working with other teams)

• Colaborando com UX e Design (Working with User Experience and Design)
• Colaborando com engenheiros (Working with engineers)
• Colaborando com Marketing (Working with Marketing)
• Colaborando com Gestão de Produto (Working with Product Management)

Indo além do clube do livro

À medida que fomos aprendendo, um fenômeno curioso aconteceu: sentimos que somente ler e discutir já não seria suficiente. Estávamos inspiradas por aquele conteúdo e gostaríamos de ir além. Criamos uma lista de desejos, com as ideias que surgiam de ações que gostaríamos de implementar, a partir dos insights da leitura.

Os itens incluíam desde projetos feitos pelo time do Splunk, que gostaríamos de reproduzir em nossa área, até a criação desses artigos, para divulgar com a comunidade brasileira o que aprendemos. Abaixo incluímos a lista na íntegra, da nossa lista de desejos.

Lista de desejos

Criar projeto especial para investigar audiência.

Estratégia de marca para a Comunidade VTEX, para fortalecer nossa voz com usuários.

Criar dashboard com métricas sobre o Help Center da VTEX com dados sobre artigos mais visitados, artigos com mais feedbacks enviados, quanto tempo demora para um feedback ser incorporado à documentação, o tempo médio que um usuário passa em cada artigo, entre outros.

Mensurando sucesso: como podemos tornar feedbacks e métricas de sucesso mais amigáveis para o usuário.

Criar modelos de documentação orientada a cenários práticos.

Criar checklist para peer reviews.

Criar uma automação para relacionar tarefas de documentação a tarefas dos times de produto no Jira.

Melhorar o gerenciamento de links em nossos artigos.

Melhorar o versionamento do Contentful, ferramenta de gerenciamento de artigos que utilizamos para publicações em nosso Help Center.

Criar um artigo discutindo as nossas melhores práticas no trabalho remoto.

Algumas iniciativas já saíram do papel e viraram realidade. Um exemplo foi o lançamento da VTEX Community e a checklist para revisão de artigos. Também criamos um dashboard que cruza dados do Google Analytics e do Contentful para comparar artigos mais visitados com data da última atualização.

Próximos livros

Começamos com The Product is Docs, mas o clube do livro do time de Education na VTEX virou um projeto recorrente. Em cada edição leremos um livro diferente, abrindo espaço para todos do time se engajarem na leitura e discussões.

Quando terminamos The Product is Docs, chegou o momento de escolher os próximos livros do clube. Fizemos um brainstorming com as participantes, listando livros que gostaríamos de ler. Em seguida, votamos na nossa primeira e segunda opção, num quadro do Miro. A lista de livros incluía:

• How to make sense of any mess, Abby Covert
• Don’t make me think, Steve Krug
• Every page is page one, Mark Baker
• Docs like code, Anne Gentle
• Strategic Writing for UX, Torrey Podmajersky
• Everything is Miscellaneous, David Weinberger
• Design for how people learn, Julie Dirksen

Print do quadro do Miro onde fizemos a votação do próximo livro.

Por fim, Every Page is Page One e em seguida Docs like Code foram escolhidos como os próximos livros do clube. Quem sabe quais ideias surgirão a partir da sua leitura?

Se essa lista despertou sua curiosidade, além de ler os livros, sugerimos conferir alguns episódios do podcast The Manu<script>: o episódio #10: UX Writing - Beyond fixing the words, onde entrevistam a Torrey Podmajersky, autora do Strategic Writing for UX e o episódio #1: Every page is still page one, onde entrevistam Mark Baker. Outra referência é a prateleira de livros no Goodreads, curada pelos entrevistados do The Manu<script>, que reúne livros sobre tech writing e o que os convidados do programa estavam lendo durante a gravação.