A importância de um bom arquivo de README
Na correria de um dia de trabalho e com diversos projetos rolando em paralelo, não é difícil se deparar com alguém te pedindo ajuda (suporte) para algo que você desenvolveu a pouco tempo e você até recorda do assunto, porém não fazer a mínima ideia de com utilizar o programa ou utilitário.
Não sei se isso já aconteceu com você, mas comigo acontece bastante. Muitas vezes eu pego algo que desenvolvi ou escrevi e me surpreendo com o que foi feito por mim, as vezes positivamente :D e outras nem tanto!
Cada um se organiza da forma que acredita ser mais produtivo, contudo como eu costumo criar muitas ferramentas para meu uso e acabo compartilhando com outras equipes preciso deixar um documento para consulta rápida no moldes do README [+] e isso acaba ajudando no processo de resgatar o assunto e mesmo como uma manual de usuário.
Conteúdo para um arquivo README
Ao meu ver um arquivo como esse pode ter tudo o que for necessário para ajudar no desenvolvimento, uso, footprints e até milestones, alguns podem dizer que isso não é nada produtivo e existem muitas ferramentas melhores para realizar essas atividades e eu concordo, mas aqui estamos falando de uma ferramenta pequena e muitas vezes embrionária que precisa ter um escopo mais pragmático de desenvolvimento, dessa forma nada rápido e pratico que um arquivo texto.
Exemplo de seções
- Cabeçalho
- Exemplos de uso
- Versões
- Changelog
- Necessidades X Soluções adotadas
Comentários
Postar um comentário