Executando verificação de segurança...
3

A Importância de Ler a Documentação: Não é Porque Está Funcionando que Você Fez da Melhor Forma Possível!

Mesmo quando conseguimos fazer um código funcionar, não podemos presumir que o fizemos da melhor forma possível. É por isso que a leitura da documentação é fundamental. É necessário compreender completamente um framework ou a linguagem que estamos usando, a fim de explorar todo o seu potencial e implementar as melhores práticas.

A documentação dessas ferramentas fornece informações detalhadas sobre suas funcionalidades, recursos e boas práticas. Ao ler a documentação, podemos adquirir um conhecimento mais aprofundado e obter insights sobre como utilizar adequadamente as funcionalidades.

Além disso, a leitura da documentação nos ajuda a evitar erros comuns e a maximizar a eficiência do código. Peculiaridades e características específicas podem ser descobertas apenas por meio da documentação. Ignorar esses detalhes pode levar a problemas futuros e comprometer a qualidade do nosso código.Também nos capacitamos a solucionar problemas de forma autônoma. Compreender os detalhes técnicos do framework ou linguagem nos permite identificar a origem de erros ou comportamentos inesperados. Isso nos torna menos dependentes de suporte externo e mais capazes de resolver problemas de forma eficiente.

Portanto, é essencial lembrar que apenas fazer algo funcionar não garante que estamos utilizando uma ferramenta da melhor forma possível. A leitura é um investimento valioso de tempo e esforço, que nos permite aprofundar nosso conhecimento, aproveitar todas as capacidades da tecnologia escolhida e evitar erros prejudiciais ao nosso projeto.

Carregando publicação patrocinada...
3

Obrigado pela postagem, ela é importante.

Eu observo que as pessoas não usam a documentação corretamente. Gosto muito disto (por isso eu o criei :D):

Fiat 147 todo detonado andando pelas ruas

Quando você não lê a documentação com toda atenção, ou não a interpreta corretamente acaba criando isso.

Muitas pessoas contentam só com o funcionamento. Vemos isso o tempo todo.

Tem que ler tudo. Não tem jeito. Não tem atalho. Tem que ler mais que tudo. Tem que procurar mais informações, porque a documentação não tem todos os detalhes. O Stack Overflow foi uma mão na roda sobre isso (pelo menos pelas postagens do passado, hoje isso não é tão verdade, ele acabou se transformando em um mural de help desk e não tem mais o diferencial que tinha antes e o tornou famoso).

Tem que entender que os exemplos da documentação servem só para mostrar o mecanismo e não são receitas de bolo para copiar e usar em seu código. Precisa saber que nem todo material é bom, e especialmente as documentações produzidas em modo wiki costumam ter erros.

A documentação não pode ser usada sozinha, ou substituta de entender bem todos os fundamentos. Usá-la é um hábito saudável para quem sabe programar. Ela não opera milagres para quem não sabe.

Existe um problema enorme para as pessoas conseguirem saber o que precisa ser visto previamente e só o que pode ser visto só no momento do uso. Em geral a pessoa não tem experiência para decidir isso. Vale para todo mundo, mesmo eu tendo 40 anos fazendo isso em coisas novas eu erro. Por isso preciso estar atento para errar menos. Achar que eu sei é onde eu erro mais.

Achei curioso o exemplo do Kaio. Ele tem razão. Pena que não pode ser transposto para a programação. Você não precisa ser um engenheiro automobilístico para usar um carro (entender do hardware), mas precisa entender muito de carro se você for um piloto profissional.

Você está falando de programação para fazer um bot para o discord, um script bobinho porque o Excel não deu conta ou fazer uma graça em uma página HTML? Se for isso, ok, não tenho dicas para você. Mas se você quer ser um profissional desenvolvedor de software, eu sei que quer ser um piloto automobilístico, não um motorista, especialmente um domingueiro.

Você precisa saber como funciona. E aí vem o que não está na documentação. Se você não sabe isso ainda pode entregar um resultado, mas ele não será bom. E é por isso que tem cada vez mais pessoas com dificuldades para achar vagas (que sobram por aí, sobram muito) e não conseguem salários ótimos como prometem em todo canto. A documentação é só a ponta do iceberg. E novamente, saber a hora de ver cada parte é algo que terá que desenvolver, precisa de prática, de tentativa e erro. Só sei que aprender algo nunca é demais. Desperdiçar o tempo é outra questão.

