README.TXT: Veja como programar melhor!

Por Diego Cordeiro

Todo programador quer escrever softwares bons de forma limpa, clara, rápida e de acordo com as melhores práticas. Mas para que sua criação seja útil, ela precisa resolver os problemas de quem irá usá-los. 

De nada adianta seguir as melhores práticas e o software não deixar seus usuários satisfeitos. Nas palavras de Tom Preston-Werner, co-fundador do GitHub: “a implementação perfeita da especificação errada é inútil”.

Por isso, Werner argumenta que para conseguir escrever um programa capaz de facilitar a vida das pessoas é preciso saber claramente aonde se quer chegar. Como conseguir isso? “Escreva o Readme primeiro”, diz o co-fundador do GitHub. O raciocínio é simples: ao fazer isso, o programador pensa com antecedência no objetivo e pode começar a desenvolver o projeto com algo claro na mente.

Ninguém pode negar que começar a fazer algo sabendo o que se vai fazer é mais fácil. Alguns podem dizer que isso é um abandonar os métodos de XP e Scrum para voltar ao modo de programação Waterfall, caracterizado por um registro minucioso do projeto. Entretanto, o que Werner sugere é que é preciso achar um equilíbrio entre os dois métodos.

“É preciso haver um ponto médio entre os excessos da especificação técnica e a ausência de especificações”, afirma o co-fundador do GitHub. Ao escrever o README.TXT, o programador consegue algumas vantagens que irão ajudar na hora de escrever o código:

1. O mais importante é que o programador pensa no projeto com antecedência. Isso evita mudar o código toda vez que mudar de ideia.
2. A primeira consequência de escrever o README.TXT é a criação de um documento completo com a essência do projeto. Escreva o texto antes de começar o desenvolvimento: é nessa hora que o entusiasmo é maior, o que ajuda a colocar as idéias no papel.
3. Se estiver trabalhando em equipe, compartilhar o documento dá a chance de seus colegas começarem projetos que irão conversar com seu código.
4. Discutir e construir em cima de idéias escritas é mais fácil do que falar sobre idéias abstratas. Ter o README.TXT como linha guia torna o trabalho mais fácil.

Os argumentos de Tom Preston-Werner parecem sólidos o bastante para provocarem uma reflexão nos programadores. O que você acha?

Leia o texto original aqui.
Curtiu o post? Deixe nos comentários se você já conhecia o programa README.TXT e se já conferiu as vantagens que ele proporciona na hora da escrita!