Lição de Chesterton para Devs: Valorizando o Tesouro Escondido

Você conhece a Cerca de Chesterton? É um conceito apresentado por G.K. Chesterton, destaca uma abordagem cautelosa e reflexiva antes de realizar mudanças significativas ou descartar tradições estabelecidas. Chesterton usou a metáfora de uma cerca para ilustrar a ideia de que, antes de removermos ou questionarmos uma estrutura existente, devemos entender completamente o propósito dela. A premissa é que tradições ou estruturas estabelecidas muitas vezes têm razões profundas para existir, sendo essencial compreender essas razões antes de tomar decisões que possam ter consequências não desejadas. Há um termo no futebol que de certo modo se relaciona a isso: “Time que está ganhando não se mexe”. Na nossa área isso nem sempre é verdade, mas é fato que se está ganhando, tenha muito cuidado ao modificar.

Podemos aplicar esse conceito ao lidar com código legado: compreender o código existente é crucial antes de tomar medidas como descartar ou modificá-lo. Sempre vamos nos deparar com o código legado, e provavelmente seremos tentados a descartá-lo considerando-o obsoleto. No entanto, uma atitude precipitada pode resultar em bugs.

A lição aqui é clara: assim como Chesterton nos instiga a compreender o propósito de uma cerca antes de removê-la, devemos adotar uma abordagem reflexiva ao lidar com código antigo. Em vez de simplesmente descartá-lo, questionemos:

Qual é o valor REAL desse código?

  • Pode conter conhecimentos cruciais, soluções únicas para desafios passados ou insights que economizariam tempo e esforço no presente.
  • Pode garantir compatibilidade com platafromas, browsers e plugins antigos e que ainda estão em uso.

Um dos pilares para evitar armadilhas futuras é simples, porém algo que muitos devs tem resistência em fazer: leitura e criação de documentação. A documentação age como a chave para desvendar os segredos do código legado e proteger contra a criação de bugs causados por nossa falta de compreensão. Ler a documentação existente é vital, proporcionando uma visão clara do que foi feito e por quê.

DOCUMENTAÇÃO: LER E FAZER

Além de LER é crucial cultivar uma cultura de CRIAR documentação desde o início do desenvolvimento. Isso pode se manifestar de várias formas, como wikis, READMEs e comentários pertinentes no código. Cada linha de código deve contar uma história clara e compreensível não apenas para quem o escreveu, mas para todos os que possam interagir com ele no futuro.

Ao seguirmos o conselho de Chesterton, valorizando o tesouro escondido no código legado, não apenas preservamos a sabedoria acumulada ao longo do tempo, mas também construímos as bases para um desenvolvimento mais robusto e sustentável. Nessa busca pela compreensão e preservação do legado digital, a documentação emerge como nossa ferramenta mais poderosa.

Lembre-se: o código que você escreve hoje, amanhã será um código legado.

Leia a documentação antes de iniciar.
Crie documentação conforme escreve seu código.
Seja gentil com o passado e o futuro: preserve cercas relevantes e construa cercas fascinantes 😉

Deixe uma resposta