DEV Community

Documentação de Software

Na medida que o software cresce, torna-se mais difícil ententer, manter e detectar erros. Grande parte destas questões é superada quando há uma documentação do sofware.

Ao contrário do que pensamos, a documentação de um software não é o código. Tendo em conta que existem milhares de linguagens de programação, o código pode não ser percebido por desenvolvedores de outras linguagens.

Devemos considerar que os Gestores ou Clientes não precisam ler exaustivamente cada linha de código para entender o software. A documentação deve ser percebida até para os não desenvolvedores.

A documentação não precisa ser complexa, muito formal ou focada em muitos detalhes desnecessários. Apenas precisamos documentar os aspectos que facilitam a compreensão do Software, tanto para os desenvolvedores quanto para os outros envolvidos.

As imagens abaixo apresentam uma sugestão simples para documentação de um software.

Documentação
Image description

Documentação do Software

Image description

Documentação da Base de Dados
Image description

Discussion (0)