«título do relatório»
«nome da organização»
20XX / 20XX
«número» «nome do aluno»
«título do relatório»
«nome da organização»
200X / 200X
«número» «nome do aluno»
Licenciatura em Engenharia Informática
«m...
iii
«dedicatória»
«título do projeto / estágio»
iv
Agradecimentos
Nesta secção colocam-se notas de agradecimento às pessoas que contribuíram...
«título do projeto / estágio»
v
Resumo
O resumo do relatório (que só deve ser escrito após o texto principal do relatório ...
«título do projeto / estágio»
vi
Índice
1 Introdução.........................................................................
«título do projeto / estágio»
vii
Índice de Figuras
Figura 1 - Exemplo de imagens a) difícil leitura; b) fácil leitura Fon...
«título do projeto / estágio»
viii
Índice de Tabelas
Tabela 1 - Exemplo de tabela............................................
«título do projeto / estágio»
ix
Notação e Glossário
CPU Processador
SO Sistema operativo
WS Web service
PHP Linguagem de ...
«título do projeto / estágio»
«autor» 1
1 Introdução
Nota: Este guia de elaboração de relatório é apenas um guia e como ta...
1.1.1 Planeamento de projeto
Nesta subsecção deve ser apresentado o planeamento (cronograma, etc.) definido para a
execuçã...
«título do projeto / estágio»
«autor» 3
2 Contexto
Este importante capítuloserve paraefetuarumaapresentaçãodoproblema,enqu...
Caso utilizem componentes menos conhecidas de tecnologias (ex., APIs de componentes
externos, web services proprietários, ...
«título do projeto / estágio»
«autor» 5
3 Descrição técnica
O capítulo (ou conjunto de capítulos) da descrição técnica é a...
seus vários níveis (alto, médio, baixo), a identificação e especificação de requisitos, a
modelação, a descrição dos compo...
«título do projeto / estágio»
«autor» 7
4 Conclusões
O capítulo de conclusõesé um dosmais importantesdorelatório,devendose...
Caso se identifiquemlimitações provocadas pelas escolhas tecnológicas,é nesta secção que
deve ser feita uma análise de alt...
«título do projeto / estágio»
«autor» 9
Bibliografia
LEIC-FEUP, Guia de Elaboração de Relatórios LEIC. Texto académico.
DE...
«título do projeto / estágio»
«autor» 10
Anexo 1 Conteúdo em anexos
Estaparte dorelatóriodeveconterinformaçãoadicional org...
«título do projeto / estágio»
«autor» 11
Anexo 2 Regras de Conteúdo e Estrutura
Dependendode cadaprojeto,apropostade estru...
É essencial não esquecer de rever ortograficamente o texto, preferencialmente usando o
acordo ortográfico em vigor. Os pro...
«título do projeto / estágio»
«autor» 13
2.3 Imagens e tabelas
As imagenssódevemsercolocadasnotextoquandoauxiliemainterpre...
Tabela 1 - Exemplo de tabela
Modelo Fator Preço Fator Desempenho
Pentium III 800 Mhz Muito barato Já não é aceitável
Penti...
«título do projeto / estágio»
«autor» 15
 para uma comunicação em conferência: nome(s) do(s) autor(es),ano da conferência...
Figura 2 - Exemplo de lista de bibliografia
Fonte: Sousa, 2002
«título do projeto / estágio»
«autor» 17
Anexo 3 Projetos de desenvolvimento
Este anexo apresenta uma proposta de estrutur...
5.1. Resumo do relatório
5.2. Objetivos realizados
5.3. Outros trabalhos realizados
5.4. Limitações e trabalho futuro
5.5....
«título do projeto / estágio»
«autor» 19
identificarosrecursosde “hardware”necessáriosàinstalaçãodosistemausandopara
tal d...
1
Próximos SlideShares
Carregando em…5
×

1

129 visualizações

Publicada em

0 comentários
0 gostaram
Estatísticas
Notas
  • Seja o primeiro a comentar

  • Seja a primeira pessoa a gostar disto

Sem downloads
Visualizações
Visualizações totais
129
No SlideShare
0
A partir de incorporações
0
Número de incorporações
3
Ações
Compartilhamentos
0
Downloads
1
Comentários
0
Gostaram
0
Incorporações 0
Nenhuma incorporação

Nenhuma nota no slide

1

  1. 1. «título do relatório» «nome da organização» 20XX / 20XX «número» «nome do aluno»
  2. 2. «título do relatório» «nome da organização» 200X / 200X «número» «nome do aluno» Licenciatura em Engenharia Informática «mês e ano de apresentação» Orientador ISEP: «nome» Supervisor Externo: «nome»
  3. 3. iii «dedicatória»
  4. 4. «título do projeto / estágio» iv Agradecimentos Nesta secção colocam-se notas de agradecimento às pessoas que contribuíram para a realização da tarefa, normalmente indicando-se a sua contribuição (ou seja o porquê do agradecimento). No caso de terem usufruído de financiamento via bolsa ou qualquer outro mecanismo formal, deverá incluir-se esse agradecimento.
  5. 5. «título do projeto / estágio» v Resumo O resumo do relatório (que só deve ser escrito após o texto principal do relatório estar completo) é uma representação abreviada e precisa, sem acrescento de interpretação ou crítica, escrita de forma impessoal, podendo ter, por exemplo, as seguintes três partes: 1. um parágrafo inicial de introdução do contexto geral do trabalho. 2. resumodosaspetosmaisimportantesdotrabalhodescritonopresente relatório,que por sua vezdocumentaotrabalhomaisimportante realizadodurante oestágio.Deve mencionar tudo o que foi feito, por isso deve concentrar-se no que é realmente importante e ajudaroleitoradecidirse querounãoconsultarorestantedorelatório. 3. um parágrafo final com as conclusões do trabalho realizado. Palavras Chave (Tema): incluir 3 a 5 palavras/expressões chave que caraterizemoprojetodopontode vistade tema/área de intervenção. Palavras Chave (Tecnologias): incluir 3 a 5 palavras/expressões chave que caraterizem o projeto do ponto de vista de tecnologias utilizadas.
  6. 6. «título do projeto / estágio» vi Índice 1 Introdução...............................................................................................................1 1.1 Apresentação do projeto/estágio....................................................................1 1.2 Tecnologias utilizadas......................................................................................2 1.3 Apresentação da organização .........................................................................2 1.4 Contributos deste trabalho .............................................................................2 1.5 Organização do relatório.................................................................................2 2 Contexto..................................................................................................................3 3 Descrição técnica....................................................................................................5 4 Conclusões..............................................................................................................7 4.1 Resumo do relatório........................................................................................7 4.2 Objetivos realizados ........................................................................................7 4.3 Outros trabalhos realizados ............................................................................7 4.4 Limitações e trabalho futuro...........................................................................7 4.5 Apreciação final...............................................................................................8 2.1 Linguagem.....................................................................................................11 2.2 Formatação....................................................................................................12 2.3 Imagens e tabelas..........................................................................................13 2.4 Bibliografia.....................................................................................................14 3.1 Secção de “Análise e modelação”.................................................................18 3.2 Secção de “Desenvolvimento da solução”....................................................19 3.3 Secção de “Testes, experiências e instalações”.............................................19
  7. 7. «título do projeto / estágio» vii Índice de Figuras Figura 1 - Exemplo de imagens a) difícil leitura; b) fácil leitura Fonte: Sousa 2002 .............14 Figura 2 - Exemplo de lista de bibliografiaFonte: Sousa, 2002 ..........................................16
  8. 8. «título do projeto / estágio» viii Índice de Tabelas Tabela 1 - Exemplo de tabela...........................................................................................14
  9. 9. «título do projeto / estágio» ix Notação e Glossário CPU Processador SO Sistema operativo WS Web service PHP Linguagem de programação... «Esta secção (glossário de termos) apresenta os conceitos ordenados alfabeticamente, símbolos matemáticos e acrónimos utilizados no corpo do relatório.»
  10. 10. «título do projeto / estágio» «autor» 1 1 Introdução Nota: Este guia de elaboração de relatório é apenas um guia e como tal não substitui o diálogoentre alunoe orientadorparaamelhordefiniçãodaestruturae conteúdodo relatório em cada caso concreto. O relatório final do Projeto/Estágio da Licenciatura em Engenharia Informática é um documentoque descreve todasasatividadesdesenvolvidaspeloalunodurante operíodode projeto/estágio. Como tal, deverá realçar a componente de integração profissional (no caso de projeto com estágio) e/ou desenvolvimento técnico (no caso de apenas projeto). Na elaboração do relatório o aluno deve ter sempre presente que está a produzir um documentoparaserlidoporoutraspessoase que,de certaforma,resume todooseuprocesso de aprendizagem ao longo do curso. A unidade curricularde Projeto/Estágio deve tambémdesenvolveroespíritocrítico doaluno, que se carateriza pela identificação de defeitos e virtudes de um tema ou problema. Assim, espera-se que orelatório,maisdoque uma meradescriçãode atividades,contenhatambém uma análise autocrítica aos conhecimentos adquiridos e do trabalho desenvolvido. A introdução deve dar ao leitor a informação básica necessária por forma a facilitar o enquadramento dos objetivos e dos resultados. A introdução começa com uma perspetiva geral do problema em estudo (na secção de enquadramento) em que, à medida que vai progredindo,deveirfornecendoinformaçãomaisespecíficaaté se abordaraáreaemconcreto tratada no relatório.Deve descrever, de forma sucinta, o problema em estudo e enunciar os principais métodosquesãoutilizadosnotrabalho,bemcomoaidentificaçãoclaradosaspetos inovadores da solução. A introdução deve terminar com a apresentação sucinta das secções que fazem parte do resto do relatório. 1.1 Apresentação do projeto/estágio Deve descrever, de forma sucinta, o problema em estudo e enunciar os principais métodos que são utilizados no trabalho. Esta secção deve apresentar resumidamente o trabalho de projeto/estágioe citarosobjetivosdefinidos,osquaisdevemserenunciadosde formasucinta e clara. Esta secção deverá esclarecer claramente qual a motivação para a realização do trabalho.
  11. 11. 1.1.1 Planeamento de projeto Nesta subsecção deve ser apresentado o planeamento (cronograma, etc.) definido para a execução do projeto com indicação das tarefas, datas e principais fases (milestones). 1.1.2 Reuniões de acompanhamento Nestasubsecçãodevemserlistadasasreuniõesefetuadasentreoalunoe oorientadore entre o aluno e o supervisor durante o decurso do projeto. Para cada reunião deve ser indicada:  A data  Os participantes  O local  Breve descrição do(s) tema(s) debatido(s) 1.2 Tecnologias utilizadas Esta secçãoopcionaldeve conterumabreve descriçãodas tecnologiasutilizadasnotrabalho. Caso a escolha das tecnologias tenha sido parte integrante do trabalho desenvolvido, esta informaçãodeverásurgirnaparte relativaaocontextodotrabalhoe serbemfundamentada. 1.3 Apresentação da organização Secção opcional,casose trate detrabalhodesenvolvidonumaorganizaçãoexternaaoISEP/IPP, descrevendo sucintamente a organização e a sua área de intervenção. 1.4 Contributos deste trabalho Deve apresentarosaspetosinovadorese de realce dotrabalho,bemcomoaidentificaçãodos benefícios trazidos para a instituição. 1.5 Organização do relatório Apresentação sucinta dos capítulos que fazem parte do relatório, descrevendo em poucos parágrafos o que cada um deles irá tratar.
  12. 12. «título do projeto / estágio» «autor» 3 2 Contexto Este importante capítuloserve paraefetuarumaapresentaçãodoproblema,enquadrando-o num contexto mais global, e descreve todos os aspetos relacionados com o trabalho, nomeadamente:  Área ou áreas de negócio (fundamental);  Historial da organização (se fizer sentido);  Enquadramento do problema (fundamental). Deve também apresentar os pressupostosdoproblema,oque se esperaobtere quaissãoosváriossubproblemas em que se pode desdobrar;  Caso se trate de um projeto de reconversão ou de manutenção de módulos/aplicações existentes,deveráserfeitaumabreve apresentaçãotécnicae o resumo da evolução (versões) dos módulos/aplicações existentes;  Processo de desenvolvimento e método de trabalho (fundamental);  As diversas tecnologias utilizadasnodesenvolvimentodoprojeto (se fizer sentido). Dependendode cadaprojeto,esteconteúdopode serseparadoemmaisdoque umcapítulo. O aluno deve discutir com o orientador qual a melhor abordagem para o seu caso. Neste capítulo devem-se apresentar as metodologias e tecnologias utilizadas no desenvolvimento.Casoastecnologiastenhamsidoescolhidasnoâmbitodotrabalho,deveser apresentadaumajustificaçãoparaessadecisão.Não se devemapresentarsecçõesexaustivas sobre as tecnologias, a menos que se tratem de tecnologias muito recentes ou específicas. Exemplos de tecnologias que não é necessário apresentar de forma exaustiva são:  Tecnologias web comuns (ex., PHP, Java, ASP.net, JSP, XML, etc.)  Sistemas gestores de repositórios (ex., Oracle, SQL Server, MySQL, etc.)  Plataformas de execução (ex., Java, .NET, etc.)  Servidores web (ex., Apache, IIS, etc.)  Linguagens e ambientes de programação (ex., C, C++, NetBeans, etc.) Para as tecnologiasreferidasbastaráumapequenasecçãoreferindoasua utilização.Nocaso de tecnologiasrecentesouespecíficas,deve-seincluirumasecção(oucapítuloseparado) que forneça o conhecimento mínimo necessário ao leitor para compreensão do assunto.
  13. 13. Caso utilizem componentes menos conhecidas de tecnologias (ex., APIs de componentes externos, web services proprietários, etc.), devem também incluir uma secção de descrição desses componentes. De um pontode vistatécnicodevemevitar-se comparaçõesentre tecnologias/metodologiasa menos que: 1. Tal estudo comparativo faça parte dos objetivos de trabalho; 2. Tenhamencontradolimitaçõesnatecnologiaque a organizaçãodecidiuutilizare que poderiam ser resolvidas usando outra tecnologia. No segundo caso, a comparação deverá aparecer após apresentarem o trabalho e as dificuldadesencontradas,podendoinclusive serapresentadacomomelhoriafuturaoucomo análise crítica ao trabalho desenvolvido.
  14. 14. «título do projeto / estágio» «autor» 5 3 Descrição técnica O capítulo (ou conjunto de capítulos) da descrição técnica é a componente mais importante do relatório, pois descreve o que realmente foi feito no projeto/estágio. Existem duas possibilidades de estrutura:  orientada para o projeto – deve ser utilizada na elaboração de relatórios em que há um “produto”bemdefinidoaapresentar.Um exemploé aconstruçãode ummódulo oude uma novaaplicação.Nestecasorecomenda-seodesdobramentodeste capítulo em vários capítulos ou secções, evoluindo do problema para a solução;  orientada a tarefas – deve ser usada na elaboração de relatórios de estágioem que não existe propriamente um “produto”a apresentar,massimuma váriastarefasque foramrealizadasemumou vários “produtosousistemas”já existentes.Umexemplo é um estágio em que foi feita uma intervenção nos vários serviços de infraestrutura ou módulosde umaaplicaçãoparasuportaruma novatecnologia.Neste caso,deverá existirumcapítuloousecçãoparacadatarefa/subprojeto,sendoqueemcadacapítulo ou secção devem ser descritasas atividades referidasno ponto anterior. A estrutura típica recomendada é: o Tarefa/Subprojeto 1 o Tarefa/Subprojeto 2 o ... o Tarefa/Subprojeto n Os contratempos do estágio (por exemplo, avarias de servidor, organização parada, etc.) devem ser referidos de forma explícita. Ao elaborar o relatório devem ter em atenção que o relatório servirá como documentação para a organização. Assim sendo, devem-se questionar se o relatório descreve de forma suficientemente detalhada o trabalho para que possa ser compreendido e reproduzido,se necessário,nofuturoporoutraspessoasdaorganização.Todasasboaspráticasabordadasno curso ou externamente deverãoserusadasneste capítuloe no relatórioemgeral,desde que esse uso traga mais valias para o projeto. Note-se que este capítulo não deve conter exclusivamente a explicação da forma como métodos, técnicas, algoritmos, tecnologias,etc. foram usados, mas também o processo de compreensão do problema, a visão da solução, como o problema foi atacado e eventualmente subdividido em sub-problemas,a análise nos
  15. 15. seus vários níveis (alto, médio, baixo), a identificação e especificação de requisitos, a modelação, a descrição dos componentes da solução, etc. Recomenda-se que a descrição técnica siga uma abordagem que parta do “geral” (descrição inicial do problema) para o “particular” (descrição técnica completa e coerente da solução), sem saltar etapas. O aluno deve, conjuntamente com o orientador, definir a estrutura mais adequada ao seu projeto. Nota: no 17 é apresentadaumapropostade estruturapara esta parte do relatórioparao caso de projetos/estágios de desenvolvimento de produto ou sistema.
  16. 16. «título do projeto / estágio» «autor» 7 4 Conclusões O capítulo de conclusõesé um dosmais importantesdorelatório,devendoserapresentados os resultados do trabalho efetivamente desenvolvido. As conclusões finais devem focar o sucesso/insucesso do trabalho, revendoas dificuldades encontradas. Devem resumir, de forma objetiva, as vantagens do produto desenvolvido e a utilidade quepossaterparaaorganizaçãoouparaos seusclientes/parceiros.Casose aplique, devemtambémreferircomodecorreuglobalmenteoprojeto/estágio,bemcomoaintegração, a formação recebida, as facilidades e as dificuldades sentidas ao longo do tempo. As conclusões devem basear-se nos resultados realmente obtidos. Devem enquadrar-se os resultados obtidos com os objetivos enunciadose procurar extrair conclusões mais gerais, eventualmente sugeridas pelos resultados. Podem acompanhar as conclusões incluindo recomendaçõesapropriadasresultantesdotrabalho,nomeadamentesugerindoe justificando eventuais extensões e modificações futuras. 4.1 Resumo do relatório Esta secção é opcional, servindo apenas para relembrar os pontos mais importantesfocados nos capítulos anteriores. 4.2 Objetivos realizados Nestasecçãodevemserrepetidososobjetivosapresentadosnocapítulode introduçãoe para cada umdelesdeveserdescritooseugraude realização.Recomenda-seousode umalistaou tabela, dado que facilita a leitura e compreensão. 4.3 Outros trabalhos realizados Secção opcional em que se descrevem outros trabalhos de menor importância realizados durante oprojeto/estágio e que não faziam parte dos objetivos nem do trabalho principal. 4.4 Limitações e trabalho futuro Nestasecçãodevemseridentificadososlimitesdotrabalhorealizado(condiçõesdeoperação), fazendo uma análise autocrítica do trabalho realizado, bem como extrapolar eventuais direções de desenvolvimento futuro.
  17. 17. Caso se identifiquemlimitações provocadas pelas escolhas tecnológicas,é nesta secção que deve ser feita uma análise de alternativas e sugestão de outras abordagens. 4.5 Apreciação final Esta secção deve fornecer uma opinião pessoal sobre o trabalho desenvolvido.
  18. 18. «título do projeto / estágio» «autor» 9 Bibliografia LEIC-FEUP, Guia de Elaboração de Relatórios LEIC. Texto académico. DEI-ISEP (2002), Normas de elaboração de relatório de estágio. Normas de avaliação. Sousa, Paulo (2002) Pequeno Guia de Elaboração de Relatórios,Unidade de Ensino. Instituto Superior de Engenharia do Porto. Nota: ver no 11 (secção 14 Bibliografia) indicações sobre como elaborar a lista de bibliografia.
  19. 19. «título do projeto / estágio» «autor» 10 Anexo 1 Conteúdo em anexos Estaparte dorelatóriodeveconterinformaçãoadicional organizadaporcapítulosque,embora sejainteressante,nãofazparte domaterial estritamentenecessárioaorelatório.Documentos importantes produzidos ou utilizados durante o estágio que, pela sua dimensão, não sejam colocáveis no corpo principal do relatório podem ser incluídos em anexos. Um exemplo possível é um capítulo com o “diário” de trabalho que o aluno elaborou (no moodle ounoutrorecursoafim).Outroexemploé umcapítulocomas experiênciasrealizadas maisdetalhadas.Eventualmente,nosanexospoderátambémapareceromanual de utilizador da aplicação ou módulo desenvolvido.
  20. 20. «título do projeto / estágio» «autor» 11 Anexo 2 Regras de Conteúdo e Estrutura Dependendode cadaprojeto,apropostade estruturaapresentadanestedocumentopodeser alterada, acrescentando novos capítulos, subdividindo capítulos ou juntando capítulos. O aluno deve discutir com o orientadorquala melhor abordagempara o seu caso,seguindo as linhas orientadoras apresentadas. A dimensão dos capítulos deve ser equilibrada de forma a não haver muita diferença no número de páginas entre capítulos. Consideram-se exceção os capítulos de introdução e de conclusão. Cada um destes capítulos deve ter uma dimensão à volta de 10% do total de páginas do relatório. A estrutura dos capítulos deve ser tal que contenha secções e subsecções de forma equilibrada, cada uma contendo partes relativamente separadas do trabalho. A primeira secçãodeve começarnoprincípiodocapítulo.Nãodeverãoexistirsecçõesousubsecçõescom menos de uma página e não deverá haver apenas uma secção (subsecção) dentro de um capítulo (secção). Devem ser evitadas subsecções com demasiados níveis, devendo-se usar, como regra geral, até ao 3º nível (ex., 1.1.1.). Asprimeiraspáginas,atéànotaçãoinclusive,identificam-se comnumeraçãoromanaemletras minúsculas. A numeração de capítulo/secção é efetuada em sequência. Cada novo capítulo deve iniciar-se no topo de uma página. A numeração de páginas dos anexos é feita continuandoanumeraçãodotextoprincipal.Parasepararoscapítulosdeveminserirquebras de página do documento. 2.1 Linguagem A linguagemde umrelatóriodeveserrigorosa,clarae com caráter técnico.Deve serevitadas frases na primeira pessoa: por exemplo, a frase “desenvolvi em seguida o módulo de faturação” deve ser rescrita da seguinte forma: “em seguida foi desenvolvido o módulo de faturação” ou “em seguida desenvolveu-se o módulo de faturação”. Também se deve evitar o uso de expressões “coloquiais”, de opiniões pessoais não fundamentadas e o excesso de adjetivos/advérbios. Excecionalmente, poderão ser dadas opiniões pessoais nas conclusões, tendo sempre em atenção a clareza e a boa educação. As siglas devem ser sempre definidas na primeira vez que são usadas no relatório.
  21. 21. É essencial não esquecer de rever ortograficamente o texto, preferencialmente usando o acordo ortográfico em vigor. Os processadores de texto atuais possuem mecanismos de correção ortográfica, mas não de correção gramatical, pelo que devem sempre rever pessoalmente o texto, podendo recorrer à ajuda de terceiros. 2.2 Formatação A formatação do relatório (tipo de letra, tamanho, estilos utilizados, etc.) é da responsabilidade do autor. No entanto devem seguir algumas regras de bom senso e boas práticas (Sousa, 2001)(DEI-ISEP, 2002):  reduzir ao mínimo o número de tipos de letra utilizados (dois ou três no máximo);  usar um tipo de letra com tamanho de fácil leitura (por exemplo, Calibri 11pts);  serconsistente nautilizaçãodostiposde letra(usarsempreomesmotipoparaotexto, usar sempre o mesmo tipo para os cabeçalhos, etc.);  utilizartamanhosde letralógicos(porexemplo,se otamanhodaletrase modificarde acordo com o nível de cabeçalho, não deverá ser usado um tamanho de letra maior para um cabeçalho de nível inferior);  evitar “decorações” nos tipos de letra (sombras, rebordos, etc.);  usar judiciosamente o negrito e o itálico nos parágrafos de texto, devendo a sua utilizaçãoficarrestritaapequenosexcertosde texto que realmente importa realçar;  usar espaçamento um e meio ou duplo entre as linhas para facilitar a leitura;  usar parágrafos “justificados” (simultaneamente à esquerda e à direita);  usar numeração correta e lógica de páginas, capítulos, secções, etc. Deverão utilizar as funcionalidades do processador de texto escolhido para a definição de estilos, de modo a garantir um aspeto homogéneo do relatório. É necessárioterematençãoas margensdaspáginas:deverãoserevitadasmargensinferiores a 2 cm.
  22. 22. «título do projeto / estágio» «autor» 13 2.3 Imagens e tabelas As imagenssódevemsercolocadasnotextoquandoauxiliemainterpretaçãodoassuntoque se estáa abordar. Na preparaçãodasimagensdeve havercuidadoparaevitarmálegibilidade, prestando atenção ao número de elementos existentes na imagem, ao tamanho dos elementos e ao tamanho do texto. Adicionalmente, devem evitar demasiadas cores e “floreados” nos diagramas técnicos a apresentar. Cada imagem deve ser apresentada com um título curto que a identifique claramente, colocadoporbaixodaimagem,assimcomoaorigemda figura(obrigatório).A figuraseguinte mostra dois diagramas que traduzem o mesmo conteúdo, no entanto são diferentes em termos visuais e de facilidade de leitura. input output processamento input output processamento Figura 1 - Exemplo de imagens a) difícil leitura; b) fácil leitura Fonte: Sousa 2002 Astabelasdevemserusadasparaapresentardados/informaçãoquese queiracruzaremvárias dimensões ou que se queira analisar segundo vários atributos. Cada tabela deve ser apresentadacomum título curto que a identifique claramente,colocadoporcima da tabela. A formatação de tabelas deve respeitar as regras apresentadas anteriormente, evitando “floreados”e garantindoqueatabelanãoficadivididaentrepáginas.Deve-sefacilitaraleitura e identificarcorretamente alinhae/oucolunade cabeçalho.A tabelaseguinte é umexemplo possível de utilização e formatação de tabelas.
  23. 23. Tabela 1 - Exemplo de tabela Modelo Fator Preço Fator Desempenho Pentium III 800 Mhz Muito barato Já não é aceitável Pentium IV 2.7 GHz Caro Um dos melhores no mercado As figurase tabelasdevemtersempre umtítuloe número.Verifiquemasfuncionalidadesdo processadorde textoparacriaçãoautomáticade título de figurase tabelas,poisissofacilitaa sua numeração e posterior criação de índices. Os índices de tabelas e de figuras devemser gerados automaticamente pelo processador de texto. Quando se finalizar o relatório devem atualizar as tabelas de índices e outras existentes, gerando em seguida a versão em formato PDF, a qual deverá ser cuidadosamente revista de modo a verificar-se a sua correção em relação ao documento original. 2.4 Bibliografia O capítulo de bibliografia apresenta a lista de bibliografia consultada para a execução do projeto/estágio.A lista de bibliografia deve estar ordenado por autor (último nome) e em seguida por ano. Notexto,sempre que utilizemdadosouafirmaçõesde terceirosdevemindicarafonte desses dados ou a afirmação,colocandoentre parêntesiscurvoso nome da referência,porexemplo (Sousa, 2002). A formatação de cada entrada bibliográfica é diferente consoante o tipo de documento em questão:  para um livro: nome(s) do(s) autor(es),anodaediçãoentre parêntesis,título dolivro em itálico, nome da editora, local da edição, país da edição;  para um artigo em revista: nome(s) do(s) autor(es), ano da edição entre parêntesis, título do artigo em itálico, nome da revista, volume da edição a negrito, númeroda edição, páginas;
  24. 24. «título do projeto / estágio» «autor» 15  para uma comunicação em conferência: nome(s) do(s) autor(es),ano da conferência entre parêntesis,títulodacomunicaçãoentre aspas,nome da conferênciaemitálico, local da conferência, país da conferência, mês da conferência;  para uma tese: nome do autor, ano da tese entre parêntesis, título da tese, tipo de tese, universidade da tese, local da universidade, país da universidade;  para um relatório interno: nome(s) do(s) autor(es),anodorelatórioentre parêntesis, título do relatório, origem do relatório, referência do relatório, instituição de acesso ao relatório,local da instituição,paísda instituição,mêsdorelatório(abreviadocom 3 letras, exceção aos meses com 4 letras);  para um documento extraído da Internet: o endereço entre parênteses, incluindo a data da última visita ao documento;  para um endereço da Internet: o endereço e a data da última visita ao endereço. Na figura seguinte é apresentada uma lista bibliográfica com um exemplo de cada tipo referido.
  25. 25. Figura 2 - Exemplo de lista de bibliografia Fonte: Sousa, 2002
  26. 26. «título do projeto / estágio» «autor» 17 Anexo 3 Projetos de desenvolvimento Este anexo apresenta uma proposta de estrutura para a descrição técnica de relatórios de projeto/estágioqueconsistamnodesenvolvimentode soluções. Oaluno deve,conjuntamente com o orientador, adaptar a estrutura mais adequada ao seu projeto. Proposta de estrutura do relatório (capítulos, secções principais e duas subsecções): 1. Introdução 1.1. Enquadramento 1.2. Apresentação do projeto/estágio 1.3. Apresentação da organização 1.4. Contributos deste trabalho 1.5. Estruturação do relatório 2. Contexto 2.1. Problema 2.2. Áreas de negócio 2.3. Estado da arte 2.4. Visão da solução 3. Ambiente de trabalho 3.1. Metodologia de trabalho 3.2. Planeamento de trabalho 3.3. Tecnologias usadas 4. Descrição técnica 4.1. Análise e modelação 4.2. Desenvolvimento da solução 4.3. Testes, experiências e instalações 5. Conclusões
  27. 27. 5.1. Resumo do relatório 5.2. Objetivos realizados 5.3. Outros trabalhos realizados 5.4. Limitações e trabalho futuro 5.5. Apreciação final 5.5.1. Planeamento do trabalho 5.5.2. Solução 3.1 Secção de “Análise e modelação” Nesta secção é apresentado um modelo conceptual do problema a resolver. É aqui que normalmente se apresentam os modelos de dados, diagramas de estruturas (módulos e/ou classes), etc. correspondentes ao problema e à solução proposta. Na análise de umproblemae desenvolvimentodarespetivasolução,é frequenteseguir-se os seguintes passos (utilizando-se os diagramas UML indicados) (Sousa, 2002): 1. requisitos/funcionalidades – dialogandocom o cliente, identificar as funcionalidades de alto nível (as “grandes” funções) pretendidas no sistema para cada perfil de utilizador,recorrendoadiagramasde casosde utilizaçãoe/oudiagramasde domínio. 2. processos – continuandoodiálogocomocliente,analisare efetuarumadescriçãode alto nível dos processos existentes no sistema e das interações entre os diferentes intervenientes nesses processos (“workflow”), recorrendo a diagramas de interação (sequência e colaboração). 3. estrutura lógica – partindo do diagramas de casos de utilização e dos diagramas de interaçãode altonível,identificare descreverdetalhadamenteasdiferentesentidades existentes no sistema (recorrendo a diagramas de classes), bem como detalhar os diagramas de interação anteriores por forma a incluir as classes de implementação identificadas e respetivas operações (diagramas de sequência e de colaboração). 4. estrutura física –identificarosdiferenteselementosfísicosdosistema(ex.,bibliotecas de funções, executáveis) recorrendo-se de diagramas de componentes, bem como
  28. 28. «título do projeto / estágio» «autor» 19 identificarosrecursosde “hardware”necessáriosàinstalaçãodosistemausandopara tal diagramas de instalação. 3.2 Secção de “Desenvolvimento da solução” Esta secção descreve a implementação da solução proposta na secção anterior. Alguns dos diagramas referidos na secção anterior podem aparecer nesta secção e não na secção de análise; é o caso dos diagramas de classes ou diagramas de módulos. Nesta secção são detalhadas as operaçõesde cada classe ou as funções de cada módulo (usando pseudónimo ou diagramas de atividades). São também descritas as especificidades de implementação de acordo com o ambiente de desenvolvimento,plataformae linguagemescolhidaparaodesenvolvimento.Devemtambém ser reportados os problemas encontrados e a solução escolhida para os resolver. Os contratempos do estágio (por exemplo, falhas de servidor, etc.) devem ser referidos. 3.3 Secção de “Testes, experiências e instalações” Esta secção descreve a instalação da solução (não confundir com configuração). O que se entende por instalação é a arquitetura física concreta onde a solução foi instalada e os componentes necessários. São tambémaqui descritosostestesefetuadose apresentadososdados/modelosutilizados, bemcomo os resultadosobtidos.Casotenhamsidorealizadasmelhoriasdevidoaoresultado dos testes ser insuficiente ou errado, isso deverá ser devidamente explicado. Estasecçãopoderánãoexistiremalgunsrelatóriosde projeto/estágio, masnesse casodeverá ser dada uma justificação para tal.

×