vai corinthians
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 o que você produz.
Um relatório deverá conter informações e explicações sobre o programa feito. O conteúdo mínimo desejado é:
Informações de caráter administrativo:
Nome e RA do(s) autor(es).
Turma.
Data de entrega.
Descrição informal e sucinta do que o programa faz. Esta descrição deverá ser feita, de maneira global, a respeito do programa como um todo sem transcrever literalmente, comando por comando, em Português.
Explicações sobre como operar o programa, ressaltando quais são as entradas, como serão solicitadas e quais são as saídas esperadas.
Breve descrição dos algoritmos utilizados na resolução do problema proposto. Aqui cabe novamente a observação acima. Não transcreva para o Português o seu código em Pascal. Abstraia de detalhes de implementação. Produza descrições mais conceituais. Algorimto e programa são coisas distintas. Um algoritmo serve de base para uma implementação de um software sendo que a partir de um algoritmo podemos derivar diversas implementações alternativas.
As condições de contorno, ou seja, qual é o conjunto de dados de entrada válido para o correto funcionamento do programa. Em que situação o seu programa