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

Como ler documentações?

Olá!
Tenho uma dúvida simples, mas que me atrapalha bastante na hora de estudar.
Como ler documentações de tecnologia corretamente? Como você faz para ler?
Você lê quando já está desenvolvendo um projeto?
Eu nunca sei se deveria começar pelo tutorial da documentação; se devo ler somente sobre funções específicas para algum tipo de projeto, ou algo do tipo.

Bom... Minha dúvida pode parecer complexa de se entender, o que de fato é mesmo quando eu quero aprender algo novo.

Ex: Estou tentando aprender FASTAPI para fazer um crud usando uma API de buscador de CEP. Mas como ler a documentação e obter o melhor desempenho dessa leitura?

Carregando publicação patrocinada...
2

Oii LeandroTorres!

Uma dica é ler a documentação do início ao fim para entender o funcionamento geral. Se você já estiver desenvolvendo algum projeto, recomendo que você leia sobre funções específicas para seu projeto. Além disso, é importante que você faça alguns experimentos com a documentação para entender melhor o funcionamento da tecnologia e como usá-la em seu projeto.

No seu exemplo, você pode começar lendo a página principal do FASTAPI para entender seu funcionamento. Em seguida, você pode ler sobre como criar um CRUD usando a API de busca de CEP, por exemplo!

1
2

Falae leandroTorres, tudo joia?

Então, creio que cada dev tenha o seu estilo de estudo
Eu infelizmente não tenho muita paciencia para ler de cabo a rabo a documentação, normalmente, quando é meu primeiro contato com o framework, engine, api etc, eu costumo a ler o Get Started ou First Steps e futuramente vou pesquisando conforme as minhas necessidades forem surgindo.

Eu costumo a pesquisar muito no google, e consequentemente o google vai acabar me indicando a propria documentação (se eu pesquisar corretamente)

Eu costumo a realizar a pesquisa assim:
[Nome do projeto] [e o que vc quer fazer nele]
exemplo:
angular create component
bootstrap modal full screen
javascript filter list by value
Super importante pesquisar em ingles (mesmo com o ingles bem precario igual o meu)

Porem, não subestime a documentação, durante sua jornada, provavelmente vc vai ter uma duvida, que você provavelmente não faz ideia de como perguntar
É nessas horas que eu reviro a documentação, procurando o que preciso!

Novamente, isso é um costume meu, e provavelmente pode não ser o ideal rsrsrsrs

Mes espero ter colaborado com a sua duvida!

Abraços!!!

1

Opa! Colaborou e muito. Muito obrigado pela ajuda!
Cada comentário importa, ajuda a pensar melhor e desenvolver estratégias de como pesquisar e entender uma doc.

2

Olá @LeandroTorres, tudo bem?

que me atrapalha bastante na hora de estudar.

Acredito que isso é uma coisa natural, sabe? Está estudando uma determinada tecnologia? Ao invés de ficar lendo algum post ou vídeo, tente ir direto na fonte. Tá complicado de entender? Pode ser que seja algo ali que esteja mal escrito(não é raro), ou parte do conteúdo você ainda não tem como base, o que dificultará seu entendimento.

Não tem um "momento" para se ler uma documentação. Eu trabalho como front-end, por exemplo, e mexo muito com React. Quando foram introduzidos os hooks eu fui até o site do React para ler a documentação sobre o assunto. Como já tenho usado isso há certo tempo, não necessito mais.

Vou trabalhar com uma tecnologia nova? Vou pra documentação para ler o que ela se propõe a resolver. Achei bom, vou usar, continuo a leitura para saber como aplicá-la. Se eu achar complicado procurarei material extra pela internet.

1