Projeto Prossional Interdisciplinar

Faculdade Sumar e Prof. Cesar G. Miguel

Como elaborar um relatrio1 o

As recomendaoes a seguir no devem ser usadas como regra geral, mas sim como c a uma guia no desenvolvimento de um relatrio tcnico. Tenha em mente, no entanto, que o e se deve ter um bom motivo (isto , um bom argumento) para optar em no segu e a -las em detrimento de outra abordagem.

Apresentao ca
A apresentaao escrita de um trabalho importante. Hoje, o usurio ou cliente do seu c e a trabalho o professor. Amanh ser seu chefe ou um cliente para o qual voc estar e a a e a desenvolvendo um produto. Sua preocupaao com o portugus deve ser essencial, princic e palmente em relao a clareza do texto. Se coloque no lugar de algum que esteja lendo ca ` e seu trabalho por interesse no assunto. Essa pessoa deve ser capaz de entender o que seu projeto faz. A comunicaao escrita geralmente acaba sendo parte do processo seletivo c numa empresa de grande porte, onde a concorrncia maior. Portanto a importncia da e e a escrita no est ligada apenas a nota na disciplina, mas na sua carreira como um todo. a a ` D uma atenao especial a este tema e aproveite a oportunidade na graduaao2 . e c c

Relatrio o
O relatrio do projeto como um pequeno artigo que explica o que o programa faz, o e como faz, e apresenta concluses obtidas sobre o trabalho. O relatrio um documento o o e a parte e no deve ser escrito no programa fonte. Embora nenhuma formatao especial ` a ca seja exigida, recomendo que se aplique a mesma metodologia de PPI I, inclusive no uso de referncias bibliogrcas. O relatrio deve conter, em linhas gerais, uma introduao, e a o c desenvolvimento e concluso (contando o que foi aprendido durante o semestre com a a escrita do projeto). A seguir so apresentados alguns itens e sugestes de como preparar um relatrio (no a o o a espec co a PPI): 1. Descrio sucinta sobre o desenvolvimento do trabalho ca Uma explicao sobre as decises de implementao tomadas, uma viso geral do ca o ca a funcionamento do programa, comentrios sobre os testes executados, etc. a 2. Descrio do formato de entrada dos dados ca Uma descriao simples e clara dizendo quais so os dados de entrada e como o c a programa ir receb-los. Por exemplo: A entrada para o programa consiste de um a e conjunto de descrio dos edif ca cios. Em cada linha haver somente uma descrio. a ca Cada descriao composta por trs nmeros inteiros separados por um ou mais c e e u espaos em branco na seguinte ordem: coordenada esquerda do edif c cio, altura do edif cio, coordenada direita do edif cio.
1 2

Baseado no texto do Prof. Nivio Ziviani, DCC-UFMG: http://homepages.dcc.ufmg.br/~nivio Aquela histria de quem cursa cincias exatas para evitar ler/escrever est completamente errada. o e a

Projeto Prossional Interdisciplinar 3. Descrio do formato de sa dos dados ca da

Uma descriao simples e clara dizendo como o programa apresentar os resultac a dos ao usurio. Por exemplo: O programa ir gerar uma sequncia de nmeros a a e u representado a linha do horizonte. Nmeros que estiverem nas posioes u c mpares representam coordenadas e nmeros que estiverem nas posies pares, alturas. u co 4. Explicao sobre como utilizar o programa ca Por exemplo: Para executar o programa da linha do horizonte, digite na linha de comando: lh.exe arqIn arqOut arqErro, onde arqIn o arquivo que contm e e os dados de entrada, ... 5. Descrio dos TADs e as estruturas de dados utilizadas ca No caso de PPI III, necessrio a explicaao sobre os TADs denidos, as operaoes e a c c dispon veis e como os TADs so implementados. Voc pode fazer essa descrio a e ca utilizando desenhos ou escrevendo. 6. Descrio dos mdulos e sua inter-dependncia ca o e Ainda para o caso de PPI III, necessrio uma breve descriao de cada mdulo e a c o bem como um diagrama, por exemplo, mostrando a relaao de dependncia entre c e eles. Note que esta parte certamente estar relacionada com os TADs. a

Cdigo fonte (implementao do projeto) o ca

Procure observar os seguintes aspectos no seu cdigo fonte: o 1. Modularidade No faa programas de um mdulo s (isto , usando apenas a funo main()). a c o o e ca Divida as tarefas a serem executadas em mdulos, sempre organizando o cdigo. o o 2. Comentrios a Escreva os comentrios no momento que estiver escrevendo o algoritmo. Um proa grama mal documentado um dos piores erros que um programador pode cometer, e o sinal de um amador (mesmo com 10 anos de experincia). O melhor momento e e para se escrever os comentrios aquele em que o programador tem maior intimia e dade com o algoritmo, ou seja, durante a sua confeco. Os comentrios devem ca a acrescentar alguma coisa de util, no apenas frasear o cdigo. a o 3. O cdigo nos diz como um certo problema est sendo resolvido. o a Os comentrios devero dizer o que est sendo feito em cada passo. E muito ima a a portante a colocaao de comentrios no prembulo de um programa ou de cada c a a mdulo, para explicar o que ele faz e fornecer instruoes para seu uso. Poderiam o c ser colocados comentrios dos seguintes tipos: a O que faz o programa ou mdulo; o Como cham-lo ou utiliz-lo; a a

Projeto Prossional Interdisciplinar

Signicado dos parmetros, variveis de entrada, de sa e variveis mais a a da a importantes; Arquivos utilizados; Outros mdulos utilizados; o Funoes especiais utilizadas, com referncias nas quais possa se encontrar mais c e informaes; co Autor, data de escrita e ultima atualizao; ca 4. Identao ca Utilize identaao para mostrar a estrutura lgica do programa. A identaao no c o c a deve ser feita de forma catica. Crie algumas regras bsicas de identaao e procure o a c segu -las ao escrever um programa, sempre mantendo a consistncia. e 5. Passagem de parmetros a Procure ser consistente na ordem e no tipo de passagem de parmetros. Por exema plo, suponha que trs funes diferentes tm que acessar os dados de uma mesma e co e tabela. No faz sentido se uma das funes receber a tabela por valor, a outro por a co referncia e a ultima acessar a tabela como varivel global. e a 6. Variveis globais a Evite ao mximo a utilizao de variveis globais, por que elas compartilham dados a ca a entre as diversas partes do programa de uma maneira que no expl a e cita, o que pode levar a erros dif ceis de serem achados. 7. Nomes de variveis a Escolha nomes representativos. Os nomes de constantes, tipos, variveis, funa oes, etc. devem identicar o melhor poss c vel o que representam. Por exemplo, X = Y + Z muito menos claro que preco = custo + lucro. e 8. Utilize espacos em branco para melhorar a legibilidade Espaos em branco so valiosos para melhorar a aparncia de um programa. Por c a e exemplo: Deixar uma linha em branco entre as declaraes e o corpo do programa; co Deixar uma linha em branco antes e depois dos comentrios; a Separar grupos de comandos que executam funes lgicas distintas por uma co o ou mais linhas em branco; Utilizar brancos para indicar precedncia de operadores, ao invs de A+B * C e e e bem mais leg a forma A + B*C; vel Um comando por linha suciente. A utilizao de vrios comandos por linha e ca a e prejudicial por vrios motivos, dentre eles destacam-se o fato do programa tornar-se a mais ileg e car mais dif de ser depurado. Tambm d preferncia para o uso vel cil e e e de parnteses/chaves para aumentar a legibilidade e prevenir-se contra erros. e

Projeto Prossional Interdisciplinar 9. Testes

Procure fazer testes relevantes como, por exemplo, aqueles que vericam casos extremos e casos de exceoes. S atravs de uma grande bateria de testes voc poder c o e e a dizer o quo convel seu programa. a a e