Clube do Livro VTEX: The Product is Docs

Somos cinco mulheres - Carolina Menezes, Júlia Rabello, Juliana Meyer, Karen Krieger e Mariana Caetano - technical writers do time de Education da VTEX. Nossa equipe é responsável por criar e manter toda a documentação pública da empresa, por meio dos nossos portais Help Center e Developer Portal.

A partir do nosso interesse em leitura, organizamos um clube do livro para analisar as principais referências de Technical Writing no mundo e pensar em como elas refletem nossa realidade. Como a maior parte do conteúdo do universo de Technical Writing é estrangeiro e nós somos um time formado por brasileiros, nos questionamos: será que a visão dessas pessoas se aplica ao nosso contexto?

The more that you read, the more things you will know. The more that you learn, the more places you’ll go. - Dr. Seuss

---

“Quanto mais livros você ler, mais coisas saberá. Quanto mais aprender, mais lugares conhecerá.” - Dr. Seuss

Começamos o clube do livro em fevereiro de 2021 com a leitura do The Product is Docs, escrito por Christopher Gales e pelo time de documentação do Splunk. Esse é um livro tradicional sobre Technical Writing, referenciado em várias palestras sobre o tema, como por exemplo os Meetups da comunidade de Technical Writing BR.

Página no Notion onde organizamos os assuntos do Clube do Livro.

Por dentro dos encontros

Conseguimos integrar o aprendizado sobre a área de Technical Writing à nossa rotina com encontros semanais de 30 minutos, toda terça-feira, às 11h da manhã. Outros membros do nosso time também participaram das discussões do livro - Isabella Veloso Sá, George Brindeiro e Gustavo Figueredo.

Durante 4 meses, cada participante se organizou para incorporar a leitura ao seu dia a dia. Júlia, Mariana e Karen liam os capítulos da vez durante o final de semana, com uma boa xícara de chá. Juliana e Carolina preferiam ler durante o café da manhã, na segunda e na terça. Ficou fácil incorporar o aprendizado técnico ao cotidiano.

Cada discussão envolvia os seguintes pontos:

• Opinião sobre o capítulo.
• Dúvidas que surgiram durante a leitura.
• Discussão sobre semelhanças e diferenças em comparação com a nossa realidade.

Às vezes, um único capítulo despertava tanto nossa curiosidade que passávamos todo o encontro só discutindo o seu conteúdo. Outros capítulos eram, eventualmente, mais distantes da nossa realidade, então debatíamos dois ou mais capítulos em um mesmo encontro. De qualquer forma, às terças-feiras, começávamos o dia desafiadas mentalmente, refletindo sobre como poderíamos aprimorar nosso trabalho.

Difundindo o conteúdo no Brasil

Para contribuir com o desenvolvimento de mais tech writers brasileiros, decidimos compartilhar nossos principais aprendizados com a comunidade brasileira de Technical Writing. Entendemos que o idioma é uma barreira e que isso afasta vários leitores brasileiros pela sua dificuldade. Pensando nisso, resolvemos criar posts sobre temas discutidos em The Product is Docs e citar capítulos que nos interessaram.

Por isso, vamos publicar resumos sobre algumas temáticas do livro no blog da comunidade Technical Writing BR, incluindo traduções livres de alguns trechos. Não cobriremos o livro todo, pois decidimos selecionar os capítulos com que mais nos identificamos ao longo da leitura.

Agrupamos os capítulos livremente em temáticas mais amplas, dividindo os posts escritos por nós, da seguinte forma:

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)

Encerramento

• Clube do Livro VTEX: The Product is Docs - Encerramento

Quadro no Miro onde fizemos o planejamento e divisão de temas para a criação dos posts.

Saiba mais

Por mais que esse seja o primeiro conjunto de conteúdos escritos em português sobre The Product is Docs, existem outros recursos em inglês já disponíveis. Se o idioma não for uma barreira para você, sugerimos as seguintes referências:

• Entrevista com Christopher Gales no podcast The Manu<script> (criado e produzido por Juliana ☺️), sobre o dia a dia da área no Splunk e a construção do livro. Escute no Spotify.
• Splunk Blogs.