This document provides guidelines for writing IT reports at VIA, outlining the key sections that should be included. The recommended sections are: title page, table of contents, abstract, introduction, main sections, results, discussion, and conclusion. The introduction should provide background and objectives. The main sections should describe the methods and execution of the project. The results section presents findings without interpretation. Discussion interprets the results and relates them back to objectives. The conclusion recaps the problem and contributions of the results. References and appendices are also included.
Copyright:
Attribution Non-Commercial (BY-NC)
Available Formats
Download as DOC, PDF, TXT or read online from Scribd
This document provides guidelines for writing IT reports at VIA, outlining the key sections that should be included. The recommended sections are: title page, table of contents, abstract, introduction, main sections, results, discussion, and conclusion. The introduction should provide background and objectives. The main sections should describe the methods and execution of the project. The results section presents findings without interpretation. Discussion interprets the results and relates them back to objectives. The conclusion recaps the problem and contributions of the results. References and appendices are also included.
This document provides guidelines for writing IT reports at VIA, outlining the key sections that should be included. The recommended sections are: title page, table of contents, abstract, introduction, main sections, results, discussion, and conclusion. The introduction should provide background and objectives. The main sections should describe the methods and execution of the project. The results section presents findings without interpretation. Discussion interprets the results and relates them back to objectives. The conclusion recaps the problem and contributions of the results. References and appendices are also included.
Copyright:
Attribution Non-Commercial (BY-NC)
Available Formats
Download as DOC, PDF, TXT or read online from Scribd
This document provides guidelines for writing IT reports at VIA, outlining the key sections that should be included. The recommended sections are: title page, table of contents, abstract, introduction, main sections, results, discussion, and conclusion. The introduction should provide background and objectives. The main sections should describe the methods and execution of the project. The results section presents findings without interpretation. Discussion interprets the results and relates them back to objectives. The conclusion recaps the problem and contributions of the results. References and appendices are also included.
Copyright:
Attribution Non-Commercial (BY-NC)
Available Formats
Download as DOC, PDF, TXT or read online from Scribd
Download as doc, pdf, or txt
You are on page 1/ 5
A Guide to Writing IT-Reports at VIA
Date: 25 March, 2010 John Author, student number ###### Jane Author, student number ###### Supervisor: Bill Gates
Table of Contents 1. First pages........................................................................................................................................3 2. Abstract............................................................................................................................................3 3. Introduction......................................................................................................................................3 4. Main sections...................................................................................................................................3 5. Results..............................................................................................................................................4 6. Discussion........................................................................................................................................5 7. Conclusion.......................................................................................................................................5 9. Appendices.......................................................................................................................................5
1. First pages The first pages include the Title page, Table of contents, and List of figures and tables. See the document: IT-Report_template. 2. Abstract An abstract is a shortened version of the paper and should contain all information necessary for the reader to determine: (1) (2) (3) (4)
what the objectives of the study were how the study was done what results were obtained and the significance of the results.
Frequently, readers of a report will only read the abstract, choosing to read at length those reports that are most interesting to them. For this reason, and because abstracts are frequently made available to engineers by various computer abstracting services, this section should be written carefully and succinctly to have the greatest impact in as few words as possible. Although it appears as the first section in a paper, most report writers write the abstract section last. 3. Introduction Why is this project of interest and what is your objective? The introduction is a short extract of the project description, including the central questions of the problem formulation. It could include background information, and the final project in particular, could discuss the results and conclusions of previously published materials, to help explain why the current project is of interest. Limit the introduction to studies that relate directly to the present project. Emphasize your specific contributions to the topic. The last sentences of the introduction could be an overview of the sections to follow. This could be a good transition to the next sections, in which you will explain how you proceeded to meet your objective. The project description in its totality is attached as an appendix. 4. Main sections How was the project done? What materials and methods were used?
This section is a description of the projects experimental execution where you present the key issues of the project. It is thorough without being too descriptive or wordy. It includes detailed information but not things that typical IT-engineers would find unnecessary. This section provides all the methodological details necessary for another IT-engineer to duplicate your work. It should be a narrative of the steps you took in the study and execution of the project. You should assume that the other IT-engineers have the same basic skills that you have, but does not know the specific details of your project. An important part of writing a technical report is deciding what bits of information needs to be given in detail. Supporting information related to the project can be included in the appendix; but remember, the reader should be able to read and understand the report without conferring the appendices. 5. Results What did the study find? This section presents the results of the project but does not attempt to interpret their meaning.
6. Discussion What might it mean, why does it matter, what next? In this section, you are free to explain what the results of your project mean. Relate your discussion back to the objectives and questions you raised in the Introduction section. However, do not simply re-state the objectives. Make statements that synthesize all the evidence. Do not make statements that are too broad. In your final project at 7th semester, you can suggest future directions for your project work. If necessary, note problems with the methods and explain anomalies. Do not simply list the problems but provide thoughtful discussion about the implications of the errors. 7. Conclusion The conclusion recapitulates the problem and the contributions. It assesses the significance of the results and relates the results to the questions posed in the problem formulation. New topics are not introduced in the conclusion. 8. References The report includes a complete alphabetical listing of all the published work you cited in the text of the report. This does not mean every article you found during your project work; only include the works you actually cited in the text of your report. 9. Appendices Normally the appendices are put on a CD-ROM, but some smaller appendices can be useful to put in the report, e.g. an alphabetical listing of all the abbreviations use in the report.
