Escola Secundria de Vilela

CURSO PROFISSIONAL
DE

TCNICO

DE

ttulo do relatrio
Prova de Aptido Profissional

2011 / 2012

nmero nome do aluno

Ttulo do projecto

ttulo do relatrio
Prova de Aptido Profissional

2011 / 2012

nmero nome do aluno

Curso Profissional de Tcnico

ms e ano de apresentao
Orientador: nome

Agradecimentos
Nesta seco colocam-se notas de agradecimento s pessoas que contriburam para a realizao da tarefa, normalmente indicando-se a sua contribuio (ou seja o porqu do agradecimento). No caso de terem usufrudo de financiamento via PRODEP, incluir esse agradecimento.

iii

Ttulo do projecto

Resumo
O resumo do relatrio (s deve ser escrito aps o texto principal do relatrio estar completo) uma representao abreviada e precisa, sem acrescento de interpretao ou crtica, escrita de forma impessoal, podendo ter, por exemplo, as seguintes trs componentes: 1. um pargrafo inicial de introduo do contexto geral do trabalho. 2. resumo dos aspectos mais importantes do trabalho descrito no presente relatrio, que por sua vez documenta o trabalho mais importante realizado durante a prova. Deve mencionar tudo aquilo que foi feito, por isso deve concentrar-se no que realmente importante e que deve ajudar o leitor a decidir se deve ou no consultar o restante relatrio. 3. um pargrafo final com as concluses do trabalho realizado.

Ttulo do projecto

ndice
Agradecimentos.............................................................................................................iii Resumo............................................................................................................................iv ndice................................................................................................................................v 1 Introduo.....................................................................................................................1 2 Contexto.........................................................................................................................3 3 Descrio tcnica..........................................................................................................4 4 Concluses.....................................................................................................................5 Bibliografia......................................................................................................................6 Anexo 1 Contedo em anexos.........................................................................................7 Anexo 1 Contedo em anexos.........................................................................................7 Anexo 2 Regras de Contedo e Estrutura.....................................................................8 Anexo 2 Regras de Contedo e Estrutura.....................................................................8 Anexo 3 Projectos de desenvolvimento........................................................................12 Anexo 3 Projectos de desenvolvimento........................................................................12

Ttulo projecto

1 Introduo
Nota: Este guia de elaborao de relatrio apenas um guia e como tal no substitui o dilogo entre o aluno e o orientador para definio da estrutura e contedo do relatrio para cada caso concreto.

1.1 Enquadramento
O relatrio final da Prova de Aptido Profissional um documento que descreve todas as actividades desenvolvidas pelo aluno no decorrer da sua realizao. Na elaborao do relatrio o aluno deve ter presente que est a produzir um documento pblico e que, de certa forma, resume todo o seu processo de aprendizagem ao longo do curso. Espera-se que o relatrio, mais do que uma mera descrio de actividades, contenha tambm uma anlise autocrtica aos conhecimentos adquiridos e ao trabalho desenvolvido. A introduo d ao leitor a informao bsica necessria de forma a facilitar o enquadramento dos objectivos e dos resultados. A Introduo deve comear por dar uma perspectiva geral do problema em estudo, (na seco de enquadramento) e medida que vai progredindo, deve ir fornecendo informao mais especfica, at se abordar a rea em concreto tratada no relatrio. Deve descrever, de forma sucinta, o problema em estudo e enunciar os principais mtodos que so utilizados no relatrio, bem como a identificao clara dos aspectos inovadores do trabalho. A introduo deve terminar com a apresentao sucinta das seces que fazem parte do relatrio.

1.2 Apresentao do projecto/estgio

Deve descrever, de forma sucinta, o problema em estudo e enunciar os principais mtodos que so utilizados no relatrio. Esta seco deve apresentar resumidamente o trabalho de projecto/estgio citando os objectivos definidos. Os objectivos do trabalho devem ser enunciados de uma forma sucinta e clara. Esta seco dever esclarecer claramente qual a motivao para a realizao do trabalho. 1.2.1 Planeamento de projecto Nesta subseco deve ser apresentado o cronograma definido para a execuo do projecto com indicao das tarefas, datas e milestones.

