Documentação Externa

A documentação externa pode tomar muitas formas e ter como alvo muitas e variadas audiências, desde manuais descritivos das capacidades do programa (manuais para o utilizador), até relatórios técnicos descrevendo a implementação (para o(s) programador(es)).

No que se segue vai-se descrever uma forma de Relatório de projecto no qual se pretende:

• Identificar o trabalho e os seus autores;
• Descrever (especificar) o problema;
• Descrever a sua utilização (manual do utilizador);
• Apresentação do Algoritmo implementado;
• Apresentação da Estrutura de Dados usada;
• Referência a particularidades do programa (se é que as tem).

Em anexo deve-se incluir:

• Listagem do programa;
• Exemplos de utilização do programa;

Documentação externa: Um Exemplo

Identificação

Projecto _, Disciplina ____, Ano Lectivo _____/____

Realizado por: ________________

Especificação

Cálculo das raízes de equações não lineares usando o método da bissecção.

Entrada:

a,b,erro (os extremos do intervalo e a margem de erro a considerar).

Saída:

x (o valor aproximado da raiz de (x/2)²+sin(x), no intervalo [a,b] o qual tem de conter uma, e uma só, raiz da função).

Utilização

Após a invocação (na linha de comando) do programa raízes basta seguir as indicações do programa.

Algoritmo

 Alg
   ler(a,b)
   ler(erro)
   estabelece valor inicial para a raiz
   Enquanto nao acha solucao e |a-b| >= erro Faz
     calcula nova aproximacao
   Fimenquanto
   escreve(raiz)
 Fimalg

Estrutura de Dados

Utilizaram-se variáveis do tipo real.

Particularidades

O programa aplica o método da bissecção ao cálculo das raízes da função (x/2)²+sin(x), a sua adaptação para outras funções é possível e de fácil realização.

Os exemplos e a listagem devem ser produzidos por impressão directa dos respectivos ficheiros, sendo que os exemplos devem conter um conjunto representativos dos casos possíveis de funcionamento do programa.