Template Technical Reports Mi Un

7/30/2019 Template Technical Reports Mi Un

1/34

Mid Sweden UniversityDepartment of Informationtechnology and media (ITM)

Introductory instructionsPage 1 (6)

Template revision date: 2007-01-06

Instructions and template fortechnical reports and graduationwork

This document contains guidance and, additionally, a templatefor creating project reports and graduation work for use intechnical subjects within the Department of Information

Technology and Media at Mid Sweden University. Following thesix page introduction there is a report template, which outlinesour requirements for submitting diploma works and projectreports. Simply erase the introductory instructions, andreplace the text paragraphs in the template with your owntext.

The main aim of the template is to assist you as a student inwriting a well structured report and also to ensure that youwork methodically. The aim is not to burden you with detailedregulations. The template follows the graphical profile of MidSweden University, for example typeface, and gives examplesconcerning how to formulate reference lists, captions,mathematical equations, etc., according to establishedpractice. It is, however, not a requirement that you follow thetypographical design of the template but it is important thatthe typography used follows a consistent formula.

The report's aim

The report is the key to presenting the results of a technicalproject. In such a report, new knowledge and experiencesgained during the project's duration are shared with interestedparties. Project reports often function as a basis for decision-makers and will also provide essential information to thosecontinuing with a project. Many students present reports fromgraduation work in connection with employment interviews. Ifthe writing of a report occurs at the start of a project it canassist the author to structure information and to approach the

assignment in a systematic and analytical manner.


2/34



Template revision date: 2007-01-

The report presents the author's own key analysis and wellsupported conclusions, rather than documenting design- andprogramming work in detail, or to present backgroundinformation available in other documents.

The report's scope

A 10 point exam work report should normally contain between4 000 to 8 000 words of your own written text (whichcorresponds to approximately 20 to 40 sides when using thistemplate), and a 20-point report between 6 000 and 12 000words (approximately 30 to 60 sides), excluding appendices.

The report may also contain a number of illustrations.

The text may not contain irrelevant padding and should onlycontain factual contents that aim to answer the problem posedby the report, and to support and explain its results andultimate conclusions.

Materials that are recycled from the author's previous reportsmay not dominate the report. Results and conclusions must benew. To retrieve text from other sources without stating itssource reference is considered to be an act of plagiarism andtherefore cheating, which may be reported to the University'sdisciplinary board. Quotations should only be used inexceptional cases, and should be clearly indicated, i.e. withinquotes. In ordinary circumstances, it is usual to review thesources, i.e. summarise and restate the source using in onesown words.

Layout

If a report follows an established layout the reader can thenidentify and easily understand the report's structure and followit logically. A template can assist the author in presenting thework in a well structured manner, in accordance with officialguidelines. The template can also assist the author to workmethodically and analytically.

Scientific magazines require that research articles follow theIMRaD-format in order to be valid for publication. Similarrequirements are usually necessary for essays, graduatereports and dissertations within the academic world. Thismeans that the document must contain the following sectionsIntroduction, Method, Result and Discussion, usually in that

order, although this may vary within different scientifictraditions. The discussion (D) contains the author's own


3/34




analysis and conclusions. The author's conclusions should besupported by objective observations, which are to bepresented in the results section (R). The researchmethodology, assumptions, models and procedures that havebeen used in order to gain results are to be presented in themethod section (M), to enable the reader to interpret andcheck the results. Whatever is presented in the report shouldbe aimed at responding to the problem specified in theintroduction (I).

Many companies have their own systematic methods as to howtechnical development projects should be carried out and

documented. Software design traditionally often follows the socalled waterfall model, including Requirements specification,Design, Implementation and Testing. The companies may alsorequest that exam reports present Need analysis, Problemanalysis, Evaluation of alternative solution proposals,Recommended solution, Consequence-analysis, User-guidance,and Proposals for further development.

The following outline aims to reflect both the academic andindustrial culture:

Table 1: Swedish and English outline for scientific and technical reports.

English SwedishCard board front page (only

required for theses notproject courses)

Ev. Frtryckt kartongframsida (krvsvid examensarbeten ej pprojektkurser)

Title page TitelbladSammanfattning

Abstract AbstractAcknowledgements / Foreword Ev. FrordTable of Contents InnehllsfrteckningTerminology / Abbreviations /

NotationEv. Terminologi / Frkortningar /

