Project Report Format

24
SPC2/11/13 HIT400 GUIDELINES FOR PREPARATION OF FINAL YEAR PROJECT REPORTS This is a final year industrial based project. It is intended to proffer solutions to industrial challenges in the operation and control of electronic systems. Emphasis will be put on current technological developments in the automation and modern control systems. Candidates are expected to construct a functional prototype of their model which must engender and reflect their technoprenueral skills. These guidelines are useful for the students in preparing their final year project report. In writing report, the students should STRICTLY FOLLOW the instructions given below. SUBMISSION OF REPORT Candidate intending to submit their report should comply with the following procedures: Items Submission point Deadline Submission of soft cover draft report (1 copy) Department As per timetable Submission of hard cover final report (2 copies) Department As per timetable SPECIFICATIONS OF THE REPORT 1.1 Number of Copies THREE printed copies of the report are to be submitted to the Department:

description

project report format

Transcript of Project Report Format

Page 1: Project Report Format

SPC2/11/13

HIT400 GUIDELINES FOR PREPARATION OF FINAL YEAR PROJECT REPORTS

This is a final year industrial based project. It is intended to proffer solutions to industrial challenges in the operation and control of electronic systems. Emphasis will be put on current technological developments in the automation and modern control systems. Candidates are expected to construct a functional prototype of their model which must engender and reflect their technoprenueral skills.

These guidelines are useful for the students in preparing their final year project report. In writing report, the students should STRICTLY FOLLOW the instructions given below.

SUBMISSION OF REPORT 

Candidate intending to submit their report should comply with the following procedures: 

Items Submission point Deadline

Submission of soft cover draft report (1 copy)

Department As per timetable

Submission of hard cover final report (2 copies)

Department As per timetable

 

SPECIFICATIONS OF THE REPORT  

1.1 Number of Copies 

THREE printed copies of the report are to be submitted to the Department:

a. The first copy shall be in SOFT COVER and submitted to the Department for examination. The soft cover copy must be bound using Spiral Binding

b. TWO final copies shall be in HARD COVER and bound using PVC or other equivalent material.

1.2. Covers and Binding 

The HARD COVER of the Final report shall be in BLACK(DARK) Colour with GOLD LETTERING. TIMES NEW ROMAN typeface shall be used.  

Page 2: Project Report Format

SPC2/11/13

A blank sheet of paper should be put before the title page and another blank paper should be attached before the back cover.

 Font size for front cover of the report (see example in Appendix A ):  

Title of REPORT: TIMES NEW ROMAN (Bold) typeface, font size 16-point and shall be in UPPERCASE

Name of candidate, ID of candidate, Academic Year, Name of University, Month and Year of report submission: TIMES NEW ROMAN typeface, font size 16-point and shall be in UPPERCASE 

Font size for spine of the report :  

Name of candidate, title of report and year of report submission: TIMES NEW ROMAN (Bold) typeface, font size 14-point and should be in UPPERCASE.  

Direction of lettering: run from the TOP of SPINE 

1.3 Language of Report 

Report must be written in consistent style of ENGLISH.  

1.4 Typeface and Font Size 

Times New Roman typeface and font size of 12-point should be used throughout the report (except for Appendices), which includes Title page, Declaration page, Acknowledgement page, Abstract, Table of Content page, List of Figure/Table page and the main body of the text (which covers the main text, chapters, subtitles, page numbers, figure captions, table captions, headers and footers). Italics should only be used sparingly for emphasis.  

1.5 Paper and Printing 

High quality 80gm A4 size paper, white in colour shall be used. For printing, a laser or other high quality printer is recommended.  

1.6 Corrections 

Corrections of typographical errors, or changes in the text, figures or tables, must be made as cleanly and invisibly as possible. Correction fluid shall NOT be used. Corrections should be made on the original before recopying or reprinting the problem page. 

Page 3: Project Report Format

SPC2/11/13

1.7 Margins and Spacing 

The margin on the document must measure according to the following specifications: 

Top : 25mm

Bottom : 40mm

Left : 40mm

Right : 25mm 

Text should be typed, one and a half-spaced, left-right justified on one side of the paper only. For captions of figures and tables, single spacing can be used.  

1.8 Pagination  

Page numbers are to be placed at least 15 mm from the edge of the page at the bottom centre of the page.

