psm report writting format - v2013

14
PSM REPORT PREPARATION

Upload: muhammad-syiardy

Post on 02-Dec-2015

33 views

Category:

Documents


4 download

DESCRIPTION

Writing report for degree

TRANSCRIPT

Page 1: PSM Report Writting Format - V2013

PSM REPORT

PREPARATION

Page 2: PSM Report Writting Format - V2013

TABLE OF CONTENT

1. REPORT CONTENT 1

1.1 Hard Bound Face and Spine 1

1.2 Title Page 1

1.3 “Borang Pengesahan Status Laporan PSM” 1

1.4 Declaration 1

1.5 Approval 1

1.6 Abstract 1

1.7 Dedication & Acknowledgement 2

1.8 Table of Content 2

1.9 Lists of Tables and Figures (Illustrations / Photographs) 2

1.10 Lists of Abbreviations, Symbols and Specialized Nomenclature 2

1.11 Main Text of the Report 2

2. REPORT WRITTING FORMAT 3

2.1 Language 3

2.2 Font 4

2.3 Title and Subtitle 4

2.4 Numbering 4

2.5 Line / Body Text Spacing 5

2.6 Tables, Figures and Captions 5

2.7 Margins 6

2.8 Pagination and Page Sequence 6

2.9 Printing Paper 8

2.10 Citation 8

2.11 Additional Examples of Citation 9

2.12 Reference 10

Page 3: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

1

1.0 REPORT CONTENT

This document is expected to guide the final year student in preparing his/her final year project

(PSM) report.

1.1 Hard Bound Face and Spine

The colour of the hard bound report face (cover) must be CHILLI RED (colour code:

Red-530). Refer to Appendix A and Appendix B for details.

1.2 Title Page

The title page is put inside the report with UTeM logo. See Appendix C for the format

of the title page.

1.3 “Borang Pengesahan Status Laporan PSM”

See Appendix D and Appendix E.

1.4 Declaration

See Appendix F.

1.5 Approval

See Appendix G and Appendix H.

1.6 Abstract

The abstract should be written in Malay in one paragraph within a page with its

translation in English on another page. See Appendix I and Appendix J.

Page 4: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

2

1.7 Dedication & Acknowledgement

If Dedication page is necessary, you can include it Appendix K. But, report must

include a brief statement of thanks in recognition of special assistance (including

financial) and guidance given by individuals, institutions or government bodies using

Appendix L.

1.8 Table of Content

See Appendix M.

1.9 Lists of Tables and Figures (Illustrations / Photographs)

These lists consist of the exact titles (including numbering) of all tables and figures

that appear in the report. See Appendix N and Appendix O.

1.10 List of Abbreviations, Symbols and Nomenclature

This list is non-compulsory, depending on the subject of the report. All scientific

symbols and Nomenclature should follow the standard of SI-system. All symbols or

abbreviations, notations or terminology found in the text should be listed on this page.

They are listed in the alphabetical order. See Appendix P.

Please Refer To Page 6 & 7 for Pages Arrangement Sequence

1.11 Main Text of the Report

The main body of the report is usually arranged into consecutively numbered chapters

or sections. The internal organization of the report is the responsibility of the student

in consultation with the Supervisor(s). The report will often include the following

chapters, but students need to consult their respective supervisors as the contents of the

report will differ based on the majoring/nature of the project. Please refer table below

or the detailed section.

Page 5: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

3

Table 1.1: The general and specific criteria of report content according to departments/majoring.

2.0 Report Writing Format

This Report Format section contains the guideline for the entire report writing including the font

type, texts, paragraph and figures including the illustrations in the appendices.

2.1 Language

The report must be written in UK English. The language used should be simple

and direct to the subject.

Page 6: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

4

2.2 Font

Refer to Appendix Q-V for the details.

2.3 Title and Subtitle

All titles and subtitles must be clearly numbered and bold. The chapters are

numbered numerically, i.e. Chapter 1, Chapter 2, Chapter 3, and so on. The

Subtitles should be indented and arranged in a structured manner not more than

