The latest articles on DEV Community by Pedro Rosa (@pedrorcruzz). https://dev.to/pedrorcruzz https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.us-east-2.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F2738152%2Fa54bc419-e618-46f1-b115-fd82d41a9e81.jpeg https://dev.to/pedrorcruzz en Pedro Rosa Thu, 23 Jan 2025 14:25:35 +0000 https://dev.to/pedrorcruzz/por-que-documentar-anotacoes-e-codigos-e-essencial-para-o-aprendizado-concreto-3b92 https://dev.to/pedrorcruzz/por-que-documentar-anotacoes-e-codigos-e-essencial-para-o-aprendizado-concreto-3b92 <p>No mundo da programação e tecnologia, aprendemos algo novo quase todos os dias. Mas, muitas vezes, essas informações acabam sendo esquecidas se não forem devidamente documentadas. Neste post, quero compartilhar por que documentar suas anotações e códigos é tão importante para o aprendizado concreto e como isso pode ajudar você a reter conhecimento a longo prazo.</p> <p>Por que documentar é importante?</p> <div class="highlight js-code-highlight"> <pre class="highlight plaintext"><code>1. Facilita a revisão: Ao anotar conceitos e exemplos de código, você cria um material personalizado para revisar quando precisar. 2. Organiza seus estudos: Você consegue acompanhar seu progresso e identificar lacunas no aprendizado. 3. Compartilha conhecimento: Sua documentação pode ajudar outras pessoas, seja uma colega de trabalho ou alguém buscando conhecimento na internet. </code></pre> </div> <p>Um exemplo prático: meus repositórios de estudos<br> Como exemplo, estou documentando meus estudos de Python e TypeScript em dois repositórios no GitHub:<br> •<a href="https://github.com/pedrorcruzz/py-studies" rel="noopener noreferrer">py-studies</a><br> •<a href="https://github.com/pedrorcruzz/ts-studies" rel="noopener noreferrer">ts-studies</a></p> <p>Nesses repositórios, compartilho anotações, exemplos práticos e pequenos projetos relacionados aos tópicos que estou aprendendo. Além de servir como material de consulta para mim, eles podem ajudar outros que estão começando ou explorando esses temas.</p> <p>Conclusão:</p> <p>Documentar seus estudos não é apenas uma maneira de se organizar, mas também de consolidar o aprendizado e contribuir para a comunidade. Comece pequeno, com anotações simples, e veja como isso pode transformar sua jornada de aprendizado.</p>