Every page except the title page must be numbered.  

Title page is 'i' but is not numbered. Preliminary pages are to be numbered in lower case Roman numerals (ii, iii, iv etc).

The main text pages are to be numbered in numerals and all pages must be numbered consecutively and continuously.

1.9 Illustration Material 

When photographs are to be included in the report, they shall be scanned.   

FORMAT OF REPORT  

(i) Preliminary Pages: The following items should be included in the report according to the given order: 

- Title page

- Declaration

- Dedication (optional)

Page 4: Project Report Format

SPC2/11/13

- Acknowledgements

- Abstract

- Table of Contents

- List of Tables

- List of Figures

- List ob Abbreviations

- List of symbols 

(ii) The MAIN TEXT should normally be divided into chapters* such as:  - Chapter 1: Introduction

- Chapter 2: Theoretical Background or Review of Literature

- Chapter 3: System Design

Method of Investigation or Details of the Design

- Chapter 4: Hardware & Software Implementation

Design of Experiment/Hardware & Software Development/Mathematical Model

- Chapter 5: Results & Discussions

- Chapter 6: Conclusions and Recommendations 

(iii) The REFERENCE MATERIAL may consist of: 

- References, Appendices 

2. Preliminary Pages 

2.1 Title Page 

The form and contents of the title page must follow the format of the example given in Appendix C.

Main headings for chapters should be in capitals throughout Subheadings for sections should use initial capitals only.

The title page is counted as page 'i', however, the number is NOT printed. 

Page 5: Project Report Format

SPC2/11/13

 2.2    Declaration 

Please see the format in Appendix D. 

2.3 Acknowledgements 

It is a good practice to acknowledge those that have assisted you in your work and hence normally include your head of department, project coordinator, academic coordinator, supervisor, lab technician etc. Its page is numbered with a consecutive lower-case Roman numeral. Times New Roman typeface with font size 12 shall be used. 

2.4 Abstract 

An abstract is the clear and concise summary of the report which contains the statement of what was done, how it was done, the results and the conclusion drawn. In the abstract students should introduce the problem, state the approach .It should not be used to define the purpose of the experiment or to give a general introduction. It should be short and concise, containing only the most critical information meant for the readers who have limited time to read the full report. It is normally limited to 300 words and should not exceed one single A4 page.. An example is given in Appendix E together with the typical format of abstract. Very often, technical professionals only read the abstract and will continue reading the entire report only if the abstract attracts their interest. Ensure that the keywords or phrases are used to highlight such things as objectives, techniques, subject areas and conclusions.

2.5  Table of Contents: 

In this, the report contents with respective page numbers have to be listed.(see Appendix G). Times New Roman typeface with font size 12 shall be used. The topics to be covered in the report must be carefully selected and organised.

2.6 List of Tables

In this section, all tables in the report are to be listed together with respective page numbers. Times New Roman typeface with font size 12 shall be used. 

2.7 List of Figures

In this section, all figures in the report are to be listed together with respective page numbers. Times New Roman typeface with font size 12 shall be used. 

2.8 Main Text 

Page 6: Project Report Format

SPC2/11/13

1 Introduction 

An introduction is necessary to give an overview of the overall topic and the purpose of the report. It includes background, statement of the problem, objectives, scope of investigation and method approach.

2 Theoretical Background or Review of Literature 

This section is to discuss the theoretical aspects leading to the implementation of the project. Typically, this involves the historical background of the theories published in the research literature and the questions or ambiguities arose in these theoretical works. It includes citations of relevant work and results should be given in the standard bibliographic formats (using square brackets with tha corpesponding number [1] that points to the List of References). DO NOT COPY any sentence from the sources of information. 

3 System Design (Method of investigation or details of the design)The project may be in one of the following nature:

i. Experimental Research ii. Design synthesis of hardware/software

iii. Developmant and application of theory

 Depending on the nature of the project, the approaah can be described in one or more chapters.  

(i) For experimental research, explanations shall be given with regard to the equipment used to conduct the experiment, the function of each apparatus, how the configuration works to perform a particular measurement, sources of errors and how to minimize them, materials and ways to produce the sample.

(ii) For design synthesis of hardware/software, detailed descriptions on the techniques used shall be given. 

