Quando uma empresa faz um projeto, o README é feito, ainda que o código não seja público? ou o README é algo mais usado pela comunidade de devs?
Você está vendo a versão anterior da nova experiência da Alura que estamos preparando para você. Em breve, ela ganha uma identidade visual novinha totalmente pensada em potencializar seus estudos!
Solucionado
Quando uma empresa faz um projeto, o README é feito, ainda que o código não seja público? ou o README é algo mais usado pela comunidade de devs?
Olá, Yan!
Sua pergunta é bastante relevante. O README.md é uma prática comum tanto em projetos de código aberto quanto em projetos internos de empresas. Ele serve como uma espécie de "manual" ou "introdução" ao projeto, contendo informações como o propósito do projeto, instruções de instalação e uso, informações sobre licença, contribuições, entre outros.
Mesmo que o código não seja público, é muito útil ter um README.md em projetos internos de uma empresa. Isso porque ele ajuda novos membros da equipe a entenderem rapidamente o que o projeto faz e como eles podem começar a trabalhar nele. Além disso, também ajuda a manter a documentação do projeto atualizada e acessível.
Por exemplo, imagine que você está ingressando em uma nova equipe que mantém um projeto interno complexo. Se esse projeto tem um README.md detalhado, você pode lê-lo e obter uma boa compreensão do projeto sem precisar perguntar a cada membro da equipe ou vasculhar o código-fonte.
Portanto, independentemente de o código ser público ou não, o README é uma prática recomendada para qualquer projeto de software.
Espero ter ajudado e bons estudos!
Entendi, muito obrigado!!