Notation

1. Introduction 1. Inledning / Introduktion2. Theory / Related work 2. Teori / Bakgrundsmaterial3. Methodology / Model 3. Metod / Modell4. Design / Implementation 4. Ev. Konstruktion / Implementering5. Results 5. Resultat6. Conclusions / Discussion 6. Slutsats / DiskussionReferences KllfrteckningAppendices Ev. Bilagor

Choose the appropriate heading from those separated by / inthe table. For details about each section, see the template thatfollows these introductory instructions.


4/34




If the author can justify the use of an alternate outline, if forexample by request of the tutor, this is only acceptable afterconfirmation has been obtained from the examiner. It isimportant however that the author follows the philosophy ofthe above structure, in particular for both C and D level theses,as a survey according to a scientific systematic method isrequired in those cases.

Language

The text should be written so that it is readily understandableto another student with similar background. The report shouldbe typed using a word processor and the language should begrammatically correct. As a matter of course dictionariesshould be consulted and consideration given to the correctwriting protocols. If the text is contradiction free andconsistent in its use of terms, concepts, abbreviations, etc., therisk of misunderstandings is reduced. The author should proof-read the document and correct any language errors before thefinal version of the report is handed in. Allow a friend to offerfeedback on the texts' language and clarity.

MS Word-template automatic features

The remainder of this document constitutes a template for theword processor program Microsoft Word, for versions Office 97and later. The template utilises the possibilities offered by theprogram to auto-format, which can prove helpful when writinglong reports. Although there are a few exceptions, thetemplates' automatic features are also compatible with thefree open-source software OpenOffice.

State the main heading, sub-heading and authors name onthe front page (the title page) of the report. Replace the text

within the square brackets [], with your own information. Thenremove the brackets. The main- and subheadings plus theauthors name written on the title page are shownautomatically at the top of each page, and are updated inconnection with print-out and previews. This is similar to whathappens when (Ctrl-A) is selected and the F9 key pressed.Check that the page headings are correct after you havechanged the title page!

The date in the page header states when the document waslast saved.


5/34




Headings, source list, character texts, table texts and equationnumbers are numbered automatically. The last three arehowever not updated until they are used in conjunction with aprint-out, preview or if you select all and press the F9 key.

The table of contents and cross references (i.e. characterreferences and source references) are updated automatically.However this does not occur until a print-out or preview arerequested or until F9 has been pressed.

If anything referring to a cross reference is removed then thereference is replaced by an error message. Always check thatthe automatic links have not been replaced by error messagesbefore the report is sent out to tutors or examiners for review.

In the templates' chapter 2 examples are found concerningformulation of source references, quotations, characternumbering, tables, mathematical equations etc. It has beenplaced in this chapter because it is here that they are usuallyencountered for the first time and since the examples' useauto-format, certain sections would not have functioned if theyhad been placed in the introductory instructions.

The template's auto-format function requires the use of theparagraph styles Heading 1 or section 1 for chaptersections, Heading 2 or section 2 for subheadings, etc.Choose paragraph styles from the drop-down menu style.

The paragraph format Body text is used for the report's maintext. The format alters a rows' paragraph spacing, aligns theleft- and right margins and automatically splits up long wordsby means of hyphens.

At certain times, i.e. in tables and text blocks in illustrations,

straight margins, paragraph intervals, or automatic breaksmay not be required and in such cases the paragraph formatshould instead be set to normal.

The chapter section is displayed at the top right hand corner ofthe page. However, it is possible that this can cause an errormessage to occur when using the Swedish versions of Word ifthe paragraph format Stycke 1 is used instead of Heading1.

If the automatic break sets hyphens and line-breaks in the

wrong place it is possible to insert soft hyphens into any wordrequiring hyphenating by setting the I-beam pointer to the


6/34




correct break, and pressing Ctrl+hyphen. The soft hyphen ishidden if the word is not to be hyphenated at that point.

Kenneth Berg, Magnus Eriksson

Translated to English by Kevin Gater and Fiona Wait

Sundsvall 2007-01-

THE TEMPLATE STARTS HERE

ERASE THE ABOVE INTRODUCTORY INSTRUCTIONS


7/34

Mid Sweden UniversityThe Department of Information Technology and Media (ITM)Author: [ Authors name ]E-mail address: [authors e-mail address]

