recomendações para a escrita do relatório - Estágios DI
Propaganda
DEPARTAMENTO DE INFORMÁTICA Licenciatura em Engenharia Informática RECOMENDAÇÕES PARA A ESCRITA DO RELATÓRIO Relatório do Projecto Final de Curso Mês Ano NOME DO ALUNO (NÚMERO) ORIENTADOR: NOME DO PROFESSOR QUE ORIENTOU COORDENADOR EXTERNO: NOME DO COORDENADOR EXTERNO INSTITUIÇÃO: NOME DA INSTITUIÇÃO Agradecimentos Agradecimentos. Página impar. -I- Resumo Resumo do trabalho desenvolvido pelo aluno durante o período de estágio. Este resumo não deverá conter mais do que 1024 caracteres e estará limitado a uma página. Este documento, apresenta um conjunto de indicações de formatação e de estrutura para elaboração do relatório do projecto de fim de curso. Além disso ele pode ser usado como template para a produção do relatório. Para a escrita do relatório cada aluno deverá apoiar-se nas indicações do Professor Orientador, sendo o formato da capa e a existência do resumo os únicos elementos obrigatórios. Algumas partes deste documento destinam-se a exemplificar a estrutura e formatação do relatório e são portanto fictícias. Recomendamos no entanto uma leitura atenta de todas as secções. - III - Índice Geral 1 2 Introdução _______________________________________ 1 1.1 Contexto Académico ___________________________________________ 2 1.2 Contexto Tecnológico e Científico _________________________________ 2 1.3 Objectivos do estágio___________________________________________ 3 1.4 Estrutura do documento ________________________________________ 3 Actividades Desenvolvidas ___________________________ 5 2.1 Secção 2.1 ___________________________________________________ 6 2.1.1 Sub-Secção 2.1.1_________________________________________ 6 3 2.2 Secção 2.2 ___________________________________________________ 7 2.3 Secção 2.3 ___________________________________________________ 8 Recomendações para a escrita do relatório _____________ 11 3.1 Estrutura do Documento _______________________________________ 12 3.2 Formatação do Documento _____________________________________ 12 3.3 Recomendações Gerais ________________________________________ 14 3.3.1 Equações Matemáticas ____________________________________ 14 3.3.2 Figuras e Tabelas ________________________________________ 15 4 Conclusões ______________________________________ 17 4.1 Apreciação Crítica do Trabalho Desenvolvido ________________________ 18 4.2 Trabalho Futuro ______________________________________________ 18 4.3 Apreciação do Estágio _________________________________________ 18 5 Bibliografia ______________________________________ 19 6 Anexos _________________________________________ 21 6.1 Anexo 1 – Título do anexo 1 ____________________________________ 22 6.2 Anexo 2 – Título do anexo 2 ____________________________________ 22 -V- - VI - Índice de Figuras FIGURA 2.1 - DIAGRAMA DO SATÉLITE XMM-NEWTON ............................................................... 9 FIGURA 2.2 - SATÉLITE INTEGRAL. .................................................................................... 10 - VII - Índice de Tabelas TABELA 2.1 - RESUMO DA SINTAXE UML. .............................................................................. 8 TABELA 3.1 – ESTRUTURA ACONSELHADA DO RELATÓRIO........................................................... 12 - IX - 1 Introdução 1.1 Contexto Académico ____________________________ 2 1.2 Contexto Tecnológico e Científico __________________ 2 1.3 Objectivos do estágio ___________________________ 3 1.4 Estrutura do documento _________________________ 3 Introdução 1.1 CONTEXTO ACADÉMICO Este relatório foi escrito no contexto da disciplina de Projecto final de curso da licenciatura em Engenharia Informática da Faculdade de Ciências e Tecnologia da Universidade Nova de Lisboa. Trata-se de uma disciplina semestral de 12 créditos, tendo prevista uma carga horária semanal de cerca de 25 horas. Neste estágio a carga horária semanal média foi de 36 horas. O estágio decorreu durante o período ..... A orientação pedagógica deste projecto esteve a cargo do Professor XXXXX do Departamento de Informática, e outros dados que julguem relevantes. O projecto decorreu na instituição ….. tal. Deve fazer uma breve apresentação da Instituição de acolhimento, sua organização, sua dimensão e seus objectivos. O Coordenador externo, bem como a equipa na qual o aluno foi integrado para desenvolver o seu trabalho de estágio, devem ser apresentados indicando sumariamente qual o papel de cada um. No caso de o estágio do aluno estar inserido num projecto que envolva mais do que um aluno, devem ser indicados quais os restantes alunos e respectivos Professores Orientadores e Coordenadores externos. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. 1.2 CONTEXTO TECNOLÓGICO E CIENTÍFICO É nesta secção que deve apresentar qual o contexto científico e tecnológico em que se desenrola o projecto. Esta secção deverá permitir que o enunciado dos objectivos do estágio, a apresentar na secção seguinte, possa ser feita de forma sintética, clara e objectiva. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para -2- Objectivos do estágio encher para encher para encher para encher para encher para encher para encher para encher. 1.3 OBJECTIVOS DO ESTÁGIO Devem ser apresentados os objectivos do estágio, leia-se, do trabalho a ser desenvolvido pelo aluno, de forma sintética, clara e objectiva. Deverá ser possível avaliar até que ponto os objectivos foram atingidos. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. 1.4 ESTRUTURA DO DOCUMENTO Deve apresentar de forma sucinta a estrutura do relatório. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para -3- Introdução encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. -4- 2 Actividades Desenvolvidas 2.1 Secção 2.1 ___________________________________ 6 2.2 Secção 2.2 ___________________________________ 7 2.3 Secção 2.3 ___________________________________ 8 Actividades Desenvolvidas 2.1 SECÇÃO 2.1 Deve apresentar quais as actividades durante o período de estágio bem como a sua calendarização. Recorra a cronogramas, listas de actividades, produtos ou documentos entregues, etc.. A interacção entre os restantes membros da equipa, nomeadamente com o Coordenador e com o Orientador (reuniões de controlo, etc) também devem ser indicadas. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. 2.1.1 SUB-SECÇÃO 2.1.1 Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. -6- Secção 2.2 Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. 2.2 SECÇÃO 2.2 Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. -7- Actividades Desenvolvidas Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Tabela 2.1 - Resumo da Sintaxe UML. Elemento Use case Descrição Sintax A sequence of actions, including variants, that a system (or other entity) can UseCaseName perform, interacting with actors of the system. Actor A coherent set of roles that users of use cases play when interacting with these use cases. System Represents the boundary between the boundary physical system and the actors who ActorName interact with the physical system. Association The participation of an actor in a use case. i.e., instance of an actor and instances of a use case communicate with each other. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. 2.3 SECÇÃO 2.3 Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. -8- Secção 2.3 Figura 2.1 - Diagrama do satélite XMM-Newton Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. -9- Actividades Desenvolvidas Figura 2.2 - Satélite INTEGRAL. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. Texto para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher para encher. - 10 - 3 Recomendações para a escrita do relatório 3.1 Formatação do Documento ______________________ 12 3.2 Estrutura do Documento ________________________ 12 3.3 Recomendações Gerais _________________________ 14 Recomendações para a escrita do relatório 3.1 ESTRUTURA DO DOCUMENTO A estrutura que se apresenta neste documento é exemplificativa, devendo ser adaptada às necessidades de cada estágio e devem ter o acordo do Professor Orientador, com excepção da secção de Resumo que é obrigatória não devendo exceder nem uma página do relatório nem 1024 caracteres. Em termos da estrutura do relatório recomenda-se a adopção de uma estrutura similar à que se apresenta na Tabela 3.1. Tabela 3.1 – Estrutura aconselhada do relatório Secção Descrição Agradecimentos Opcional, mas é sempre de bom tom. Resumo Obrigatório. Máximo 1 página e 1024 caracteres. Índice Geral Obrigatório. Até nível 3. Índice de Figuras Recomendado quando o número de figuras é superior a 10. Índice de Tabelas Recomendado quando o número de tabelas é superior a 10. Introdução Sugere-se uma estrutura desta secção tal como se apresenta neste documento. Secções intermédias Deve seguir as recomendações do seu orientador. Conclusões Sugere-se uma estrutura desta secção tal como se apresenta neste documento. Bibliografia Deve seguir as indicações apresentadas neste documento. Glossário Se o número de siglas e conceitos for em número significativo. Anexos Use anexos para evitar que o documento se torne maçudo. 3.2 FORMATAÇÃO DO DOCUMENTO Este documento pode ser usado como “template” para a escrita do relatório, permitindo dessa forma que o aluno se concentre no conteúdo do mesmo, sem ter preocupações de formatação. Dito isto, não se pretende limitar a criatividade dos alunos no que respeita à formatação do documento, naturalmente desde que esteja de acordo com as orientações do Professor Orientador. O elemento que deverá ser obrigatoriamente respeitado é a capa, quer no seu conteúdo quer no formato. - 12 - Estilos Se pretender fazer modificações ao formato apresentado neste documento pode fazê-lo, devendo ter em conta que este documento é um documento académico e que portanto não tem porque obedecer a formatos da instituição de acolhimento. É, no entanto, importante realçar que para outros documentos, tais como manuais ou outra documentação técnica, deverá seguir as normas da instituição de acolhimento caso existam. 3.3 ESTILOS Este documento contém um conjunto de estilos pré-definidos para a formatação das diferentes secções do relatório. A utilização destes estilos é meramente uma proposta, podendo o aluno optar pela adição de novos estilos ou a alteração dos existentes. Uma breve listagem das formatações disponíveis assim como a sua utilização encontra-se na tabela abaixo. Tabela 3.2 – Estilos disponíveis no template e sua utilização Secção Utilização Cover – Author Nome do Autor (Capa) Cover – Coordinator Nome do Coordenador (Capa) Cover – Date Data (Capa) Cover – DI Departamento de Informática (Capa) Cover – LEI Licenciatura em Engenharia Informática (Capa) Cover – Report Descrição do documento (Capa) Cover – Title Título do relatório (Capa) Caption Legenda de figuras ou tabelas Figure Formatação para figuras Footer Formatação para o Footer de cada página. Na realidade deve usar os Footer-Even e Footer-Odd de acordo com a situação Header Formatação para o Header de cada página. Na realidade deve usar os Header-Even e Header-Odd de acordo com a situação Heading (1 a 9) Títulos para cada capítulo, secção ou sub-secção Index Cabeçalho para os capítulos que não devem aparecer no índice (e.g. Lista de tabelas) Normal Texto normal Table – Header Cabeçalho de uma tabela Table – Text Texto presente numa tabela Table of Figures Formatação para a listagem de figuras ou tabelas TOC (1 a 9) Formatação para o índice - 13 - Recomendações para a escrita do relatório 3.4 RECOMENDAÇÕES GERAIS As recomendações que aqui se apresentam são apenas orientadoras. Estas recomendações são baseadas nas recomendações de escrita do relatório do “Trabalho final de curso” da Licenciatura em Engenharia Informática e de Computadores do Instituto Superior Técnico. As siglas devem ser sempre definidas da primeira vez que são usadas no texto. O texto deve ser escrito no tempo presente (excepto quando se relatam experiências ou medidas) e na forma impessoal (e não na primeira pessoa do singular ou do plural). Evitar escrita telegráfica ou literária, isto é, não usar frases muito curtas ou muito longas, e não utilizar uma forma de escrita pouco técnica. Usar o corrector de ortografia do processador de texto, Spelling, antes de imprimir o texto. Ter o cuidado de dar um estilo coerente e uniforme ao relatório. Não usar palavras inglesas quando há uma tradução muito directa e corrente para elas. Escrevê-las em itálico no caso de as usar. 3.4.1 EQUAÇÕES MATEMÁTICAS As equações devem ser centradas, e numeradas por capítulo. Por exemplo: c=f(n) (3.1) Os símbolos matemáticos devem ser escritos em fonte itálica. Definir sempre os símbolos depois das equações, na primeira vez que são utilizados. Indicar as unidades das grandezas nas equações (em índice), sempre que aquelas não venham nas suas unidades fundamentais. Não usar o mesmo símbolo para grandezas diferentes. Deve ter-se o cuidado de escrever o mesmo símbolo sempre da mesma forma, isto é, com o mesmo tamanho de fonte (como por exemplo para os índices), com o mesmo significado, etc. Quando se tem números que ultrapassam os milhares, deve usar-se um espaço para separar os milhares, isto é, deve usar-se 12 345 em vez de 12345. Referir as equações apenas pelo seu número. Por exemplo: "deduz-se de (3.1) que o crescimento é linear em n". - 14 - Recomendações Gerais 3.4.2 FIGURAS E TABELAS Há apenas Figuras e Tabelas, e nada mais (como por exemplo, Gráficos, Quadros, ...). Se desejar, pode abreviar-se para Fig. e Tab.. As Figuras e as Tabelas devem ser numeradas por capítulo. As Figuras e Tabelas devem vir centradas horizontalmente na página. Em geral, os números devem possuir a mesma precisão numa mesma tabela. Os números em tabelas não devem vir centrados, para se poder perceber melhor a sua diferença de ordem de grandeza. As legendas devem ser sempre incluídas e centradas no texto. Por exemplo: Figura 2.1 - Unidade Móvel. Tabela 3.5 - Lista de Parâmetros. No caso de as Figuras incluírem múltiplos gráficos (do tipo (a), (b), (c)), a legenda particular deve vir junto ao gráfico e não englobado na legenda geral. Espaço adicional deve ser deixado antes e depois das Figuras e Tabelas. Devem colocar-se as Figuras e as Tabelas no texto só depois de nele virem referenciadas, o que deve acontecer sempre. As Figuras contendo gráficos devem possuir legendas nos dois eixos, com a entidade representada e respectivas unidades. Quando se referem Figuras e Tabelas no texto, estas não devem vir entre parênteses. Por exemplo: Pode observar-se que o decrescimento da potência é monótono, Fig. 3.4. Quando se copiam Figuras de outros autores, esse facto deve ser incluído na legenda. Por exemplo: Figura 4.5 – Arquitectura do sistema (extraído de [6]). - 15 - 4 Conclusões 4.1 Apreciação Crítica do Trabalho Desenvolvido ________ 18 4.2 Trabalho Futuro_______________________________ 18 4.3 Apreciacão do Estágio __________________________ 18 Conclusões 4.1 APRECIAÇÃO CRÍTICA DO TRABALHO DESENVOLVIDO Apreciação crítica do trabalho desenvolvido pelo aluno durante o estágio. 4.2 TRABALHO FUTURO Raramente o trabalho desenvolvido pelo aluno durante o período de estágio remata de forma definitiva o projecto no qual o estágio se insere. Cabe ao aluno fazer uma avaliação de qual o trabalho que deve ser apresentado como projecto final. 4.3 APRECIAÇÃO DO ESTÁGIO Apreciação global da actividade de estágio, referindo aspectos de integração, de experiência pessoal e profissional. É também adequado fazer uma avaliação quer das condições de trabalho que encontrou quer da preparação que a Licenciatura lhe proporcionou. - 18 - 5 Bibliografia Devem usar-se referências no texto sempre que se cita ou se usa resultados de outros autores. Por exemplo: Os produtos resultantes de Peixe e Carne [2] têm sido usados desde o aparecimento da humanidade. Devem ser numeradas pela ordem que aparecem no texto. Não incluir referências que não foram citadas no texto. O formato deve ser: para um livro: [1] D. Patterson e J. Hennessy, Computer Organization and Design: The Hardware/Software Interface, San Francisco, CA, USA: Morgan Kaufmann Publishers, 1997. para um artigo em revista: [2] B. Kernighan e S. Lin., An Efficient Heuristic Procedure for Partitioning Graphs. The Bell System Technical Journal, Vol. 49, No. 2, pp. 291-307, Fevereiro 1970. para uma comunicação em conferência: [3] F. Fallah, S. Devadas, e K. Keutzer. OCCOM: Efficient Computation of Observability-Based Code Coverage Metrics for Functional Simulation. E m Proceedings of the Design Automation Conference, pp. 152–157, Junho 1998. para uma dissertação: [4] D. Cheng. Power Estimation of Digital CMOS Circuits and the Application to Logic Synthesis for Low Power. PhD thesis, University of California at Santa Barbara, Dezembro 1995. para um relatório interno: [5] E. Sentovich et al. SIS: A System for Sequential Circuit Synthesis. University of California, Berkeley, Abril 1992. - 19 - 6 Anexos 6.1 Anexo 1 – Título do anexo 1 _____________________ 22 6.2 Anexo 2 – Título do anexo 2 _____________________ 22 - 21 - Anexos 6.1 ANEXO 1 – TÍTULO DO ANEXO 1 Texto do anexo 1 6.2 ANEXO 2 – TÍTULO DO ANEXO 2 Texto do anexo 2 - 22 -
