Tuesday, February 26, 2008

Report Template

During the last days we have planned on how to structure our report. We have therefore now created a template which we have based on another report template from IDC (Interaction Design Collegium).

The report will be divided into three main parts, namely:
  • …an introductory section
  • …a report section
  • …a closing section

The introductory section should contain the following:

  • FrontPage
    • Title
    • Author
    • University
    • Publish date
    • Report number etc.
  • Acknowledgements
  • Abstract
    • Important section since it is here the reader decides whether to continue reading the report.
    • Approximately a half page (max one page)
    • The summary must be informative and include:
      • The most important results
      • The conclusions drawn
      • Enlighten the purpose, the method and the problem definition
    • It shall not contain any fact that is not included in the report
    • Is to be written last, when the report is already finished.
  • Table of contents
    • This section shall include both references to page numbers as well as figures.
      • Table of contents
      • List of figures

The report section should contain the following:

1. Introduction
    • Introduce the reader to the subject at hand
    • Try to capture the reader’s interest
1.1 Purpose
    • Problem definition
      • What does the report include, in general
      • What results do we hope to achieve
      • The stated problem definition must be answered in the report
1.2 Delimitations
  • What delimitations have we made
  • How did we do them, on what basis
1.3 Targeted Readers
  • Who are the intended readers?
1.4 Report Overview
  • Provide reading instructions and describe how the report is structured

2. Background
    • Provide facts about the different parts that are involved in our project such as ADAS, situation awareness and ecological user interface etc.

3. Theoretical Framework
    • Discuss the area based on previously studies
    • Very important to provide references
    • Only include subjects that are relevant for our study

4. Method
    • This section shall describe our procedure throughout the project to explain our course of action
    • Another important factor here is to motivate our choice of methods

5. Result
    • Show and describe the results we've reached in our study
      • Must be objective, no personal opinions
    • Round up the “Results” section with a summary of the results

6. Method Critique
    • Discuss the methods and material used in the study
      • Could it have been performed differently to improve our methodological work?
      • How generalizable are your results?

7. Discussion
    • Discuss our results based on...
      • Our purpose and problem definition
      • Our references in our theoretical framework
    • If we are presenting suggestions of improvements it’s important that we have support for these ideas and suggestions based on previously made studies (from our theoretical framework)
    • If we are presenting our own thoughts without references etc. it is extremely important that we emerge that in some way

8. Conclusions
    • This section should be short, concise and informative
    • Try to connect the conclusions with the purpose and problem definition

9. Future Work
    • Provide examples of future work


The closing section should contain the following:

10. List of references
    • Important to list all sources in a standardized manner


  • Appendix

No comments: