normas
No desenvolvimento de projetos informáticos, e sobretudo no de software, a documentação é uma componente imprescindível para o projetista. Um Relatório é um documento técnico! Não é um romance, nem um ensaio!
Corresponde a distribuir a informação/dados ao longo do papel de forma estruturada. Descreve um produto/projeto e o trabalho realizado para o implementar. Deve formular o projeto/produto realizado, descrever os processos e técnicas utilizadas, analisar criticamente o trabalho, assim como o seu método, e apresentar um balanço. Deve ser organizado de forma a permitir uma compreensão fácil do trabalho realizado (linguagem gráfica, diagramas explicativos), admitindo-se que o leitor possui conhecimentos básicos mas não conhece as tarefas executadas. Deve também dar, de forma gradual, toda a informação necessária para a compreensão do trabalho realizado, dos processos usados e suas análises críticas. Assim, não devem ser usados conceitos que não tenham sido anteriormente definidos (exceto quando são de uso corrente). Pela leitura do relatório devemos ser capazes, tanto quanto possível, de reproduzir o produto/projeto. 2 - Estrutura do Relatório
Deverá ter a seguinte macroestrutura (começando em páginas separadas e ímpares):
Capa/Contracapa
Epígrafe
Agradecimentos
Advertência
Índice
Lista de Figuras
Lista de Tabelas
Lista de Siglas, acrónimos e abreviaturas
Lista de programas desenvolvidos
Material que acompanha o relatório
1 – Introdução
2 – Fundamentação teórica
3 – Desenvolvimento da solução
4 – Desenvolvimento da implementação
5 – Segurança
6 – Testes
7 – Distribuição do produto
8 – Análise crítica final
Bibliografia (Referências)
Glossário de termos
A – Anexo 1 (Código)
B – Anexo 2 (Manual de utilizador)
C – ………..
_____________________________________________________________________________________________________________________
©