autor

Ttulo projecto

1.3 Tecnologias utilizadas

Esta seco opcional apresenta uma breve descrio das tecnologias utilizadas no trabalho. Caso a escolha das tecnologias tambm tenha sido parte integrante do trabalho desenvolvido, esta informao dever surgir na parte relativa ao contexto do trabalho e ser bem fundamentada.

1.4 Apresentao da Organizao

Seco opcional, caso se trate de trabalho desenvolvido na organizao, descrevendo sucintamente a organizao e a sua rea de interveno.

1.5 Contributos deste trabalho

Apresentar os aspectos inovadores e de realce do trabalho, bem como identificao dos benefcios trazidos para a instituio.

1.6 Organizao do relatrio

Apresentao sucinta dos captulos que fazem parte do relatrio descrevendo em poucos pargrafos o que cada um deles ir tratar.

autor

Ttulo projecto

2 Contexto
Esta seco destina-se a efectuar uma apresentao do problema, enquadrando-o num contexto mais global, e descreve todos os aspectos relacionados com o trabalho, nomeadamente a rea de negcio, o historial da organizao (se fizer sentido), bem como as diversas tecnologias utilizadas no desenvolvimento do projecto. Deve tambm apresentar quais so os pressupostos, o que se espera obter e quais so os vrios subproblemas em que se pode desdobrar. Caso as tecnologias tenham sido escolhidas no mbito do trabalho, deve ser apresentada uma justificao para essa deciso. De um ponto de vista tcnico devem evitar-se comparaes entre

tecnologias/metodologias a menos que: 1. Tal estudo faa parte dos objectivos de trabalho 2. Tenham encontrado limitaes na tecnologia que a organizao decidiu utilizar e que poderiam ser resolvidas usando outra tecnologia No segundo caso, a comparao dever aparecer aps apresentarem o trabalho e as dificuldades encontradas, podendo inclusive ser apresentada como melhoria futura ou como anlise crtica ao trabalho desenvolvido.

autor

Ttulo projecto

3 Descrio tcnica
Este o captulo (ou captulos) mais importante do relatrio, pois descreve o que realmente foi feito durante a Prova de Aptido Profissional. Existem duas possibilidades de estrutura: orientada para o projecto que deve ser utilizada na elaborao de relatrios de projecto ou estgio em que h um produto bem definido a apresentar. Exemplo clssico da realizao de um mdulo ou de uma nova aplicao; orientada a tarefas que deve ser usado na elaborao de relatrios de estgio em que no existe propriamente um produto a apresentar mas sim uma srie de tarefas que foram realizadas em um ou vrios produtos j existentes na organizao. Exemplo de estgio profissional onde foi feita uma interveno nos vrios servios de infra-estrutura ou mdulos de uma aplicao para suportar uma nova tecnologia. Os contratempos que surgiram (por exemplo, o servidor avariou e durante 3 dias no foi possvel trabalhar) devem ser referidos de forma explcita. Ao elaborar o relatrio devem ter em ateno que o relatrio funcionar como documentao da prova. Dessa forma devem-se perguntar se o relatrio descreve de forma suficientemente detalhada o trabalho realizado para que este possa ser compreendido e reproduzido se necessrio no futuro.

Nota:

no 3 apresentada uma proposta de estrutura para esta parte do relatrio para o caso de projectos/estgios de desenvolvimento.

autor

Ttulo projecto

