DEV Community 👩‍💻👨‍💻

Cover image for Documentação perto do código
Sávio Santos
Sávio Santos

Posted on

Documentação perto do código

Eu encorajo e me arrisco a seguir os seguintes princípios:

  • O código é mais importante do que a documentação, mas com o tempo você vai esquecer parte do que codificou. Portanto, documente desde o início para obter uma visão de alto nível do que você fez.

  • O código é mais importante do que a documentação, mas ter a documentação ajudará qualquer pessoa a ingressar no projeto no futuro. Isso evitará o fator ônibus.

  • Usar uma ferramenta de documentação específica é legal, mas se estiver muito longe do código, você pode esquecer de atualizar a documentação. Portanto, traga a documentação o mais próximo possível do código.


Tópico 2 do Manifesto Ágil: "Software em funcionamento mais do que documentação abrangente."
Enter fullscreen mode Exit fullscreen mode

Vamos procurar melhores formas de integrar o código à documentação. Software funcional é importante, mas ainda precisamos de documentação.


Exemplos de ações que promovem direta ou indiretamente a documentação próxima ao código:

Feedbacks são sempre bem-vindos.

Repositório do Github: https://github.com/savi8sant8s/documentation-near-the-code

Top comments (0)

🌚 Browsing with dark mode makes you a better developer by a factor of exactly 40.

It's a scientific fact.