Estrutura de um relatório ou tese



1. Introdução
   1.1. Enquadramento do trabalho

   1.2. Objectivos do trabalho

   1.3. Resultados/ contribuiçoes relevantes
   
        Os resultados/contribuições devem ser enumerados
        e descritos de forma sucinta (1 parágrafo para cada resultado, 
        por exemplo).

        O relatório organizar-se-á em torno destes resultados, pelo
        devem ser muito bem identificados à partida.


   1.4. Estrutura do relatório

        Guia de leitura do relatório. 
        Apresenta a lógica do relatório e indica o que vai ser 
        encontrado em cada capítulo.


2. Tópico 1

   Um capítulo deve poder ser lido autonomamente e deve ter 
   3 partes - introdução, desenvolvimento e conclusões. Encontra-se
   organizado em secções.
   
   Na introdução é apresentada a lógica do capítulo e indicado o que pode
   ser encontrado em cada uma das secções.

   As secções de desenvolvimento descrevem um conjunto de matérias 
   com relação bem identificada com o trabalho descrito ou com os 
   resultados apresentados. Pode ser uma descrição simples do estado
   da arte ou a apresentação de um "framework". Um framework consiste
   na utilização de um modelo ou de conjunto de abstracções que servem 
   para descrever o tópico de forma original. É usado em relatórios de
   doutoramento.  
 
   Nas conclusões referem-se os pontos importantes do capítulo, 
   e podem ser transversais às Secções. Estes pontos serão, muito
   provavelmente, úteis ao leitor nos capítulos seguintes.  



3. Tópico 2 

   Pode ser mais um Capítulo de estado da arte, de formalização do
   problema a resolver, ou de descrição do ambiente de desenvolvimento.



4. Descrição do trabalho

   Descrição do trabalho efectuado e dos resultados/contribuições 
   obtidos.

   Os tópicos anteriores devem ter sido introduzidos de modo
   a que, neste capítulo, o trabalho/resultados possam ser 
   descritos de forma simples.  


5. Avaliação do trabalho

   Metodologia usada para validar os resultados/contribuições, 
   Experiências efectuadas.
   



6. Conclusões

   6.1. Revisão do trabalho desenvolvido
        
        Objectivos do trabalho, conclusões relevantes


   6.2. Resultados / contribuições relevantes
      
        6.2.1 Resultado 1

              Caracterização do resultado. Justificação.
              Aspectos positivos e negativos.

        6.2.2 Resultado 2
        6.2.3 Resultado 3

        6.3 Trabalho futuro

             Indentificar novos trabalhos que possam ser 
             executados sobre os resultados apresentados.



Algumas notas sobre o estilo da escrita:

1. a escrita deve ser organizada em torno do parágrafo. 
   Cada parágrafo deve ser dedicado a um único assunto e, 
   na primeira linha do parágrafo, deve poder perceber-se 
   logo qual é esse assunto;

2. o parágrafo deve ser grande. Uma página terá 
   tipicamente 3 ou 4 parágrafos. Este estilo de escrita permite 
   uma leitura "fotográfica" da página;

3. escreva pela positiva; descreva o que fez e não o que não fez;

4. seja cuidadoso com a utilização de adjectivos e evite 
   descrições vagas.  Não diga que  o seu código é rápido; diga 
   que determinada função é executada em cerca de 2 s. Não diga 
   que fez muito código; diga que fez cerca de 8000 linhas de código;

5. depois de escrever uma frase ou um parágrafo releia-o. Se 
   conseguir colocar aa mesma informação num menor número de 
   palavras, faça-o;

6. Não use uma segunda frase para explicar de outra forma o assunto 
   que descreveu na primeira frase; nesta situação deverá re-escrever 
   a primeira frase;

7. Se, durante a escrita, sentir necessidade de abrir parenteses ou 
   introduzir um parágrafo adicional para introduzir um qualquer 
   conceito, reformule o texto. Provavelmente estes conceitos deveriam 
   ter sido introduzidos numa secção ou num capítulo anterior. As frases e 
   os parágrafos devem aparecer sempre em sequência natural;

8. Use sempre o mesmo nome para descrever o mesmo conceito. Se, 
   por exemplo, começou por chamar _nó_ a um elemento de rede, 
   então use sempre este nome, mesmo que tenha que o repetir várias 
   vezes na mesma frase; evite, nesta situações, a utilização de 
   nomes sinónimos.


Manuel Ricardo, Julho 2003