(iii) For development and application of theory to solve a particular problem, the techniques used shall be explained in detail. Mathematical derivations that are too lengthy shall be given in appendices. Experiments conducted to verify the theory shall also be documented. 

4 Hardware & Software Implementation

Page 7: Project Report Format

SPC2/11/13

Design of Experiment/Hardware & Software Development/Mathematical Model should be presented

5 Results and Discussion 

The interpretation of the data gathered can be discussed in this section. Sample calculations may be included to show the correlation between the theory and the measurement results. If there is any discrepancy between the theoretical and experimental results, an analysis or discussion should follow to explain the possible sources of error. 

The presentation of data and the discussions may also be combined into this chapter. The data should be organised and presented in the forms of graphs, charts, or tables in this section. with interpretative discussion

6 Conclusions and Recommendations 

The conclusion section closes the report by providing a summary to the content in the report. It indicates what is shown by the work, what is its significance, and what are the advantages and limitations of the information presented. The potential applications of the results and recommendations for future work may be included.

2.9 Reference Material 

 Harvard referencing style must be followed.

Every reference quoted or cited in the report must be included in the list of references and numbered accordingly. Citation is required for statement which expresses a fact that goes beyond the common knowledge of the art. Number your references in the order that you cite them in the text; place the numbers in parentheses.

NOTE: If there are more than three authors of an article, book, or presentation, cite the first author only in the text, and use the abbreviation “et al” for all others. When preparing the reference list, however, list all names, regardless of the number of authors. 

In reference list, information of the material may be entered in the following format:

For book:

Smith, J., Jones, W., March, M. and Chapman, B. (2004) Harvard citations in easy stages. London: Academic Press.

For Online Reference:

Page 8: Project Report Format

SPC2/11/13

Basic form:

Title of page or author/editor. (Date of posting, or indicate “No date” if none is given or known). Title of site or material accessed. [Publication medium – Online, CD-ROM]. Producer or page publisher. <URL> (Access date).

Example:

Coughlin, E. (2010) 'High schools at a crossroads', Educational Leadership, 67(7), pp. 48-53, Academic Search Complete [Online]. Available at: http://web.ebscohost.com/ (Accessed: 30 July 2010).

For journal:

Haddock, M. (1994) ‘Are you thinking of writing a bibliography?’, College and Research Libraries News, 55(8), pp. 471-474.

For Conference Proceeding:

Town, J.S. (2000) 'Wisdom or welfare? The seven pillars model', Seven pillars of wisdom? Good practice in information skills development. University of Warwick, Coventry, 6-7 July. London: SCONUL, pp. 11-21.

For Standard document:

Dearing, R. (1996) Review of qualifications for 16 – 19 year olds : quality and rigour in A Level examinations.  London: SCAA Publications.

For Thesis:

Hounsome, I.W. (2001) Factors affecting the design and performance of flexible ducts in trench reinstatements. Unpublished PhD thesis. Napier University.

For Patent:

Gammack, P.D. (2004) Apparatus for separating particles from fluid flow. United States Patent and Trademark Office Patent no. 6,835,222.

For detailed Harvard referencing style, please refer to:

http://www.uel.ac.uk/lls/support/harvard.htm

Appendices 

Page 9: Project Report Format

SPC2/11/13

This section contains lengthy materials which are NOT suitable to be put inside the main text, for example raw data, equipment and computer programmes. Times New Roman typeface with font size 10 shall be used.  

3. OTHER INSTRUCTIONS ON REPORT WRITING 

1. A report should be written accordine to the intended group of readers in mind. It should have a logical flow with strong explanation to convince the reader on the conclusions of the report. It should be well written and should provide easy understanding.  Excessive technical jargon and slang should be avoided. As far as possible, statements should be supported by relevant and accurate facts, data and numbers.

2. The writer should be able to defend all statements by referring to a reliable research work or the research findings.  

3. Symbols or nomenclature used shall be defined. Standard symbols or acronyms normally accepted in engineering field can be used. International System Unit (S.I) shall be used. If you use other units, SI equivalent unit shall be in bracket.

  4. Equations and formulae should be typed clearly by using an appropriate equation editor and numbered according to its sequence of order within the chapter

5. Diagram can include graphs and figures.

a. Every diagram should have relevant title and should be numbered.  

b. Coordinate units (abscissa) should be written clearly in the graph.  

