Quem nunca se deparou com aquela documentação oficial e tomou um susto, deu um passo para trás ou caiu da cadeira de sono? 🤣
Realmente a princípio as documentações oficiais, principalmente aquelas menos visuais e antigas, tendem a dar essa primeira impressão, mas não recue! A leitura e hábito de lidar com esse tipo de documento é essencial para qualque carreira que siga na TI e também trás diversos benefícios a longo prazo na sua jornada profissional.
Atualmente existem diversos formatos de documentações das ferramentas utilizadas, seja um framework, bibliotecas ou até mesmo as linguagens de programação. O fator temporal também é crucial com a cara do documento, sendo que uma mais antiga tende a ter poucos elementos visuais e interativos do que uma que foi lançada há pouco tempo.
Pelo fato de serem tradicionalmente categorizadas como cansativas e um tanto massante de serem lidas, houve um movimento de transformar a sua leitura mais prazerosa e dinâmica, auxiliando inclusive na absorção do conteúdo e na curva de aprendizado da tecnologia descrita.
Hoje em dia, com os diversos recursos que possuímos para absorver o mesmo tipo de conteúdo, muitos preferem alguns caminhos alternativos do que a própria documentação em si, e também é positivo! Todo tipo de conteúdo que for válido no seu aprendizado seja no que for é interessante, porém ainda é necessário conhecer e ter em alcance a documentação oficial pelo simples fato de que é lá que todos outros tipos de conteúdos da ferramenta sairam. Tudo que a ferramenta é capaz de entregar e como ela funciona, do início ao fim, está no documento oficial e por essa razão é necessário saber lidar com esse tipo de texto.
Como a maioria dos caminhos árduos, os louros são louváveis... Vamos refletir um pouco sobre os benefícios que essa jornada de documentação nos trás de vantagens!? 🎯
Leitura Objetiva
Quanto mais se pratica algo melhor você fica nessa atividade. Ao se deparar com algumas documentações, é possível observar um certo padrão entre a grande maioria delas, as vezes até na própria formatação e segmentação do documento. Logo, quanto mais documentações você ler, mais habituado fica quando tem que recorrer as origens da ferramenta para tirar uma dúvida ou ver sobre algum assunto mais técnico.
Mesmo quando o documento possui um padrão bem diferente do habitual, a ideia dele segue a mesma: explicar sobre a ferramenta e seu intuito, funcionalidades e em grande suma um tutorial ou os famosos QuickStart. Sei que com a corrida do dia-a-dia fica complicado de destrinchar cada etapa do texto, mas com certeza vale a pena voltar para dar uma olhadinha, mesmo que seja apenas uma vez pelo menos nas quais você mais se indentifica ou usa constantemente.
Quando seu olho fica mais acostumado com a cara das documentações, você já tem uma idéia de onde achar o que procura, pelo menos de onde começar sua busca. Certamente sua leitura fica muito mais focada e objetiva, e com o passar do tempo, irá realizar suas consultas muito mais rápido! 🤓
Vou deixar duas documentações aqui as quais são muito similares e possuem um padrão bem clássico de quem tem contato com a linguagem de programação Python e certamente já viu pelo menos algo similar ao procurar alguma biblioteca.
Requests: https://docs.python-requests.org/en/latest/index.html
Flask: https://flask.palletsprojects.com/en/2.2.x/
Aprendizado Bônus
Uma das curiosidades que reparei após um tempo tendo contato constante com documentações foi que as vezes, ao procurar sobre algo, percebia que depois de ter encontrado o que desejava continuava dando aquela olhadinha um pouco a mais e acabava tendo um aprendizado bônus, mesmo que fosse algo simples.
Claro, o tempo é crucial ainda mais quando se está trabalhando! Porém, caso você tenha aqueles minutinhos a mais e pode dar uma descida na página, não irá se arrepender. Não é necessário gastar horas vendo assuntos extras, mas pelo menos um tópico abaixo, uma função, um parágrafo que seja pode evitar que você tenha que voltar a consultar na documentação por algo que já estava ali ao seu alcance naquele momento.
Isso muitas vezes é interessante de se fazer pois provavelmente, se você fez sua consulta e achou o segmento que precisava, saber um pouco a mais sobre essa parte não irá fazer mal, inclusive pode te ajudar ainda mais no desenvolvimento e economizar um tempo evitando de ler novamente a documentação! ⏱️
Inglês Técnico
Por mais que muita gente não goste muito da idéia, é um fato que a maioria dos conteúdos de TI estão disponíveis na língua inglesa. Como as documentações oficiais são um tanto mais formais (a grande maioria 🤐), possuem muitos termos técnicos e uma linguagem mais formalizada, com algumas palavras menos coloquiais.
Já sabemos que quanto mais se pratica algo melhor você fica nessa atividade e o mesmo vale para leitura e vocabulário! Ao ler cada vez mais as documentações e criar o hábito de consultá-las vamos absorvendo esse inglês técnico da TI, auxiliando ao comparecer em algum workshop, vendo uma palestra, lives, notícias sobre TI, as próprias documentações e pode nos auxiliar até em questões de exames de certificação!
Podemos enumerar diversas vantagens somente sobre leitura, ainda mais sobre esse tipo de texto extremamente importante na área de TI. Fiz uma breve lista e descrição sobre alguns tópicos que acredito que sejam muito positivos e espero que com esse artigo possa incentivar a leitura das tão temidas mas tão generosas documentações oficiais!
E ai, estamos prontos para a próxima consulta naquelas docs das suas tecnologias favoritas? Espero que sim! 😎