four levels as follow:

1.1 Second level (Title of the subtopic) – level 1

1.1.1 Third level (Title of the sub-subtopic) – level 2

1.1.1.1 Fourth level (Title of the sub-sub-subtopic) – level 3

Sub-topics beyond level three are not allowed. Hence, should be labeled using

alphabets and Romans. Refer to section 2.4 below for details.

2.4 Numbering

An example of numbering is shown in Appendix Q-V.

Note:

(a) Numbering using alphabet (a, b, c, …) is only allowed after sub-sub-sub-title.

(b) Numbering using Roman style (i, ii, iii, ….) is only allowed after the alphabets

have been used.

Page 7: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

5

Example:-

1.1.1.1 ......

(a) ......

(i) ......

(ii) ……

(b) ……

2.5 Line / Body Text Spacing

Use JUSTIFY alignment with 1.5 spacing for the entire body text throughout the

report. The gap between the subtitles to text should be closer as compared to the

distance from text end of the previous subtitle to the current subtitle. Please refer

to Appendix Q-V. For the body text, hit the enter key twice before stating the

following new paragraph. The introductory text for each chapter should be in one

paragraph without heading. There should be no indent for each paragraph.

2.6 Tables, Figures and Captions

Use CENTRE alignment with SINGLE SPACING for legends, captions of figures

and tables with Times New Roman font, size 10. The captions for tables should be

on top and at the bottom for the figures to the width of the entire margin and

prevent more than a line caption (set it justified if it exceeds more than a line –

refer Figure 2.1). The source of the table / figure is to be included in the caption.

The caption should be very little spaced from the table and figure. The full word

of Figure and Table need to be typed at the beginning of the caption. The figures

and tables are to be placed horizontally centre of the page and no text is allowed

on their left and right sides. Sample of caption for table is shown by Table 1.1

Page 8: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

6

Figure 2.1: Parts of an arbor with nut is clearly shown together with the milling tool attached for

the use of pneumatic clamping on CNC machine (Hasley 2007).

2.7 Margins

Please refer to Appendix Q-V.

2.8 Pagination and page sequence

The preliminary pages should carry page numbers in lower case Roman numerals

(i, ii, iii, etc.) followed by the Arabic page number 1, 2, etc. which only begin on

the first page of Chapter 1. Pages should be numbered consecutively throughout

the report, including pages of figures and tables.

Please refer Appendix: PSM Report Page Sequence

Page 9: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

7

Table 2.1: Arrangement of preliminary pages for PSM report.

Subject Page Number

Title Page without page number

Borang Pengesahan Status PSM without page number

Surat Laporan Sulit / Terhad (Conditional) without page number

Declaration without page number

Approval Form for ONE SUPERVISOR without page number

Approval Form for TWO SUPERVISORS without page number

Abstrak i

Abstract ii

Acknowledgement Roman numeric (if any)

Table of Content Roman numeric

List of Tables Roman numeric

List of Figures Roman numeric

List of Abbreviations, Symbols & Nomenclature Roman numeric

Start of Chapter 1 onwards Arabic numeric

Note:

[The item c] is only to be attached if the report is classified as Sulit / Terhad in

Borang Pengesahan Status PSM.

[The item e or f] only one of the forms to be attached based on number of

supervisor(s) guiding the PSM.

Page numbers should be at the bottom right of the page (even for landscape page

layout) and the page numbers should appear by themselves and are not to be

enclosed in parentheses, hyphens, etc.

Each appendix should be identified in sequence separately in alphabetical order

(Appendix A, Appendix B, etc.). Do not provide page number for the appendices

and they should be placed at the end part of report.

Page 10: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

8

2.9 Printing Paper

(a) PLAIN white A4 (210mm x 297mm) PAPER

(b) Good-quality with at least 80 gms.

(c) Photographic illustration must be printed in good quality and high-resolution

mode.

2.10 Citation

UTeM follows the Harvard System for literature citation style. This style must be

used consistently throughout the report. Citations are made by providing the

author's surname and their (published year) in bracket.

