Legislação de programas

Introdução

A documentação de um programa complementa o seu código para torná-lo mais compreensível para quem for analisar os detalhes de sua implementação bem como para facilitar o entendimento de seu funcionamento. Pretende-se, com a cobrança de documentação, criar em você o hábito de registrar, ainda que de forma mínima, detalhes complementares importantes relativos à construção dos programas por você produzidos bem como decisões de projeto tomadas por você durante a sua implementação. Na sua vida profissional, dificilmente você irá desenvolver software apenas por você. Além de embutir no código informações complementares para o seu entendimento e de outras pessoas que necessitem entender a forma como o programa em questão foi concebido e construído, é preciso deixar claro, na interface de usuário, em que estado o programa em execução se encontra e o que é esperado do usuário em em cada estado.
A documentação também é importante para você próprio. Depois de um certo tempo não lembramos mais de decisões de projeto tomadas quando da confecção de um determinado software. Uma documentação de um software deve registrar estas decisões para facilitar a manutenção deste software. A documentação, portanto, é tão importante quanto o código. Por esta razão,documente bem aquilo você produz!

1

Legislação de Programas

A documentação é parte integrante de qualquer sistema ou programa criado. A documentação é tão importante (ou mais) que as questões de segurança pois sem a devida documentação,bug’s e pontos vulneráveis no sistema demoram a ser encontrados e corrigidos, permitindo assim que os ataques continuem levando à falência múltipla do sistema e, consequentemente, de seu usuário. Mas, então, por que mesmo documentar?A principal questão em relação a isso está relacionada à própria natureza dos softwares, que têm algumas características predominantes: É complexo; Pode ser desenvolvido por várias pessoas; Pode ser desenvolvido para atender