Study programme: [Study programme, credit points]Examiner: [Dr. Anders Andersson, e-mail address]Tutors: [Bertil Bertilsson, organisation X, e-mail address]Scope: 0 words inclusive of appendicesDate: 2007-01-04

[Place for illustration]

[B.Sc. Thesis/ M.Sc. Thesis/ project reportwithin Computer Engineering/Electrical Engineering

A/B/C/D, course, X points]

[ Title ][ Subtitle ]

[ Authors name ]


8/34

[ Title ] - [ Subtitle ][ Authors name ]

Acknowledgements /Foreword

2007-01-04

AbstractThe abstract acts as a description of the reports contents. Thisallows for the possibility to have a quick review of the reportand provides an overview of the whole report, i.e. containseverything from the objectives and methods to the results andconclusions. Examples: The objective of this survey has beento answer the question. The survey has been conducted withthe aid of. The survey has shown that Do not mentionanything that is not covered in the report. An abstract iswritten as one piece and the recommended length is 200-250

words. References to the report's text, sources or appendicesare not allowed; the abstract should stand on its own. Onlyuse plain text, with no characters in italic or boldface, and nomathematical formulas. The abstract can be completed by theinclusion of keywords; this can ease the search for the reportin the library databases. Example:

Keywords: Human-computer-interaction, XML, .Net, C#.

ii


9/34


Acknowledgements /Foreword

2007-01-04

Acknowledgements / ForewordAcknowledgements or Foreword (choose one of the headingalternatives) are not mandatory but can be applied if you asthe writer wish to provide general information about yourexam work or project work, educational programme,institution, business, tutors and personal comments, i.e.thanks to any persons that may have helped you.Acknowledgements are to be placed on a separate page.

iii


10/34


Table of Contents2007-01-04

Table of ContentsInstructions and template for technical reports and

graduation work..................................................1The report's aim........................................................................1The report's scope....................................................................2Layout 2Language 4MS Word-template automatic features.....................................4

Abstract....................................................................ii

Abstract....................................................................ii

Acknowledgements / Foreword..................................iii

Acknowledgements / Foreword..................................iii

Table of Contents......................................................iv

Terminology / Notation..............................................vi

Terminology / Notation..............................................viAcronyms / Abbreviations........................................................vi

Mathematical notation.............................................................viIntroduction..............................................................1

Introduction..............................................................11.1 Background and problem motivation..................................11.2 Overall aim / High-level problem statement........................21.3 Scope 31.4 Concrete and verifiable goals / (Low-level) Problem

statement.................................................................31.5 Outline.................................................................................41.6 Contributions.......................................................................4

Theory / Related work................................................5

Theory / Related work................................................51.7 Definition of terms and abbreviations.................................51.8 To review or to quote..........................................................61.9 References and source references......................................61.10 Automatically numbered source references......................81.11 Illustrations........................................................................91.12 Mathematical formulas......................................................9

Methodology / Model................................................11

Methodology / Model................................................11

iv


11/34


12/34


13/34


2 Theory / Related work2007-01-04

IntroductionDuring your previous education, you have probably comeacross relatively well defined problem types as formulated byteachers, textbooks and teaching aids. During project coursesand exam work you are required to do a great deal of thethinking by yourself in order to define and clarify the directionof the assignment. This analysis should be presented in thereport's introductory chapter. By describing the problem orproblem area chosen for study and the reasons behind this

choice, it should then be possible to write a generalintroduction to the report.

The introductory chapter relates to the content in the projectplan that will be presented some weeks after the diploma workhas started. The project plan should also contain a time planfor the work. The project plan can also mention some of theintended sources to be read and subsequently referred to inchapter 2, and also to contain some thoughts about themethod (see chapter 3) chosen in order to approach theproblem.

The introduction (choose one of the headings) making upchapter 1, may also contain sub-headings underneath. Try tocome to the core as soon as possible. In order to retain thereaders interest information concerning your work must begiven within the first few sentences. People only requiring aquick insight into the work will often only read the report'ssummary, introduction and conclusions, since these sectionsare usually written without the inclusion of highly technical andmathematical details.

1.1 Background and problem motivation

In this sub-chapter you should try to quickly engage thereaders' interest in the problem area you have chosen toexamine. Demonstrate that you are not only familiar with anyminor technical problems, but also have an understanding ofthe context in which your problem emerges, that you can alsodescribe it from a non-technical perspective, and that you areaware of the practical benefits of the technology you areexamining or have knowledge of areas that your study relatesto.

