A importância da documentação no trabalho remoto

E como isso mudou nosso processo de construção de landing pages

Cíntia Garcia
Design na Aegro
3 min readNov 29, 2021

--

Fundo verde com uma ilustração em contorno branco simulando um documento

A capacidade de organização é uma habilidade importante em qualquer empresa. Em uma startup remota é fundamental, pois documentar nossos processos em um só lugar pode garantir um trabalho mais ágil e assíncrono dentro da equipe. Descentralizar a informação e garantir que todos tenham acesso também é um dos pontos positivos de manter tudo registrado.

Hoje vou contar como nossa documentação agilizou as nossas criações de landing pages e possibilitou que menos pessoas precisassem ser envolvidas em processos repetitivos.

Na Aegro usamos o Confluence para documentar nossas tarefas, processos e registros gerais. Isso facilita o acesso de informações dentro da equipe e entre os departamentos da empresa como um todo. No time de marketing criamos alguns tutoriais de como desenvolver novos materiais seguindo nosso padrão visual da marca, como e-books, animações e planilhas. Entre os tutoriais criados, temos o de como criar nossas landing pages.

Print da tela do Confluence contendo o início do tutorial para criação das landing pages. No título lê-se “Guia Landing Page RD” seguido de um texto introdutório e um índice listando o conteúdo do guia.
Print de tela do Confluence com o início do tutorial para criação das landing pages. A página apresenta um texto introdutório sobre o assunto e um índice listando o conteúdo do guia.

Criamos a maioria delas com um editor “arrasta e solta”. Isso é prático, mas tem suas limitações. A plataforma que usamos permite fazer algumas edições avançadas com código — e foi aí que a nossa documentação fez a maior diferença.

Não tínhamos um desenvolvedor próprio no time de marketing, e sempre que precisávamos de algum ajuste que envolvia o uso de código, procurávamos desenvolvedores do time de engenharia.

As ações eram relativamente simples: trocar um elemento de lugar na versão mobile, ocultar algum elemento etc. Comecei a perceber que certas edições se repetiam entre as landing pages, e me via indo atrás do mesmo colega para fazer a mesma tarefa em uma nova página. Algo que parecia ser simples, mas que eu não sabia fazer.

Comecei então a tentar copiar o código de uma página para a outra, mas muitas vezes não funcionava e eu tinha que pedir ajuda novamente. Foi então que pedi ajuda a um colega desenvolvedor para entender melhor a lógica por trás dessas edições. Eu tinha uma leve noção de HTML e CSS, mas precisava de um empurrãozinho a mais para conseguir me virar nessas edições em especial. Assim, ele me explicou o caminho e, a partir daí, fui registrando os códigos mais usados para atender nossas principais necessidades.

Acrescentei no nosso tutorial de criação de landing pages uma seção sobre essas edições avançadas. Listei os principais ajustes que fazíamos e apresentei os códigos usados em cada situação, junto do passo a passo de como identificar na página os elementos envolvidos e como usar o código. Isso serviu tanto para organizar em um só lugar os códigos que eu recebia ao longo do tempo quanto para disponibilizar para os colegas que também trabalham nas landing pages.

Print de tela do Confluence, mostrando parte do tutorial de criação das landing pages. Um código é apresentado ao longo do texto, seguido de um print do RD Station indicando como identificar os elementos envolvidos no código.
Ao longo do tutorial, foram acrescentados os códigos mais usados, seguidos de uma explicação sobre como usar cada um, incluindo prints do editor de lading page mostrando como identificar os elementos envolvidos no código apresentado.

Com essa documentação o time de marketing conseguiu se tornar mais independente para fazer os ajustes recorrentes nas páginas, pois não só eu como qualquer outro colega do setor poderíamos editar as landing pages se seguíssemos o tutorial. Além disso, o time de engenharia parou de receber pedidos de ajuda com ações repetitivas que os oneravam em meio às próprias tarefas de seu setor.

Usar o tempo do trabalho para documentar um processo em vez de simplesmente seguir realizando suas tarefas pode parecer menos importante, especialmente em equipes com várias entregas de curto prazo, como no time de marketing. No entanto, o registro serve exatamente para facilitar e acelerar a realização das nossas atividades como um time, levando em conta nossa troca de informações e a execução de tarefas encadeadas dentro da equipe.

No fim das contas, o tempo usado para documentar algo é um verdadeiro investimento.

--

--