Como documentar quando já existe a documentação?
Como assim, Carol? Há como documentar quando já tem algo existente? Opa! Volta 2 passos. Não me apresentei. Isso é falta de educação, não é mesmo? :)
Sou a Carol, Tech Writer do time de Product Design da Linx Digital e tô aqui para conversar um pouco sobre a organização e etapas de uma documentação já pré-existente.
Vamos começar bem do início. Sabem o que é Technical Writer? Mais conhecida como redação técnica, é quando escrevemos de forma clara e intuitiva sobre instruções ou orientações para as pessoas entenderem com facilidade uma solução/software/produto. Lembram dos bons e velhos manuais de instrução que guardamos e não lemos? Somos nós que escrevemos. :)
A documentação passa pelo que chamamos de Ciclo de Vida de um Documento. Resumidamente: criar, revisar, editar e manter a documentação de um produto digital atualizada.
Mas, e quando já existe uma documentação?
Quando vim para a Digital, já sabia que me esperava um grande acervo de documentação da empresa, hoje conhecido como: Linx Digital Docs. A Docs, como chamamos carinhosamente, é uma junção de todos os documentos das três suítes da Linx Digital — Commerce, Omni e Impulse — que estavam escondidos em outras ferramentas de documentação.
Agora, precisamos voltar no tempo e entender como a Docs nasceu, porque tudo começou no finalzinho de 2020 e só cheguei na Linx em Fevereiro de 2021. Foi necessário mergulhar na história da Tássia, uma das UX Writers do time.
“Quando entrei para o time como Content Designer, no final de 2020, recebi o desafio de criar uma Central de conteúdo para reunir a documentação das três verticais da Linx Digital em um só lugar. Eu já conhecia a estrutura de Omni, sabia que Commerce já tinha algo pronto e não sabia nada da Impulse.
Nessa época, o Gui entrou na Linx e formou nosso time de Product Design e fomos todos responsáveis por fazer Docs nascer. Tivemos que entender, dimensionar, fazer várias dinâmicas com os times de tecnologia, pesquisas de Benchmark (alô, Duda!) e foi assim que chegamos à ferramenta e a um formato que resolveu nosso problema (escolhemos o readme). Pensamos na URL, no nome, no layout, colocamos a mão no código (Du, Duda, Gui e Macabu bem sabem) até que ela nasceu e agora está evoluindo. A cereja do bolo foi trazer a Carol pro time para começar uma cultura de tech writing a partir do que criamos.”
Foi aí que mergulhei de cabeça na pesquisa, caça de arquivos, conversas com PO’s, PM’s, pessoas da empresa. Nossa! Tudo isso, antes de começar a editar.
Juntei todos os documentos na plataforma, uni, designers trabalharam nas telas. Terminou? NÃO! Iniciei um grande ciclo de revisão, afinal, é necessário que se alinhem os textos com o TOM e a VOZ da empresa. E agora, terminou? Para o lançamento, sim. Lançamos a documentação para os parceiros em maio/2021.
O grande X de tudo isso é: documentar quando já existe algo é mais difícil do que criar.
Você se apropria de um trabalho que não é seu, edita, troca, muda, edita novamente, procura pessoas para confirmar a documentação. Há uma grande responsabilidade em colocar o tom/voz ajustado e fazer com que essa documentação siga rolando atualizada.
Quando o documento existe e é publicado novamente — versão 2.0 — é o seu trabalho que está em jogo, todo seu desenvolvimento e desempenho. É como pegar uma casa suja e deixar brilhando. Entende?
Há uma responsabilidade diferente do que criar junto aos times de desenvolvimento e entender todo o contexto da questão, visto que você estava nas reuniões e discussões desde o início e não só no final com o texto pronto. Muda todo o ponto de vista!
A pessoa Tech Writer além de escrever de forma clara e fácil, lê como se fosse quem vai usar, é o que chamamos de experiência, a grande empatia. Se eu não entender aquelas instruções, a outra pessoa, entenderá? É assim que pensamos. :)
Fico por aqui, acho que vocês entenderam um pouquinho do grande processo de documentar quando já existe um doc. ❤