1


14/34


15/34



1.3 Scope

Examples: The study has its focus on. In the survey, theeffect of parameter Z is ignored, because. The survey isdistinguished by the evaluation of cases F1 and F2. Thesurvey's conclusions should however be generally valid forevery.

1.4 Concrete and verifiable goals / (Low-level) Problemstatement

The problem- or objective statement is a verification of theproposed formula you will use to reach your objective. The

questions that are specified should be answered in the report'sresults, and in its conclusion. The problem statement shouldbe so clearly defined that deciding whether or not the problemhas been resolved should be an easy process.

This sub-chapter is usually written after the implementation ofthe theoretical study in chapter 2, and should be revised atregular intervals throughout the duration of the project. It ispossible that the problem statement might require to beplaced after the theoretical study, if it is felt that it might bedifficult for the reader to understand the concepts used. The

disadvantage of such a layout is that the reader might loseinterest in the subject before the core points have been made.

Examples of problem statements for use in a scientific reportthe survey has an objective to respond to the followingquestions: P1: What importance has technology A comparedwith technology B for the performance measure Y at differentvalues on parameter X, for cases F1 and F2? P2: Which profitgives For mathematical definitions of X and Y, see the modelin chapter 3. It is then in chapter 3 that the objectivenumerical results will be specified, i.e. what will exist on the x -

and y-axis in the diagram you intend to take further.

Examples of objectives for a technical report: the survey'sobjective is to suggest a solution to the following technicalproblems: the survey has further objectives to verify thatthe solution proposal provides useable criteria and to evaluatethe proposal with respect to performance measure Y.

All technical details are reserved for the structure chapter'stechnical requirement specifications.

3


16/34



1.5 Outline

Briefly describe the report's outline. Chapter 2 describes

1.6 Contributions

Describe which parts of the work that you have conductedyourself, and which parts that you had help with i.e. carriedout by colleagues. If the work is carried out in a group thereport should then explain how the tasks were dividedbetween authors. All co-authors should be credited in the workas a whole.

4


17/34



Theory / Related workIn the report's theory study, sometimes called Related work,there may be additional facts required for the reader'sunderstanding of the report. At this point a summary ofbackground material in the area should be provided, i.e.standards, scientific articles, books, magazines, documents onthe web, technical reports and user manuals. Explainpedagogically with clear examples and many illustrations.

It should be demonstrated that you have an awareness of thecontext and the background of your work in addition to thatcarried out by you within the project. Explain the aim of thetechnology that you describe, and not only how the technologyworks. For D-level you should display an awareness of the keyresearch within the area, in order to ensure that your work hascertain news worthiness. However it is vital that you do notdeviate too much from your research problem.

Your assignment is not to write a textbook. It is important tofind an appropriate balance between related work and your

own results. The theory study should only constitute a minorportion of a thesis.

Instead of Theory or Related work, the heading may verywell be a specific topic, for example The GSM standard or Asurvey on the research field ofX".

If the theoretical study section is rather brief then it is possibleto include it within the Introduction chapter.

1.7 Definition of terms and abbreviationsTerms and abbreviations that are important for the reader'scontinued understanding are explained in this chapter. Thefirst time you insert text that uses a concept or anabbreviation you should also explain it, even if it is alreadydefined in the terminology section. The concept is typed usingthe italic style.

The first time an abbreviation (abbr.) is used it is typed withinthe parenthesis after its explanation, as illustrated in thissentence.

5


18/34



You can provide a subject index at the end of the report,stating on which pages respective concepts are defined and

discussed. In order to add a concept to the subject index,highlight the concept and press the keys Alt+Shift+I. Place thesubject index just before the first appendix or after the lastappendix by placing the I-Beam pointer there, and then chooseInsert->Reference ->Index and Tables ->Index.

1.7.1 Example of level 3 heading

Avoid too many heading levels.

1.8 To review or to quote

You review when you reproduce content using your ownwords.

Example: Forslund [4] recommends more informative headingsbe used in technical reports and that one should, in particular,provide important information in the sub headings.

You quote when you literally reproduce a phrase, a sentenceor paragraph. Quotations under 50 words are to be placedwithin quotation marks. To quote Strmqvist could be a

suitable illustration in this context: It may be difficult to write,but it is also fun [3].