4 Concluses
O captulo de concluses um dos mais importantes do relatrio, sendo aqui que devem ser apresentados os resultados do trabalho elaborado. As concluses finais devem focar o sucesso/insucesso do trabalho, revendo as dificuldades encontradas. Devem resumir, de alguma forma, as vantagens do produto desenvolvido e a utilidade que possa para os seus utilizadores. Podem tambm referir a forma como a realizao da prova decorreu, bem como as facilidades e as dificuldades sentidas ao longo do estgio. As concluses devem basear-se nos resultados realmente obtidos. Devem enquadrar-se os resultados obtidos com os objectivos enunciados e procurar extrair concluses mais gerais, eventualmente sugeridas pelos resultados. Podem acompanhar as concluses incluindo recomendaes apropriadas, resultantes do trabalho, nomeadamente sugerindo e justificando eventuais extenses e modificaes futuras. Este captulo deve fornecer uma opinio pessoal sobre o trabalho desenvolvido.

autor

Ttulo projecto

Bibliografia
O captulo de bibliografia apresenta a lista de bibliografia consultada para a execuo da Prova de Aptido Profissional. A lista de bibliografia deve estar ordenado por autor (ltimo nome) e em seguida por ano. No texto, sempre que utilizem dados ou afirmaes de outros, devem indicar a fonte desses mesmos dados ou afirmao, colocando entre parntesis curvos o nome da referncia, ex. (Sousa, 2002). A formatao de cada entrada bibliogrfica diferente consoante o tipo de documento em questo: para um livro: nome(s) do(s) autor(es), ano da edio entre parntesis, ttulo do livro em itlico, nome da editora, local da edio, pas da edio; para um relatrio interno: nome(s) do(s) autor(es), ano do relatrio entre parntesis, ttulo do relatrio, origem do relatrio, referncia do relatrio, instituio de acesso ao relatrio, local da instituio, pas da instituio, ms do relatrio (abreviado com 3 letras, excepo aos meses com 4 letras); para um documento extrado da Internet: adicionar o endereo entre parnteses e a data em que este foi consultado; para um portal da Internet: o endereo e a data em que este foi consultado.

autor

Ttulo do projecto

Anexo 1

Contedo em anexos

Esta parte do relatrio deve conter informao adicional organizada por captulos, que embora seja interessante, no faz parte do estritamente necessrio ao relatrio. Documentos importantes produzidos ou utilizados durante o realizao da prova que, pela sua dimenso, no sejam colocveis no corpo principal do relatrio podem tambm ser includos em anexos. Um exemplo possvel um captulo com o dirio de trabalho. Outro exemplo um captulo com experincias mais detalhadas e complexas realizadas. Eventualmente, nos anexos poder tambm aparecer o manual de utilizador da aplicao ou mdulo desenvolvido.

autor

Ttulo do projecto

Anexo 2

Regras de Contedo e Estrutura

Dependendo de cada projecto especfico, a proposta de estrutura apresentada neste documento pode ser alterada, acrescentando novos captulos, subdividindo captulos em dois ou juntando dois captulos num s. O aluno deve discutir com o orientador qual a melhor abordagem para o seu caso, seguindo as linhas orientadoras aqui apresentadas. A dimenso dos captulos deve ser equilibrada de forma a no haver muita diferena no nmero de pginas entre captulos. Excepo feita, obviamente aos captulos de introduo e concluses. Cada um destes dois captulos deve ter uma dimenso volta de 10% do total de pginas do relatrio. A estrutura dos captulos deve ser tal que contenha seces e subseces de forma equilibrada, cada uma contendo partes relativamente separadas do trabalho. A primeira seco deve comear no princpio do captulo. No criar apenas uma seco (subseco) dentro de um captulo (seco). Deve-se tambm evitar criar subseces com demasiados nveis, devendo-se usar apenas, regra geral, at ao 3 nvel, ex., 1.1.1. A numerao de captulo/seco efectuada em sequncia. Cada novo captulo deve iniciar-se no topo de pgina. A numerao de pginas dos anexos feita continuando a numerao do texto principal. Para separar os captulos no caso de estar a usar MS Word pode inserir seces de quebra do documento escolhendo a opo Insert
Break Odd Page.

2.1 Linguagem
A linguagem de um relatrio deve ser rigorosa, clara e com caracter tcnico. Deve evitar-se escrever as frases na primeira pessoa; por exemplo a frase desenvolvi em seguida o mdulo de facturao pode ser rescrita da seguinte forma: foi desenvolvido em seguida o mdulo de facturao ou em seguida desenvolveu-se o mdulo de facturao.

