Dicas sobre como escrever bons READMEs

Eu acredito que muita gente já se perguntou sobre quais seriam as boas práticas para se construir um bom README para seus projetos, e existem diversos posts na internet descrevendo como fazer isso de uma forma concisa e organizada.

Eu recomendo a leitura do texto “Art of README“, o qual coloca de uma forma bastante interessante, dicas sobre como escrever um bom README. Inclusive você pode colaborar com a tradução desse texto para o nosso português.

E então, os seus READMEs estão de acordo com essa lista:

Uma linha explicando o propósito do módulo.
 Links e informações importantes.
Termos potencialmente desconhecidos linkados à fontes de informações.
Exemplo de utilização claro e executável.
Instruções de instalação.
Documentação extensiva da API.
 Organização clara e objetiva do documento.
Advertências e limitações explícitas.
Não depender de imagens para transmitir informações importantes.
Licença.

Leave a Reply

Your email address will not be published. Required fields are marked *