{"id":51,"date":"2010-08-31T16:06:03","date_gmt":"2010-08-31T19:06:03","guid":{"rendered":"http:\/\/dwbr.org\/blog\/?p=51"},"modified":"2010-08-31T16:06:03","modified_gmt":"2010-08-31T19:06:03","slug":"quer-programar-melhor-escreva-o-readme-txt-antes-do-codigo","status":"publish","type":"post","link":"https:\/\/www.impacta.com.br\/blog\/quer-programar-melhor-escreva-o-readme-txt-antes-do-codigo\/","title":{"rendered":"README.TXT: Veja como programar melhor!"},"content":{"rendered":"

Por Diego Cordeiro<\/strong><\/span><\/p>\n

Todo programador quer escrever softwares bons de forma limpa, clara, r\u00e1pida e de acordo com as melhores pr\u00e1ticas<\/strong>. Mas para que sua cria\u00e7\u00e3o seja \u00fatil, ela precisa resolver os problemas de quem ir\u00e1 us\u00e1-los.\u00a0<\/span><\/p>\n

De nada adianta seguir as melhores pr\u00e1ticas e o software n\u00e3o deixar seus usu\u00e1rios satisfeitos. Nas palavras de Tom Preston-Werner, co-fundador do GitHub<\/strong>: \u201ca implementa\u00e7\u00e3o perfeita da especifica\u00e7\u00e3o errada \u00e9 in\u00fatil\u201d.<\/span><\/p>\n

Por isso, Werner argumenta que para conseguir escrever um programa capaz de facilitar a vida das pessoas \u00e9 preciso saber claramente aonde se quer chegar. Como conseguir isso? \u201cEscreva o Readme primeiro\u201d, diz o co-fundador do GitHub. O racioc\u00ednio \u00e9 simples: ao fazer isso, o programador pensa com anteced\u00eancia no objetivo e pode come\u00e7ar a desenvolver o projeto com algo claro na mente.<\/span><\/p>\n

Ningu\u00e9m pode negar que come\u00e7ar a fazer algo sabendo o que se vai fazer \u00e9 mais f\u00e1cil. Alguns podem dizer que isso \u00e9 um abandonar os m\u00e9todos de XP e Scrum<\/a> para voltar ao modo de programa\u00e7\u00e3o Waterfall, caracterizado por um registro minucioso do projeto. Entretanto, o que Werner sugere \u00e9 que \u00e9 preciso achar um equil\u00edbrio entre os dois m\u00e9todos.<\/span><\/p>\n

\u201c\u00c9 preciso haver um ponto m\u00e9dio entre os excessos da especifica\u00e7\u00e3o t\u00e9cnica e a aus\u00eancia de especifica\u00e7\u00f5es\u201d, afirma o co-fundador do GitHub. Ao escrever o README.TXT<\/strong>, o programador consegue algumas vantagens que ir\u00e3o ajudar na hora de escrever o c\u00f3digo:<\/span><\/p>\n

    \n
  1. O mais importante \u00e9 que o programador pensa no projeto com anteced\u00eancia. Isso evita mudar o c\u00f3digo toda vez que mudar de ideia.<\/span><\/strong><\/li>\n
  2. A primeira consequ\u00eancia de escrever o README.TXT \u00e9 a cria\u00e7\u00e3o de um documento completo com a ess\u00eancia do projeto. Escreva o texto antes de come\u00e7ar o desenvolvimento: \u00e9 nessa hora que o entusiasmo \u00e9 maior, o que ajuda a colocar as id\u00e9ias no papel.<\/span><\/strong><\/li>\n
  3. Se estiver trabalhando em equipe, compartilhar o documento d\u00e1 a chance de seus colegas come\u00e7arem projetos que ir\u00e3o conversar com seu c\u00f3digo.<\/span><\/strong><\/li>\n
  4. Discutir e construir em cima de id\u00e9ias escritas \u00e9 mais f\u00e1cil do que falar sobre id\u00e9ias abstratas. Ter o README.TXT como linha guia torna o trabalho mais f\u00e1cil.<\/span><\/strong><\/li>\n<\/ol>\n

    Os argumentos de Tom Preston-Werner parecem s\u00f3lidos o bastante para provocarem uma reflex\u00e3o nos programadores. O que voc\u00ea acha?<\/span><\/p>\n

    Leia o texto original\u00a0aqui<\/a>.<\/span>
    \nCurtiu o post? Deixe nos coment\u00e1rios se voc\u00ea j\u00e1 conhecia o programa README.TXT e se j\u00e1 conferiu as vantagens que ele proporciona na hora da escrita!\u00a0<\/span><\/p>\n

    <\/i>Love<\/span>0<\/span><\/span><\/a> <\/i> <\/i>