autor

Ttulo projecto

Tambm se deve evitar o uso de expresses populares e de opinies pessoais. Excepcionalmente, podero ser dadas opinies pessoais nas concluses, tendo sempre em ateno a polidez e a boa educao. As siglas devem ser sempre definidas da primeira vez que so usadas no texto. essencial no esquecer de rever ortograficamente o texto. Os processadores de texto tm normalmente facilidades de correco ortogrfica, mas no so suficientes, pelo que devem sempre rever pessoalmente o texto.

2.2 Formatao
Devem seguir-se algumas regras: diminuir o nmero de fontes utilizado (duas ou trs no mximo); usar um tipo de fonte e tamanho de fcil leitura (por exemplo, Times New Roman 12pts); ser consistente na utilizao das fontes (usar sempre a mesma fonte para o texto, usar sempre a mesma fonte para os headings); utilizar tamanhos de fonte razoveis e lgicos (por exemplo, se o tamanho da fonte modificar de acordo com o nvel de heading no usar um tamanho de fonte maior para um heading de nvel inferior); evitar floreados nas fontes (sombras, borders, etc.); usar judiciosamente o negrito e o itlico nos pargrafos de texto, devendo a sua utilizao ficar restrito a pequenos pedaos de texto que realmente importam realar; usar espaamento um e meio entre as linhas facilitam a leitura (no se deve no entanto usar esta tcnica para aumentar o nmero de pginas!); usar pargrafos justificados esquerda e direita; usar numerao correcta e lgica de pginas, de captulos e sub-captulos.

Devem utilizar as funcionalidades do vosso processador de texto para a definio de estilos por forma a facilitar e garantir um aspecto homogneo no relatrio. Caso

autor

Ttulo projecto

utilizem o Microsoft Word utilizem a opo de menu Format Styles and

Formating.

necessrio ter em ateno as margens das pginas e deixar espao suficiente para a encadernao (evitar margens laterais inferiores a 2 cm). A impresso do relatrio deve sempre que possvel ser efectuada numa impressora laser de boa qualidade usando a frente e o verso das folhas. Ter em ateno que, caso se opte por impresso frente-everso, se deve ter o cuidado de iniciar os captulos numa pgina impar. Adicionalmente neste caso, pode-se definir um header e um footer diferente para as pginas pares e mpares.

2.3 Imagens e tabelas

As imagens s devem ser colocadas no texto quando auxiliem a interpretao do assunto que se est a abordar. Na preparao das imagens deve haver cuidado para evitar m legibilidade prestando ateno ao nmero de elementos existentes na imagem, ao tamanho dos elementos e ao tamanho do texto. Adicionalmente, deve evitar-se demasiadas cores e floreados nos diagramas tcnicos a apresentar. No caso de diagramas relacionados com informtica a norma a utilizar deve ser o UML. Cada imagem deve ser apresentada com um ttulo curto que a identifique claramente, colocado por baixo da imagem. A figura seguinte mostra dois diagramas que traduzem o mesmo contedo no entanto so bem diferentes em termos visuais e de facilidade de leitura.

input

output

input

output

proces samento

processamento

Figura 1 - Exemplo de imagens a) difcil leitura; b) fcil leitura As tabelas devem ser usadas para apresentar dados/informao que se queira cruzar em vrias dimenses ou que se queira analisar segundo vrios atributos. Cada tabela deve
autor 10

Ttulo projecto

ser apresentada com um ttulo curto que a identifique claramente, colocado por cima da tabela. A formatao de tabelas deve obedecer s mesma regras apresentadas anteriormente de evitar demasiados floreados e devem garantir que a tabela no fica dividia entre duas pginas. Adicionalmente tem que se ter cuidado para facilitar a leitura e identificar correctamente a linha e/ou coluna de cabealho. A tabela seguinte um exemplo possvel de utilizao e formatao de tabelas. Tabela 1 - Exemplo de tabela Modelo Pentium III 800 Mhz Pentium IV 2.7 GHz Factor Preo Muito barato Caro Factor Desempenho J no aceitvel Um dos melhores no mercado