Quotations over 50 words should be reproduced in the form ofblock quotations. The text block is centred on the page withoutquotes and in small caps. The source is stated in directconnection to the block quotation.

This is a block quotation which contains indents, smallcaps, straight left margin, not necessarily straight rightmargin, and no quotes. The block quote can be applied tomore than approximately 50 words. The block quote is

always completed with a source reference [3].

You can use direct quotations if you wish to reproduceestablished definitions of concepts, which you believe anauthor has formulated himself in a particularly suitablemanner, when you require aid of an authority, or when youwish to demonstrate that an author is wrong.

1.9 References and source references

To reproduce a text without stating its source is to be

considered as plagiarism and is thus defined as seriouscheating.

6


19/34



A list of references are placed at the end of the report in orderto give the reader overall information regarding all reviewed

sources, quotes or for any other reasons that you need to referto in the text. The sources should be carefully stated so thatthe reader can check if it is available in libraries or on theinternet. Sometimes it might be that verbal sources and othercorrespondence are included in the source list, but this isunusual in technical reports.

Use only sources in the list that you refer to or quote in thecontinuous text. All sources that are used in the source listshould be linked to the report through reference in thecontinuous text, according to the Vancouver-system, whichcommonly occurs in reports regarding technical matters.

According to the Vancouver-system the source list is arrangedin the same order as the sources appear in the continuoustext, the source reference is to be stated in the text with afigure within square brackets, i.e. [1] or [2, 3]. They shouldalso be stated in this order in the source list. Examples ofsource reference: According to Eriksson [2] dynamic SFNs canprovide significant performance improvements.

Examples of source list according to the Vancouver-system:

[2] M. Eriksson, Dynamic Single Frequency Networks, IEEEJournal on Selected Areas in Communications (J-SAC), vol. 19,nr. 10, 2001, s. 1905-1914.

Since information on the web may be frequently revised andsince web links can cease to function, the date of retrieval ofthe information from the web page must be stated. For web-based sources, it is sometimes necessary to provideinstructions as to how to find the source. Remember that thequality of material on the Internet varies.

Example:[9] Post- och telestyrelsen, Ansluta trdlstwww.pts.se/internetsakerhet/Sidor/sida.asp?SectionId=1966Published 2005-04-11. Retrieved 2005-05-20.

On some occasions it may prove necessary to use the Harvard-system. In this case, the source reference is stated in thecontinuous text with the surname, the print year withinbrackets, and page reference within brackets, i.e. (Andersson,

1996, s. 3), or according to Andersson (1996:3).References are arranged in letter order after the authors

7
http://www.pts.se/internetsakerhet/Sidor/sida.asp?SectionId=1966http://www.pts.se/internetsakerhet/Sidor/sida.asp?SectionId=1966


20/34



surnames, and can be sorted under the following sub-headings: Verbal sources, written sources, web sources, other

sources.

Format the source list in a consistent manner. At the end ofthis template, the source list is presented in accordance withthe Vancouver-system with examples of how you statereferences to book chapters, scientific articles, and articles inthe daily press, verbal sources, reports, folders, manuals andtechnical standards.

1.10 Automatically numbered source references

It is possible to use the word processing program in order toautomatically number the source list and the sourcereferences according to the Vancouver-system. In MicrosoftWord this can be performed in two different ways.

The first method means that you enter the source's descriptionin the source list at the end of the document, in an automaticnumbered list. Then, you indicate where in the continuous textthe source reference will be placed, and choose the menuoption to Insert -> Reference -> Cross-Reference -> Numbereditems. An example of a reference list produced by means of

this method can be found at the end of this template. Anexample of such a source reference: See [19]. The advantageof this method is that the source list can have an alternateorder.

The other way is based on the MS-Word function Endnotes,which is a form of footnotes. It is possible to create moresource references through copying and pasting the reference,double clicking on it, and by modifying the source'sdescription. Alternatively, the function to Insert -> Reference-> Footnotes -> Endnotes can be chosen. If the samereference is required to be referred to on several occasions,the function Insert -> Cross reference, as described above,must be used. If an MS Word-template other than this one isused then the end comment figure's style format must bechanged so that it does not become raised. The advantage ofthis method is that the source list text (the end commentary)follows if the text section containing the source referencenumber is copied to another document. Another advantage isthat the source list automatically follows the same sequenceas the references, in accordance with the Vancouver-system. A

