DEV Community

Cover image for como montar um readme.md para o seu projeto
tati
tati

Posted on

como montar um readme.md para o seu projeto

Na hora de organizar os nossos projetos no GitHub, o momento de escrever o README.md é o que mais traz dúvidas e insegurança nos desenvolvedores iniciantes. Como saber se a minha documentação está legível? Isso é pouca informação? É muita informação? Como deixar o meu readme interessante para quem pode se interessar no meu projeto?

Parece que não, mas ter um arquivo README.md no seu repositório pode fazer uma grande diferença na forma como o seu perfil é visto e como você é apresentado para uma nova oportunidade. É atráves do README.md que as pessoas, sejam elas colaboradores, colegas e recrutadores, vão aprender mais sobre quem é você como pessoa desenvolvedora, quais são os projetos que você já trabalhou, o que você já estudou e está estudando, como você se organiza, como deve ser utilizando habilidades como trabalho em equipe, gestão de projetos, etc.

São tantas perguntas que eu decidi reunir algumas dicas de como eu monto as documentações dos meus projetos, de onde eu tirei inspiração e algumas formas diferentes de criar o seu próprio readme.

Informações básicas de um bom README.md

1. Título do projeto

Dar um nome para o seu projeto é importante para que tornemos esse projeto real. Mesmo que ele seja algo para estudo, um projeto fictício, ao darmos um nome para o projeto conseguimos torná-lo concreto e então conseguimos "vendê-lo" para qualquer pessoa que nos perguntar sobre tal projeto.

2. Descrição do projeto

Dedique uma parte do seu README para explicar qual é o objetivo desse projeto, o seu propósito e quais motivos você o criou.

3. Funcionalidades do projeto

Enumere o que existe no seu projeto, quais são as suas funcionalidades e quais páginas o projeto.

4. Tecnologias utilizadas

Descreva quais ferramentas e tecnologias foram usadas no seu projeto, desde bibliotecas, frameworks, linguagens, IDEs e qualquer outra coisa essencial para a sua criação e funcionamento.

5. Inicialização

Informe para quem visitar o seu repositório como inicializar o seu projeto após o git clone, se é necessário rodar um npm ou se precisa instalar alguma dependência na máquina local.

6. Implementações futuras

Se esse projeto é um trabalho em andamento, informe quais serão os próximos passos e o que você deseja implementar nas próximas sprints.

7. Colaboradores

Se esse projeto foi criado em grupo ou teve algum tipo de colaboração informe quem foram as pessoas que estão contribuindo, deixando também o link do GitHub e/ou do LinkedIn dessa equipe.

8. Status do projeto

Informe se esse projeto está em andamento ou se está concluído.

Leitura complementar sobre criação de readme.md

Discussion (1)

Collapse
silvairsoares profile image
Silvair L. Soares

Excelente artigo, parabéns!

Uma ferramenta super interessante para ajudar a formatar o readme.md:
pandao.github.io/editor.md/en.html