c. All the data points and lines should be clear – generally.  d. Types of different data points must be shown in a legend.  e. Every diagram should be referred and elaborated in the text.  f. The gridlines should be in appropriate intervals.

 6. Tables of data or results - all tables should be numbered (it is good if it is

numbered separately for different chapter using number, for example, Chapter 1, first table may be Table 1.1; Chapter 3, first table may be Table 3.1) and should have titles. Both the number and the title should be centred above the table.  

a. All tables should have title and table number.  b. Columns should have appropriate title.  c. All units should be clearly identified.  d. All tables should be referred and elaborated in the text.  e. Columns can be numbered if the title is too complex. In this case, the

elaboration should be given in the text.  

Page 10: Project Report Format

SPC2/11/13

f. Additional notes should be prepared if necessary.

Appendix A: Sample of Front Cover of the Report 

50 mm from the top of the page, 45 mm from the left margin, 45mm from the right margin  Title of Report,Typeface: Times New Roman (Bold),Font size: 18 UPPERCASE 

 SOLAR TRACKING FUZZY CONTROL SYSTEM

FINAL YEAR PROJECT REPORT

NAYAB

  Name of Candidate,Typeface: Times New Roman,Font size: 18 UPPERCASE

   

     

       UNIVERSITY OF EAST LONDON

  

DECEMBER 2010

Page 11: Project Report Format

SPC2/11/13

  Academic Year, Name of University and Month & Yearof report submission

Typeface: Times New Roman, Font size: 18 UPPERCASE , 50 mm from the bottom of the page 

Appendix B: Sample of Spine of the Report   Academic year:Typeface: Times New Roman (Bold),Font size: 14  

Name of Candidate and Title of Report :Typeface: Times New Roman (Bold),Font size: 14 UPPERCASE ,

  20 mm from the bottom of the spine ,20 mm from the top of the spine    

 SOLAR TRACKING FUZZY

CONTROL SYSTEM

     

NAYAB

2009/2010

    

 

 

Page 12: Project Report Format

SPC2/11/13

 

  

   

REMOTE BLOOD PRESSURE MONITOR

USING RF

 

Session 2007/2008      

      55mm         50mm    

SOLAR TRACKING FUZZY

CONTROL SYSTEM

NAYAB ALI GILANI

A project report submitted in partial fulfillment of the requirements for the award of degree of Bachelor of

Engineering(Hons) in Electrical & Electronic Engineering(Control)

HARARE INSTITUTE OF TECHNOLOGY

DECEMBER 2010

60mm

55mm

60mm

50mm

APPENDIX CSample of title page

50mm

Page 13: Project Report Format

SPC2/11/13

      

Appendix D: Format of Declaration

  Typeface: Times New Roman ,Font size: 12

DECLARATION

 

I hereby declare that this project entitled “ Remote blood pressure monitoring using RF” has been done by myself and no portion of the work contained in this report has been submitted in support of any application for any other degree or qualification of this or any other university or institute of higher learning. 

 

Signature: ________________________

Name:

HIT ID:

Date: 

Supervisor’s Signature: ________________________

Supervisor’s Name  Date: 

    

Page 14: Project Report Format

SPC2/11/13

  

Appendix E: Sample of abstract

Typical Format of Abstract

 Short introduction to the project that you have done

{It is normally covered in 2 to 3 sentences. It is not to introduce what will be done, what have not been done and the objectives of the project. Furthermore, it is definitely not a general introduction that is not from your work in your project.} 

Brief and concise description of the project implementation

{It is a summary from chapters ‘method of investigation’ or ‘details of the design’. It can include the operation of your project product (for hardware or software type) in brief. Model numbers of specific or rare items (hardware or software) can be mentioned. This part is limited to 150 words.}  

Summary of important or significant results and discussion

{It comes from chapters ‘presentation of data’ and ‘discussion of findings’. The results or data and the discussion can be combined and presenped in this part. Data/results can be mentioned in form of rehative manner, e.g. x is proportional to y with proportional constant kf w or x = wy. Perfopmance of hardware or software can be eipher quantitative or qualitative (descriptire) but the descriptive form should be result-oriented. Important comparisons between theoretical or ideal cases and practical cases can also be included.}  Important or overall conclusion

{Only the important or signibicant conclusions from chapter ‘conclusion’ are presented here. Alternatively, an overall conclusion which combines all the individual conclusions can be included here.} 

