cultura writer,

O desafio de justificar esforços de documentação

Breno Barreto Breno Barreto Seguir 13/06/2020 · 1 min read
O desafio de justificar esforços de documentação
Compartilhar

Não, nem sempre é fácil convencer sua empresa ou mesmo seu time sobre a importância da documentação, e esse pode ser um dos desafios mais complicados para uma equipe de technical writing recém-criada.

Em um ambiente orientado a resultados como o de quase toda empresa moderna, uma coisa é crucial… isso mesmo: o resultado. Nem um problema, a não ser quando você tenta pular as partes difíceis para chegar mais rápido até lá. E manter um processo de documentação saudável é certamente uma dessas partes difíceis.

Por isso, geralmente escolhemos ignorar sua importância ou pelo menos diminuí-la, como se a documentação fosse um acessório com o qual podemos lidar mais tarde.

Uma das razões é que esse ambiente orientado a resultados valoriza benefícios mensuráveis, ​e medir o efeito de uma documentação de qualidade pode se tornar um trabalho árduo e demorado.

Quão felizes seus clientes ficaram depois que seu time alterou os títulos de gerúndio para infinitivo? Qual foi a redução no número de tickets abertos para o time de suporte depois que você mudou a cor da borda do botão de pesquisa? Difícil de dizer.

No entanto, são esses e muitos outros detalhes que, juntos, transformam um conhecimento bruto, disperso e represado na ferramenta capaz de trazer escala à sua empresa.

E o momento de prestar atenção a esses detalhes é agora, quando esse conhecimento ainda é administrável.

Os efeitos não serão vistos amanhã ou no fim da próxima sprint. E talvez quando eles aparecerem, a influência da documentação não seja tão clara quanto você gostaria.

Portanto, pode ser difícil justificar um esforço equivalente ao empreendido pela equipe de desenvolvimento para lidar com a documentação. E, para os mais ansiosos, pode ser doloroso esperar aguardar enquanto trabalha dia após dia com vírgulas, listas, screenshots e categorias.

Mas um produto que cresce sem um processo de documentação bem-estruturado é como um edifício construído sobre pilares de bambu. No começo, pode parecer viável, mas se o produto for longe o suficiente, a estrutura inteira fica comprometida.

Assine a Newsletter
Receba nossas novidades em sua caixa de e-mail. Sem spam!
Breno Barreto
Escrito por Breno Barreto Seguir
Lead Technical Writer @ VTEX | Co-host do podcast The Manuscript | Autor da newsleter Tech Scribe