Admito, está faltando uma palavra no título desse post. O correto seria: "Leia a PORRA DA documentação".
"Nossa como você é grosso, estúpido e ignorante, não vou mais nem ler a PORRA desse post".
Realmente é uma pena. Bom, vou agora explicar o porquê comecei desse modo. Acho que na nossa área é incontável o número de programadores que tem preguiça de ler a documentação. E não é apenas porque ela é extensa, em inglês ou complicada, as vezes é simplesmente por achar que não precisa.
Programador que é programador aprende na raça!!!
Shame of you little guy
Como sou programador PHP e meu framework de escolha é o Laravel vou citar a documentação dele como exemplo. Eu simplesmente adoro a documentação do Laravel. Por que? Porque ela é simples e intuitiva. Dúvida? Dá uma olhada aqui.
Sei que alguns vão achar estranho: como eu acho tal coisa? Em qual parte da documentação está tal coisa? To perdido!!!
Eu sei meus amigos, também me perdi.
Mas como assim você se perdeu e está dizendo que a documentação é boa? Vou contar o motivo, e acho que muitos compartilham isso. Eu fui até a documentação procurando por um tutorial para iniciantes, e a documentação não está la para isso (ainda).
Mas então se eu estiver procurando por um tutorial para iniciantes? Bom, você pode googlar por um tutorial, existem vários por ai. Mas então voltando ao assunto da documentação, por que ler a documentação? Bom, depois que você tiver pegado o jeito do framework (ou biblioteca/ferramenta que está estudando) volte até a documentação e leia ela. Mas não superficialmente, leia ela inteira, na ordem em que está escrita. Dê uma olhada em cada método, leia (e entenda) cada parágrafo que está escrito.
Mas porquê??
A principal vantagem eu gostaria de destacar que é "Aprender o que a ferramenta é capaz de fazer".
Nossa, mas dai eu preciso decorar tudo aquilo?!?! Cê ta ficando louco!!!
Não, não é preciso decorar, mas simplesmente você sabe o que é possível fazer. Não consigo mais nem contar quantas vezes já mandei um link de documentação para alguém é essa pessoa diz: "Nossa, nem sabia que dava pra fazer isso."
Entendem agora? Se você ler a documentação você saberá o que a sua ferramenta pode fazer. Você pode não saber exatamente o método que faz aquilo, os argumentos e o retorno, mas você sabe que isso é possível, o que já lhe dará uma enorme vantagem.
Sabendo que sua ferramenta pode fazer isso, vamos a segunda vantagem: "Saber onde procurar".
A segunda coisa que mais ouvi é: "Até sabia que dava pra fazer isso, mas nao conseguia achar na documentação como fazer.". É claro sem ler você vai apenas andar de cima para baixo. Então a segunda vantagem realmente é saber onde procurar, desde as coisas básicas até as mais avançadas. Você saberá onde procurar na documentação, e até aprenderá termos novos para aprender a procurar melhor no Google também.
Mas a documentação é muito longa :(
Pode até ser, mas você não precisar ler toda ela em uma hora, ou em um dia. Você pode ler por partes, aos poucos. Sim jovem, eu sei que você tem trabalho a fazer e teu chefe não vai ficar esperando duas semanas até você aprender tudo pra começar a fazer o projeto, eu sei disso, sou gerente de desenvolvimento e entendo os dois lados: o do Product Owner e o do Programador.
Apesar de entender, algo que eu tenho por premissa de vida é que é dever do Programador se aperfeiçoar na ferramenta que trabalha, e não do P.O. É importante o P.O entender de programação? Não. É dever do Scrum Master entender, mas isso eu falo em outro post. Voltando ao assunto da documentação então você pode ter o seu tutorial e desenvolver sua aplicação meio para agradar o P.O no início, mas sempre lendo e aprendendo para ir melhorando com o tempo. Então: documentação extensa ou que você não pode ler no trabalho não são desculpas, você pode ler em casa e pode ler lentamente (mas leia).
Ótimo, já li. Agora eu sei tudo!!!
Não, você não sabe.
Mas como assim?!?!. Você não sabe ainda, ler uma vez só não é o suficiente.
Mas por quê? Porque documentações podem mudar, coisas novas podem ser adicionadas e coisas obsoletas podem sair.
Então o que eu faço? Simples, leia de novo!
Não, eu não estou ficado maluco. Se é uma ferramenta que você usa no seu dia a dia esteja sempre atualizado. Eu procuro sempre ler novamente a documentação do Laravel, porque ele é o meu framework de trabalho e de projetos pessoais, então é meu DEVER estar sempre atualizado.
Então recapítulando esse post: Leia a PORRA da documentação SEMPRE. É sério, leia mesmo, você terá muito mais vantagens que desvantagens fazendo isso.
Grande abraço e até o próximo post pessoal. :D