Clube do Livro VTEX: Colaborando com Engenheiros

Esse 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, em que discutimos o livro The Product is Docs. Neste post nós vamos discutir o pilar da colaboração com outros times no contexto de Technical Writing. Vamos abordar a relação entre tech writers e outros times em empresas de tecnologia, como o time de Experiência do Usuário, Design, Marketing, Gestão de Produto (Product Management) e Engenharia.

Technical writing é uma área chave em empresas de tecnologia. Nos relacionamos diariamente com outras áreas e precisamos da colaboração de outros profissionais para realizarmos nosso trabalho.

Construir pontes e cultivar relacionamentos é um aspecto central do nosso dia a dia, que pode trazer oportunidades e desafios. Agrupamos alguns capítulos do livro que abordam a colaboração com outras áreas:

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

Technical writers inseridos em times de Engenharia podem se deparar com termos específicos da área de programação, além de ritmos e mentalidades diferentes de trabalho. Para construir uma boa relação e confiança com o time de engenheiros, o ideal é você buscar o conhecimento técnico necessário para colaborar com eles.

Seu relacionamento com o time de engenharia é fundamental para o sucesso da sua documentação. (p. 215)

Tenha o contexto adequado

Seja uma pessoa proativa, buscando aprender mais sobre as tecnologias que o seu time utiliza. Muitas informações e linguagens de programação podem ser aprendidas gratuitamente na internet. A construção de uma base de conhecimento é o que irá facilitar conversas produtivas com o seu time e a produção de boas documentações.

Prepare-se para a conversa

Por mais que você construa uma relação de credibilidade e confiança com o time de Engenharia, esteja preparada para conversas mais técnicas. Além de mostrar profissionalismo da sua parte, essa preparação te ajudará a manter o foco da conversa e a usar o tempo de todos de forma mais eficiente. Para sua preparação:

• Leia sobre as personas, casos e testes existentes.
• Esteja familiarizado(a) com os termos da indústria ou do próprio produto que você está trabalhando.

Faça a conversa valer a pena

Faça perguntas que possam confirmar sobre o processo de desenvolvimento do produto. Uma boa forma de conduzir a conversa é perguntar o porquê de decidirem desenvolver algo, o público deste produto e como funciona.

Aproveite a conversa e peça para ver uma demonstração de como o produto funciona ou se você pode testar a funcionalidade, assim você consegue entender o fluxo e levantar questionamentos como usuário final.

Crie um treinamento

Crie sessões de treinamento para o time de desenvolvedores e apresente para a equipe os processos de revisões e tarefas de documentação. Essa prática permite que você eduque a equipe sobre o papel do tech writer e o fluxo de desenvolvimento de uma documentação.

Mostre ao time de Engenharia como a participação de uma pessoa tech writer em reuniões para alinhar tarefas dos times beneficia os seus colegas, e como o(a) tech writer transforma a informação de um produto em um conteúdo que ajuda os clientes.

Apresente suas documentações

Aproveite para mostrar o que você vem trabalhando e o que realizou em cada etapa (sprint) para o time de Engenharia. O hábito de mostrar o que você está documentando ajuda o time a entender a importância do seu papel na construção do produto.

Este é o momento para contextualizar o seu trabalho e encorajar outros times a participarem na construção da documentação, seja tirando dúvidas ou revisando a parte técnica do que você documenta.

Também é uma oportunidade para apresentar as métricas de engajamento e interação dos usuários com a documentação e confirmar para o time o impacto que a documentação tem na rotina do cliente.

Citações

Traduzimos livremente alguns trechos do livro que mais chamaram nossa atenção:

Citação	Página
Technical writing é uma relação de negócios e também possui algumas questões em comum com jornalismo investigativo	215
Não importa o quão bem você entenda a necessidade do cliente, se você não tiver o conhecimento e a habilidade técnica para uma conversa relevante e colaborativa com o time de engenharia, você será menosprezado na equipe do projeto e a qualidade do seu conteúdo será prejudicada.	215
Explique para o time como sua participação ativa em reuniões é fundamental para seus esforços de documentação, e o que você faz para transformar essas informações em conteúdo que beneficia os clientes.	217