third advantage is that if the mouse is held over the sourcereference, the end comment (i.e. the source list's text) is

8


21/34



shown in a popup-window. The disadvantage is that the sourcelist can only be placed at the end of the document or at the

end of a section but nowhere else. Each section can have itsown heading page. If different heading pages are required fordifferent chapters, and in addition there are severalappendices in the same Word-document, then it is possiblethat this method may cause the source list not to be placeddirectly before the appendices.

1.11 Illustrations

All illustration (pictures, characters, diagrams, tables) in thereport should be numbered and accompanied by a short text

description. In addition to the text the illustration sourcereference should be stated, if it is not your own. Example:

Figure 2.1: System overview [1].

All illustrations should be linked to the report via a reference inthe continuous text. Examples: the system is illustrated bythe block schedule in Figure 2 .1, According to Table 3.5etc. The references are written in English beginning with acapital letter (for example Figure), and in Swedish beginningwith lower case (for example figur).

In the word processing program Microsoft Word it is possible toachieve automatic figure- and table numbering by choosingthe menu option Insert-> Reference -> Caption. For automaticreference to a figure, choose Insert -> Reference -> Crossreference. Choose reference type Figure. In this template, thefigure text for and references to Figure 2 .1 are created withthe aid of these functions.

1.12 Mathematical formulas

Mathematical formulas should be centred, or alternativelyindented by approximately a centimetre. They should benumbered, and then placed to the right. The variable name isusually in italics. References to equations are given with

9

StorageStorageDocumentsDocuments


22/34



reference to the equation number, except when references areat the start of a sentence. All variables are defined in the

continuous text. See the following examples:

The effect,i j

P that is transferred from base station i to the

mobile telephonej is modelled according to the following:

,

,

,

i i j

i j

i j

PGP C

d

= , (2.1)

where iP is the base station broadcast effect; ,i jd is the

distance between the base station and the mobile; is anexponent that is 2 in free space and approximately 3 to 4 in atown settlement; C is a factor that depends on aerial

strengthening, channel frequency and aerial height; and,i j

G is

a stochastic variable that represents the fading.

In the word processing program Microsoft Word, inserts can beformulated by choosing Insert -> Object, and then EquationEditor.

Automatic equation numbering can be achieved by copying

the above equation numbering, and by placing it after eachequation. The numbering is updated by selecting the equationnumbering and by pressing the button F9, or in connectionwith a print-out.

Example of reference to an equation: On the basis of Eq. ( 2 .1)it is realised that the received effect is proportional to thetransmission effect.

Automatically updated references to equation numbers can beachieved via Word's bookmark function. Select the first

equation number beside the equation, choose Insert ->Bookmark, name the equation, i.e. the equation effect in ourcase, and click on the button add. Choose the page functionInsert ->Reference -> Cross reference -> Bookmark, andchoose the equation name from the list.

10


23/34



Methodology / ModelWith regards to C- and D-level diploma work, it is insufficient tomerely perform a practical construction or programmingproject. A systematic survey must also be carried out, e.g. anevaluation and analysis of the design or program. The surveyshould result in objective facts, preferably in the form of tablesand diagrams, into which your own conclusions are inbuilt. Thesurvey can be a verification of a design that meets therequirement specification, or a comparison of competing

alternatives. It is acceptable to allow users to answer aquestionnaire or be interviewed. It is also possible to evaluateweb-pages and other user interfaces according to usabilitycriteria.

The method section is the point at which your chosen methodand intended procedure during the research are discussed.Refer to the problem wording in the introduction chapter. It ispossible, for example, to write problem P1 is attemptedthrough the method M1 and problem P2 through Thesection will not be a chronological diary filled with irrelevantdetails, but should contain information given in such a waythat it is understandable to the reader and enables him/her tointerpret your results and repeat your work, i.e. in order tocheck the results. Here, the tools, assumptions, mathematicalmodels, performance measures and assessment criteria arepresented. It is also at this point that the means adopted forthe evaluation and verification of the computer programs andtechnical solution proposals are presented. This can include atest plan to check that the structure works and criteria toassess its usefulness. In research reports regarding natural

science and technology this chapter is often called Model,System Model or Simulation Model.

Justify your choice of methodology/model. This choice is veryimportant, because it could be the actual key to the result ofyour research. Comment on the method's possible weaknessesand problems that may arise during actual implementation.

In your report, you should depending on what the report isabout find information about what you have investigated andhow you have gathered and processed data. Possible

questionnaires, interview questions and such like can bepresented as appendices. Detailed descriptions concerning

11


24/34



experimental formats of possible interest to those wanting torepeat the experiment should also be included at this stage.

12


25/34



Design / ImplementationThe Design or Implementation chapter often appears intechnical reports, but not always in scientific reports. Here, theanalysis of the problem position is implemented and atechnical requirement specification is formulated. At thisstage, the most important principles in the suggested solutionalternatives are described and formulated in preparation forevaluation at a later point in the report. The description isplaced sometime before, but generally after the methodology

-/model chapter.

The reader is seldom interested in extremely detaileddocumentation of computer program code, algorithms,electrical circuit diagrams, user guidance, etc. Such details areplaced in the appendices.

An exam work or a project course can sometimes appear to bean almost overwhelming amount of information because it isso extensive, and this may cause anxiety with regards towhere to start. One way to facilitate big projects is to use the

top-down-method, i.e. to divide the problem up or thestructure into smaller problem parts or system parts, and tostate specification requirements, problem analysis and solutionproposal for each part. Eventually small and concreteinformation will have been identified with similarcharacteristics to those found in your previous studies.

It is not always practically possible to apply the top-down-method, since the problem may be too complex and it isinitially difficult to visualise the complete overview. It mightprove necessary to alternate between top-down - and thebottom-up-method. The latter means that you start with partsalready known to you and, from simple problems that havebeen tackled previously, utilise this knowledge for aspects thatyou expect to resolve at a later stage of the project. Graduallyincrease these parts into the bigger systems and problems andthen pursue the direction of project's objective.

The top-down-method has the advantage of giving the report asolid structure, which makes it easier for the reader. Thedocumentation therefore often follows the top-down-method. It

is thus possible to divide the structure part into severalchapters, and to name them after each problem part and

13


26/34



system part, i.e. Specific requirements, Algorithms, Userinterface, Program documentation, Prototype and

Implementation.

14


27/34



ResultsThe results chapter is included when you have produced asystematic survey, i.e. an evaluation of a program that youhave developed, which is required for C - and D-level diplomawork. In the results chapter, objective results of the survey arepresented. Consider that possible comments in this chaptershould only be for clarification of a type. Your own views andsubjective (personal) comments belong in the chapterconclusion/discussion.

Strive to present the results, for example measurement-,calculations- and/or the simulation result, in as understandablea form as possible. The results are presented in diagram- ortable form. Accounts of interviews can be summarised, butinclude concrete examples supporting your work.

Extensive results, for example complete summaries ofquestionnaire results, large tables and long mathematicaldeductions are placed in the appendices.

15


28/34



Conclusions / DiscussionThe conclusion/discussion (choose a heading) is a separatechapter in which the results are analysed and criticallyassessed. At this point your own conclusions, your subjectiveview, and explanations of the results are presented.

If the chapter is extensive it can be divided up into a sub-chapter containing the analysis and including important resultsand consequences and a discussion section consisting of well

supported conclusions.

A connection to the aim of the survey and a summary andanalysis of the results is of vital importance in this chapter. Itprovides scope for answering the results obtained from thefollowing questions:

Have the projects goals been achieved?

What is the answer to the opening problem formula?

Was the result as expected?

What is the project's newsworthiness and most importantcontribution to the research or technology development?

Are the conclusions general, or only apply during certainconditions?

Discuss the importance of the choice of method- and model forthe results.

Have new questions arisen due to the result?The last question invites the possibility to offer proposals toothers relevant research, i.e. proposal points for measures andrecommendations, points for continued research ordevelopment for those wishing to build upon your work.

In technical reports on behalf of companies, the recommendedsolution to a problem is presented at this stage and it ispossible to offer a consequence analysis of the solution fromboth a technical and layman perspective, for example

regarding environment, economy and changed workprocedures. The chapter then contains recommended

16


29/34



measures and proposals for further development or research,and thus to function as a basis for decision-making for the

employer or client.

17


30/34


31/34


32/34


Appendix D: Result ofquestionnaire survey

2007-01-04

Appendix B: Mathematicaldeductions

20


33/34



2007-01-04

Appendix C: User manual

21


34/34



2007-01-04

Appendix D: Result of questionnairesurvey