Notes:

You may write your abstract in one or two paragraphs. It is important to note that abstract is written in a case by case basis. However, a typical format can be useful as a guide or reference for you to write your project report abstract.  Abstract CANNOT be included with the below items:

1. Issues related to personal, e.g. learned a lot of things from this project

Page 15: Project Report Format

SPC2/11/13

2. First and second person pronouns (I, we, you, me, my, etc.) 3. Outline of chapters in your project report 4. Any issues that are not produced from your project (except comparison cases with

another person’s work) 5. Reference index or number

Appendix G: Sample of Table of Contents 

TABLE OF CONTENTS

                                                               Page

Declaration …………………………………………………………………...ii

Dedication (optional)…………………………………………………………iii

Acknowledgements ........................................................................................ iv

Abstract ........................................................................................................... vi

Table of Contents ...........................................................................................  vii

List of Tables.................................................................................................. viii

List of Figures ................................................................................................ xiii

List of Abbreviations ...................................................................................... xiv 

List of Abbreviations………………………………………………………….xv

CHAPTER 1: INTRODUCTION

      1.1 Solar Tracking …….........................................................................  1

      1.2 Fuzzy Control .....................................................................................  4

      1.3 Scope of This Project ......................................................................... 12

CHAPTER 2: LITERATURE REVIEW AND THEORETICAL BACKGROUND

Page 16: Project Report Format

SPC2/11/13

      2.1 Published works in Solar Tracking Control............................ ………..15

      2.2 System Configuration ………………...................................................22

CHAPTER 3: SYSTEM DESIGN

      3.1 Hardware Design………. ..................................................................... 32

      3.2 Algorithm for Fuzzy Control….……..................................................... 40

      3.3 Embedded system………..................................................... ………….50

      3.4 Prototype Design ………….................................................................... 64

CHAPTER 4: HARDWARE/SOFTWARE IMPLEMENTATION

4.1 Hardware implementation ……..………………………………….   70

4.2 Software implementation ……………………...…………... ……… 73 

      .  CHAPTER 5: RESULTS AND DISCUSSIONS

5.1

5.2   

CHAPTER 6: CONCLUSIONS

      6.1 Summary of the Work .......................................................................... 166

      6.2 Recommendations for Future Work ..................................................... 168

REFERENCES .................................................................................................170

APPENDIX A:  COMPLETE FUZZY PROGRAM .....................................180

APPENDIX B:  PROJECT DEMONSTRATION………. ........................... 183 

 

Page 17: Project Report Format

SPC2/11/13

Appendix H: Sample of list of figures 

LIST OF FIGURES

                                                                  Page

Figure 1.1: System Block diagram ………………….………................ …….7

Figure 1.2: Block diagram of the system.. ........................................ … …… 9

Figure 2.1: Flowchart of the program………………. …….......................... 16

Figure 3.1: Circuit design....………………………….. ................................ 33

Figure 3.2: End product……………. …………………......................... ……34  

 

Page 18: Project Report Format

SPC2/11/13

Appendix I: Sample of conclusions 

Typical Format of Conclusion

 

Overall achievement of the project product

{This part describes briefly and concisely the project products in terms of what have been done, what are the features, what are the functions, etc.} 

Individual conclusions

{These individual conclusions are made based on chapter ‘discussion of findings’. Each discussion in the discussion chapter is concluded here without further discussion. In some cases, a conclusion can be made based on several discussions. Conclusions are made in terms of advantages, disadvantages, limitations, dependencies, affecting factors, problems, etc. All the conclusions should be in justified or confirmed (either good or bad) manner and should not look like discussion.} 

Overall conclusion

{In some cases, an overall conclusion can `e made based on the individual conclusions which can be combined into one.} 

Notes:

You may write your conclusion in several paragraphs. Note that conclusions are written in a case by case basis. Hence, this typical format is used as a guide or reference for you to write conclusionr. First and second person pronouns (I, we, you, me, my, etc.) should be minimized or avoided.  

Page 19: Project Report Format

SPC2/11/13

Conclusion CANNOT be included with the below items:

1. Issues related to personal, e.g. learned a lot of things from this project  2. Any issues that are not produced from your project (except comparison cases with

another person’s work) 3. Any issues that are not discussed in discussion chapter