In the text, the year of publication appears within parentheses after the author's

surname if the latter forms as part of a sentence. Examples are as follows:-

(a) If the name of an author is written as part of a sentence, the year published

should be written in parentheses, for example: Masterson (1985) classifies robots

into two main categories that are servos and non-servo robots.

(b) If there are two authors to be cited as a part of a sentence, use for example:

Azis and Harrison (1987) classify robots into two main categories that are servos

and non-servo robots.

(c) For more than two authors for a cited reference, use et al. after the name of the

first author, for example: Chandra et al. (1986) classify robots into two main

categories that are servos and non-servo robots.

(d) If several papers by the same author from the same year to be cited, the letters

a, b, c, etc. should be added after the year of publication; for example Chazdon

and Ibrahim (1988a).

Page 11: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

9

(e) Citations of anonymous / unpublished articles should be avoided.

(f) Citation for official publications of international bodies/agencies should be

written as WHO (1984)

(g) Citation for materials from website:

Robots are classified into two main categories that are servos and non-servo robots as

viewed in Robot Magazine website at

<http://www.botmag.com/articles/issue22.shtml>

Or

Robots are classified into two main categories that are servos and non-servo robots

(Robot Magazine 2009)

(h) The publications should be cited in chronological order from earlier to recent

years, so that, the development of the related work can be tracked down.

2.11 Additional Example of Citation

Page 12: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

10

Page 13: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

11

Kalotas, T.M. and Lee, A.R. (1990). “A Simple Device to Illustrate Angular

Momentum Conservation and Instability.” American Journal of Physics. vol. 5,

no. 2, pp. 80 – 81.

Bloggs, J. (2004). “Having Fun with Harvard Referencing.” London: Nosuch

Press, pp. 21-25.

2.12 References

Cited articles should be listed in REFERENCES section/page in alphabetical

order of the principal author. See Appendix W.

This after section shows how to write the references at the end of the report. The

following bibliographic style is to be followed:

2.12.1 Journal

The author’s last name, comma, followed by initials then followed by the year of

publication (in brackets) and full stop (dot). “full title of the work” in inverted

commas and dot. Journal Name in italic and dot. volume, article number and page

number. The entire bibliography has to be title case except for vol., no. pp.

Sample is shown below.

2.12.2 Book

The author’s name, year in bracket. “Title” in inverted comma and dot. Published

place: Publisher, page number. Sample is shown below.

2.12.3 Patent

Inventor’s name, year in bracket. “Title” in inverted comma and dot. Patent

number- italic. Sample is shown below.

Gammack and David, P. (2004). “Apparatus for Separating Particles from Fluid

Flow.” U. S. Pat. 6,835,222.

Page 14: PSM Report Writting Format - V2013

PSM REPORT FORMATTING GUIDE

12

2.12.4 Conference Paper

Author of paper (Year of publication). “Title of Paper.” Title of Conference, date

and place in bracket, page number. Sample is shown below.

2.12.5 Research / Final Year Project

Author (Year of submission). “Title of Thesis.” Degree statement, Degree-

awarding body. Sample is shown below.

2.12.6 Website

Author (Year of publication). “Title of Book.” Name of e-book supplier [Online].

Available at: URL (Date accessed).

Singh, K. (2007). “Artificial Intelligence Modeling of Kerf Edge Quality in Laser

Machining by Adaptive Neuro-Fuzzy Inference System.” International

Conference on Intelligent & Advanced Systems - ICIAS2007 (25-28 November

2007 – Kuala Lumpur Convention Centre), pp. 87-92.

Hounsome, I. W. (2001). “Factors Affecting the Design and Performance of

Flexible Ducts in Trench Reinstatements.” Unpublished Ph.D. Thesis, Napier

University.

Krug, B and White, S. E. (2004). “EBay Secrets: How to Create Internet Auction

Listings that Make 30% More Money While Selling Every Item You List.”

Amazon [Online]. Available at: http://www.amazon.com/exec/obidos/tg/detail/

(Accessed: 16 August 2004).