Documentação de software é algo muito difícil de fazer. É comum encontrarmos pessoas que documentam absolutamente tudo, outras que não documentam nada e aquelas que fazem uma documentação tão complicada, que você lê e não entende.

É preciso ter um bom senso do que realmente será necessário e importante para o projeto. Por isso guarde apenas o que for útil e evite, por exemplo, escrever um manual de 50 páginas, a não ser que seja EXTREMAMENTE necessário. E não se esqueça de separar a documentação por áreas e se atentar à linguagem utilizada, pois diferentes pessoas terão acesso a ela. Nem todos têm o mesmo grau de conhecimento em um determinado assunto e isso pode dificultar a interpretação das informações.

Veja mais dicas sobre documentação de software no vídeo abaixo.

22 de julho de 2016