Eu prefiro pecar pelo excesso do que pela falta. Sempre deu certo para mim. Achar que está aprendendo em excesso pode ser a desculpa perfeita para ser desleixado. Mais uma vez, a dose é você que terá que achar, e se acertar ou errar, você que colherá o lucro ou prejuízo.

A maioria das pessoas pecam pela falta. É isso que precisa ser reforçado.

Nem sempre precisa fazer da melhor forma possível, mas nunca pode fazer inferior ao básico necessário. E para saber qual é o básico necessário precisa estudar muito, inclusive a documentação. Por isso boa parte, talvez a maioria, dos sites que as pessoas desenvolvem algo sofrem de SQL Injection, que é um dos básicos necessários. Só para citar um exemplo. Poderia falar do inúmeros que não escalam e precisam de soluções mirabolantes, porque não leram a documentação da computação.

Sem isso vira terraplanismo.

Obrigado pela oportunidade de debate.

Espero ter ajudado.

Farei algo que muitos pedem para aprender a programar corretamente, gratuitamente. Para saber quando, me segue nas suas plataformas preferidas. Quase não as uso, não terá infindas notificações (links aqui).

2

Olá, Craverath!

Achei esse tópico muito relevante e gostaria de colocar alguns pontos que eu concordo e que discorco (claro haha).

Primeiro os pontos pacíficos. Acho que ler a documentação é fundamental, realmente e, fazendo o mea culpa confesso que às vezes pulo direto pro código sem ter a paciência de parar e ler os fundamentos e entender o contexto e objetivo do framework. Isso vale também para perguntas e respostas em sites como StackOverflow e acredito que ferramentas de geração de código com base em IA pode acentuar esse efeito.
Indo além, eu acho que é importante também fortalecer as bases do desenvolvimento, entender alguns conceitos básicos que podem ser replicados em diversos cenários como, por exemplo, recursividade, injeção de dependência, códigos de status HTTP.

Agora, entrando na polêmica. Não sei se entendi corretamente a intenção, mas eu não acho que seja necessário compreender toda a documentação para utilizar um framework ou linguagem. Acho que é necessário sim uma boa fundamentação, mas alguns recursos mais avançados podem ser aprendidos apenas quando necessário, principalmente quando falamos de ambientes mais completos e que possuem vários casos de uso não essenciais. Digo isso porque esse tipo de fala pode gerar um sentimento de "nunca serei bom(boa) o suficiente" que impede o ingresso e desenvolvimento de muitas pessoas. Sem falar que, quando falamos de júniors, sempre há o fator do aprendizado com colegas de trabalho e com o legado do que se está trabalhando atualmente.

Mas indo além, acho que é válido a experimentação, o "Hello world!" no terminal, para treinar, validar o aprendizado, refatorar para buscar novas formas de resolver um mesmo problema, de forma mais eficiente ou mais simples de se entender. Explorar conteúdos OpenSource também é uma ótima forma de obter conhecimento, principalmente de forma mais prática.

Sucesso e boa sorte!

1

Quando o seu objetivo é dirigir e manter um veículo, além de dirigir você precisa saber um básico de manutenção nele para mantê-lo. Mas isso não significa que você precisa decorar o manual inteiro de um carro ou saber todo o seu processo de produção. Seu objetivo é dirigir e mantê-lo, e não construir um do zero, não é necessário conhecer toda a documentação do framework "veículo".
Nesse caso você só vai estar enchendo sua cabeça de informações sem uso, é melhor conhecer os fundamentos e o básico e depois se aprofundar em pontos o qual vai utilizar de acordo com a demanda.

Lembrando: meu ponto de vista.

1

Nos meus primeiros anos de júnior, confesso que muitas vezes eu não tinha paciência pra ler documentação e tentava fazer tudo direto.

Com o tempo percebi que muitas vezes eu perdia mais tempo do que se tivesse lido antes. Isso porque eu achava que o negócio funcionava de um jeito, e só depois de ler a documentação vi que era completamente diferente. Se tivesse lido antes, não teria perdido tempo tentando entender porque não fazia o que eu achava que iria fazer.

Ou seja, o que eu achava que era perda de tempo ("pra que ler esse textão?"), na verdade economizava (não só imediatamente, mas no longo prazo também).

Documentação é importante, não a ignore.