PSM Report Writting Guidelines

7/26/2019 PSM Report Writting Guidelines

1/15

PSM REPORTGUIDELINES

FOR FTK


2/15

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 32.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 References 10


3/15

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 COLOR (colour code:

AC2682). Refer toAppendix A1andAppendix B1for details.

1.2 Title Page

The title page is put inside the report with UTeM logo. See Appendix C1for the

format of the title page.

1.3 Borang Pengesahan Status Laporan PSM

SeeAppendix D1andAppendix E1.

1.4 Declaration

SeeAppendix F1.

1.5 Approval

SeeAppendix G1andAppendix H1.

1.6 Abstract

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

translation in English on another page. SeeAppendix I1andAppendix J1.


4/15


2

1.7 Dedication & Acknowledgement

If Dedication page is necessary, you can include itAppendix K1. 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 L1

1.8 Table of Content

SeeAppendix M1.

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. SeeAppendix N1andAppendix O1.

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. SeeAppendix P1.

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.


5/15


3

2.0 Report Writing Format

This Report Format section contains the guideline for the entire report writing includingthe 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.

2.2 Font

Refer toAppendix R1-V1for the details.

a) Appendix R1Chapter 1b) Appendix S1 Chapter 2

c) Appendix T1Chapter 3d) Appendix U1 Chapter 4e) Appendix V1Chapter 5

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 section2.4below for details.

2.4 NumberingAn example of numbering is shown inAppendix R1-V1.

Note:


6/15


4

(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.

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 R1-V1. 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 andCaptions

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

and tables with Times New Roman font, size 12. 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 and figure in Figure 2.1


7/15


5

Table 4.7: Ppk results for Potential Failure Modes for A1, B1 and C1

Potential

FailureMode

Critical

Dimensionfor

Improvement

lot

Subgroup

sample

N Ppk Occ.

Ranking

(New)

Reference

A1 22-24 mm 100 300 0.87 7 AppendixH

B1

31.031.3

mm

100 300 0.61 9 Appendix

I

C119.0 -

20.0mm100 300 0.53 10 Appendix

J

Figure 4.11: Scatter plot of Base Dimension (BD) against Riveting Height (RH)

Figure 2.1: Legends for table and figure:Times New Roman font, size 12


8/15


6

2.7 Margins

Please refer toAppendix R1-V1.

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.

Table 2.1: Arrangement of preliminary pages for PSM report.

Subject Status Page Number

Title Page Compulsory without page number

Borang Pengesahan Status PSM Compulsory without page number

Surat Laporan Sulit / Terhad (Conditional) without page number

Declaration Compulsory without page number

Approval Form for ONE SUPERVISOR Compulsory without page number

Abstract Compulsory i

Abstrak Compulsory ii

Acknowledgement, Dedication page Optional Roman numeric (if any)

Table of Content Compulsory Roman numeric

List of Tables Compulsory Roman numeric

List of Figures Compulsory Roman numeric

List of Abbreviations, Symbols & Nomenclature Compulsory Roman numeric

References Compulsory 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.


9/15


7

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.


10/15


8

2.9 Printing Paper(a) PLAIN whiteA4 (210mm x 297mm)

(b) Good-quality with at least80 gsm.

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

2.10 Citation

UTeM follows theHarvard Systemfor 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).


11/15


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

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 ofCitation


12/15


10


13/15


11

2.12 References

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

order of the principal author. SeeAppendix W1.

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 JournalThe authors last name, comma, followed by initials then followed by the year of

publication (in brackets) and full stop (dot). full title of the workin inverted

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

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

Sample is shown below.

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. 8081.

2.12.2 Book

The authors name, year in bracket. Titlein inverted comma and dot. Published

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

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

Press, pp. 21-25.

2.12.3 Patent

Inventors 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.


14/15


12

2.12.4 Conference PaperAuthor of paper (Year of publication). Title of Paper. Title of Conference,date

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

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

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

2.12.5 Research / Final Year Project

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

awarding body. Sample is shown below.

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

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

University.

2.12.6 Website

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

Available at: URL (Date accessed).

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).


15/15


13

Suffix Change Record

No Items Changed Description Amendment Date Latest Version1 2.6 Figures, Tables

and CaptionsFont size changedfrom10 to 12 for

figures, tables and

captions.

23 Dis 2014 V1.0

2 Format Review, format etc. 28 April 2016 V3.0

PSM Report Writting Guidelines

Documents

Transcript of PSM Report Writting Guidelines