- 1. Qual é o objetivo de um Relatório Técnico?
- 2. Como um Relatório de Estágio deve estar organizado?
- 3. Como posso escrever a "Introdução" de um Relatório Técnico?
- 4. Como posso escrever o "Referencial Teórico" de um Relatório Técnico?
- 5. Como posso escrever o capítulo "Solução Proposta"?
- 6. Como posso escrever o capítulo "Avaliação do Software"?
- 7. Como posso escrever o capítulo "Considerações finais"?
O relatório técnico se enquadra na definição de "Projeto orientado em sistemas de informação". No PPC (Projeto Pedagógico de Curso) dos cursos Bacharelado em Ciência da Computação 1 e Bacharelado em Sistemas de Informação 2 é dito que pode ser um "desenvolvimento técnico", isso é, um produto de software desenvolvido no qual você esteve presente ou realizou sozinho.
O objetivo é demonstrar que o discente teve uma carga prática de trabalho que lhe tenha exigido estudo do problema, análise para proposta de solução, além de conhecimentos técnicos e habilidades inerentes a programação, ferramentas e metodologias relacionadas.
Em geral, um relatório técnico é composto pelos seguintes capítulos: Introdução, Referencial Teórico, Solução Proposta, Avaliação da solução (opcional, mas desejável) e Considerações Finais.
A introdução deve conter um breve resumo sobre o problema, as alternativas existentes para resolve-lo (se houver), a motivação para a execução do projeto e como a solução proposta conseguiu atender às necessidades (objetivos do projeto), sem entrar em detalhes de implementação. Neste capítulo cabe realizar algumas citações tanto para problematização quanto para estudos e alternativas já desenvolvidas, mas que não atenderam às necessidades do projeto.
Não é comum, neste capítulo, utilizar figuras, tabelas, quadros, entre outros. Deixe isso para os capítulos à frente, principalmente o capítulo Referencial Teórico.
A fundamentação teórica de um relatório técnico deve conter, dentre outras coisas, uma descrição dos conceitos, ferramentas, técnicas, tecnologias, entre outras coisas utilizadas para resolução do problema. No geral, esse capítulo será uma descrição das tecnologias utilizadas. As justificativas e outras explicações vão se localizar no capítulo de Solução Proposta, mais especificamente na seção Ferramentas e Tecnologias Utilizadas. Uma possível subdivisão deste capítulo em seções pode ser:
2 Referencial Teórico
2.1 Tecnologias Utilizadas
2.1.1 HTML, CSS e JavaScript
2.1.2 MongoDb
No caso de ferramentas e linguagens, além das informações básicas (o que é, para que serve, etc), é interessante apresentar um exemplo simples de utilização dessa ferramenta/linguagem. Para mais detalhes sobre isso, por favor, leia a seção Comente suas figuras, tabelas e trechos de código na página inicial deste Guia.
Neste capítulo você deve discorrer sobre a solução que foi desenvolvida para atingir os objetivos do projeto e resolver o problema descrito anteriomente. Como esta seção relata o "desenvolvimento" do trabalho, apesar de não precisar conter os fatos em toda a sua abrengência, ela exige um pouco mais de detalhes. Dessa forma, é plausível dividir este capítulo em seções, tais como Requisitos da solução, Ferramentas e tecnologias utilizadas, Funcionalidades.
5.1 Como posso escrever as seções de "Requisitos da solução", "Ferramentas e tecnologias utilizadas", "Funcionalidades"?
Na seção Requisitos da solução devem ser descritos os requisitos funcionais e não funcionais da solução proposta, assim como as limitações impostas ao desenvolvimento da mesma. Na sequência, a seção Ferramentas e tecnologias utilizadas compreende a listagem, com justificativas, das ferramentas e tecnologias utilizadas para desenvolver a solução. Por fim, a seção Funcionalidades deve apresentar o que foi desenvolvido e como isso atendeu aos requisitos do projeto.
Neste capitúlo, cabe a descrição de como a solução foi avaliada pelos usuários e/ou outras partes interessadas, como isso atendeu aos objetivos do projeto, os pontos de melhoria identificados e o feedback geral das partes. Este capítulo não é obrigatório para a aceitação do trabalho, contudo, é desejável e pode contribuir para o reconhecimento da efetividade da solução proposta.
Por fim, você deve retomar o objetivo do trabalho, destacando as principais contribuições feitas e lições aprendidas durante o decorrer do projeto.