As figuras e tabelas devem sempre ter um ttulo e um nmero. Verifiquem as funcionalidades do vosso processador de texto para criao automtica de ttulo de figuras e tabelas pois facilita a sua numerao e posterior criao de ndices. Caso utilizem o Microsoft Word, procurem no menu Insert Reference
Caption.

Os ndices de tabelas e de figuras podem ser gerados automaticamente pelo MS Word, usando a opo de menu Insert Reference Indexes and Tables. Quando imprimir o relatrio, deve sempre actualizar as tabelas de ndices existentes. No caso de usar o MS Word, defina nas opes Tools Options Print
update fields. Alternativamente, pode efectuar a actualizao manual, clicando na

tabela em questo com o boto do lado direito do rato e escolhendo a opo Update
Field.

autor

11

Ttulo do projecto

Anexo 3

Projectos de desenvolvimento

Este anexo apresenta uma proposta de estrutura para a descrio tcnica de relatrios de projecto/estgio que consistam no desenvolvimento de solues. O aluno deve, conjuntamente com o orientador, definir a estrutura mais adequada ao seu projecto.

3.1 Anlise
Neste captulo apresentado um modelo conceptual do problema a resolver. aqui que normalmente se apresentam os modelos de dados, diagramas de estruturas (mdulos e/ou classes), etc., correspondentes ao problema e soluo proposta. Na anlise de um problema e desenvolvimento da respectiva soluo, costume seguirse os seguintes passos: 1. requisitos/funcionalidades identificar as funcionalidades de alto nvel (as grandes funes) pretendidas no sistema para cada perfil de utilizador, recorrendo a diagramas de casos de utilizao. 2. processos analisar e efectuar uma descrio de alto nvel dos processos existentes no sistema e das interaces entre os diferentes intervenientes nesses processos (workflow). 3. estrutura lgica identificar e descrever detalhadamente as diferentes entidades existentes bem como detalhar os diagramas de interaco anteriores por forma a incluir as classes de implementao identificadas e respectivas operaes. 4. estrutura fsica identificar os diferentes elementos fsicos do sistema (ex., bibliotecas de funes, executveis) recorrendo-se de diagramas de componentes, bem como identificar os recursos de hardware necessrios instalao do sistema usando para tal diagramas de instalao.

autor

12

Ttulo projecto

3.2 Desenvolvimento
Este captulo descreve a implementao da soluo proposta no captulo anterior. Alguns dos diagramas referidos na seco anterior podem aparecer neste captulo e no no captulo de anlise; o caso dos diagramas de classes ou diagramas de mdulos. Neste captulo so detalhadas as operaes de cada classe ou as funes de cada mdulo (usando pseudocdigo ou diagramas de actividades). Neste captulo so tambm descritas as especificidades de implementao de acordo com o ambiente de desenvolvimento, plataforma e linguagem escolhida para o desenvolvimento. Devem tambm ser reportados os problemas encontrados e a soluo escolhida para os resolver. Os contratempos do estgio (por exemplo, o servidor avariou e durante 3 dias no foi possvel trabalhar) tambm podem ser referidos.

3.3 Instalao/Experincias
Este captulo descreve a instalao da soluo (no confundir com setup). O que se entende por instalao a arquitectura fsica concreta onde a soluo foi instalada e os componentes necessrios. So tambm aqui descritos os testes efectuados, apresentados os dados/modelos utilizados bem como os resultados obtidos. Caso tenha havido lugar a melhorias, devido ao resultado dos testes ser insuficiente ou errado, tal tambm deve ser indicado. Este captulo pode no existir em todos os projectos/estgios, dependendo da sua natureza. Em alguns casos tambm aceitvel que se transforme numa seco do captulo anterior.

autor

13