Adão Posted June 19, 2012 at 07:02 AM Report #463913 Posted June 19, 2012 at 07:02 AM Alguém sabe qual é a estrutura normal de um relatório técnico? Alguém tem exemplos?
Rui Carlos Posted June 19, 2012 at 09:12 PM Report #464236 Posted June 19, 2012 at 09:12 PM Tudo depende do que é que vais escrever... O básico será algo como: Resumo/Abstract Introdução Conteúdo Conclusão Referências Por Conteúdo refiro-me às várias secções onde vais colocar o material propriamente dito que tens para publicar. Por vezes, também pode fazer sentido colocar uma secção para Trabalho Futuro junto à Conclusão. E também pode fazer sentido ter anexos, por exemplo, para colocares código, ou exemplos. Rui Carlos Gonçalves
Adão Posted June 20, 2012 at 09:27 AM Author Report #464314 Posted June 20, 2012 at 09:27 AM Relativamente ao código, o que é que fará sentido transcrever para o relatório técnico? Não acho que haja necessidade de colocar tudo, mas também não sei o que hei-de escrever. Falar sobre a existência de variáveis globais, procedimentos globais? Reutilização de código nas várias partes do programa através de módulos? Eu nunca vi nenhum relatório técnico, não sei examente o que costumam conter, por isso não sei como fazê-lo...
Rui Carlos Posted June 20, 2012 at 03:29 PM Report #464397 Posted June 20, 2012 at 03:29 PM O relatório técnico é sobre o quê? Já agora, isto tem alguma coisa a ver com VB.net? Parece-me uma dúvida relativamente genérica. Rui Carlos Gonçalves
Adão Posted June 20, 2012 at 03:46 PM Author Report #464403 Posted June 20, 2012 at 03:46 PM (edited) Talvez mas o programa que eu estou a fazer usa vb.net, por isso é que meti o tópico neste quadro. É sobre um programa de gestão de uma sapataria, é um projeto académico. Edited June 20, 2012 at 03:46 PM by Adão
Rui Carlos Posted June 20, 2012 at 04:18 PM Report #464413 Posted June 20, 2012 at 04:18 PM Deves começar por descrever o problema que tinhas para resolver. E depois deves descrever a solução que desenvolveste (quais os módulos que constituem a solução, como é que se agrupam, como é que se interligam, etc.). Depois acho que também deves dar alguma atenção para opções que tiveste que tomar (porque é que escolheste uma determinada estrutura de dados ou algoritmo, por exemplo, e quais as vantagens e desvantagens relativamente a outras soluções). Na conclusão deves resumir o trabalho feito, e também falar um pouco do que é que farias de modo diferente caso tivesse que resolver o mesmo problema de novo (de certa forma, que lições aprendeste com o trabalho). À partida, uma secção com trabalho futuro (coisa a melhorar), também deverá estar presente. Quanto ao código a mostrar, não sei a dimensão do projecto. Podes focar as partes que sejam úteis para compreender os que descrever no relatório (e.g., principais estruturas de dados e algoritmos). Rui Carlos Gonçalves
Adão Posted June 20, 2012 at 05:08 PM Author Report #464433 Posted June 20, 2012 at 05:08 PM A acompanhar este projeto, seguirá também um relatório completo com esses tópicos (descrição ou resumo, conclusão, trabalho futuro, entre outros). Agora estou a aperceber-me de um erro que cometi no início deste tópico, talzes lhe devesse chamar manual técnico e não relatório. Este programa é um projeto final do curso que estou quase a concluir e a ideia é, para o meu caso que estou a fazer um programa, apresentá-lo ao júri como se quisesse venvê-lo; por isso o manual técnico é um documento que acompanha o programa ao comprador para que, se este quiser, possa alterar-lhe o código. Pelo que entendi do que o meu stor disse, a ideia é que quem for ler o manual fique a perceber qual é a estrutura do código.
Rui Carlos Posted June 20, 2012 at 05:14 PM Report #464436 Posted June 20, 2012 at 05:14 PM Nesse caso convém documentar bem o código, e gerar alguma coisa do género do Javadoc. A utilização de diagramas UML também pode dar jeito. Rui Carlos Gonçalves
Adão Posted June 20, 2012 at 09:00 PM Author Report #464473 Posted June 20, 2012 at 09:00 PM O que é o Javadoc? E os diagramas UML?
Rui Carlos Posted June 21, 2012 at 12:53 AM Report #464506 Posted June 21, 2012 at 12:53 AM http://pt.wikipedia.org/wiki/Javadoc http://en.wikipedia.org/wiki/Unified_Modeling_Language#Diagrams_overview Se não conheces UML, se calhar o melhor é deixar isso de fora. Quanto ao Javadoc, a ideia é gerar páginas HTML a descrever os elementos da tua aplicação (ou seja, documentação das funções e estruturas de dados). Não sei exactamente qual é a tecnologia normalmente usada para gerar documentação com vb.net. Rui Carlos Gonçalves
Adão Posted June 21, 2012 at 07:08 AM Author Report #464516 Posted June 21, 2012 at 07:08 AM (edited) Pois, nem eu... estou a acabar o curso mas ainda me considero um pouco principiado em vb.net Edited June 22, 2012 at 11:50 AM by Adão
Rui Carlos Posted June 21, 2012 at 02:39 PM Report #464596 Posted June 21, 2012 at 02:39 PM Vê se isto ajuda: http://msdn.microsoft.com/en-us/magazine/dd722812.aspx Rui Carlos Gonçalves
KTachyon Posted June 21, 2012 at 03:22 PM Report #464620 Posted June 21, 2012 at 03:22 PM Se estiveres virado para coisas mais orientadas para o negócio com a especificação técnica do sistema e respectiva correspondência com os processos de negócio, aconselho a espreitares a Enterprise Architecture com frameworks como Zachman e TOGAF. “There are two ways of constructing a software design: One way is to make it so simple that there are obviously no deficiencies, and the other way is to make it so complicated that there are no obvious deficiencies. The first method is far more difficult.” -- Tony Hoare
Adão Posted June 22, 2012 at 11:50 AM Author Report #464932 Posted June 22, 2012 at 11:50 AM Obrigado, acho que já sei o que queria.
Recommended Posts
Create an account or sign in to comment
You need to be a member in order to leave a comment
Create an account
Sign up for a new account in our community. It's easy!
Register a new accountSign in
Already have an account? Sign in here.
Sign In Now