PSM Report Writing Format 2010

  • View
    118

  • Download
    5

Embed Size (px)

Text of PSM Report Writing Format 2010

PSM REPORT WRITING FORMAT

TABLE OF CONTENT

1. REPORT CONTENT 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 1.9 1.10 1.11 Hard Bound Face and Spine Title Page Borang Pengesahan Status Laporan PSM Declaration Approval Abstract Acknowledgement Table of Content Lists of Tables and Figures (Illustrations / Photographs) Lists of Abbreviations, Symbols and Specialized Nomenclature Main Text of the Report

1 1 1 1 2 2 2 2 3 3 3 3 5 5 5 6 6 7 7 8 9 9 10 10 12 12 12

2. REPORT FORMAT 2.1 2.2 2.3 2.4 2.5 2.6 7 2.7 2.8 2.9 2.10 Language Font Title and Subtitle Numbering Line / Body Text Spacing Tables, Figures and Captions Margins Pagination Printing Paper Others

3. REFERENCE STYLE 3.1 3.2 Citation and Referencing Reference Writing 3.2.1. 3.2.2. Journal Book

3.2.3. 3.2.4. 3.2.5. 3.2.6.

Patent Conference Paper Research / Final Year Project Website

12 13 13 13

APPENDICES A B C D E F G H I J K L M N O P Q Hard Bound Face Hard Bound Spine Title Page Borang Pengesahan Status PSM Surat Laporan Sulit / Terhad (Conditional) Declaration Approval Form for One Supervisor Approval Form for Two Supervisors Abstrak Abstract Acknowledgement Table of Content List of Tables List of Figures List of Abbreviations, Symbols and Nomenclature Font / Title and Subtitle / Numbering / Line / Body Text Spacing / Margins References

CHAPTER 1REPORT CONTENT

This section basically guides the author in preparing the entire report content including the graphical illustrations which can be found in appendices. The REPORT CONTENT should be divided into appropriate chapters and they are show here.

1.1

Hard Bound Face and SpineThe 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.

1.7

Acknowledgement

Most reports will include a brief statement of thanks in recognition of special assistance (including financial) and guidance given by individuals, institutions or government bodies. See Appendix K.

1.8

Table of Content

See Appendix L.

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 M and Appendix N.

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

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.

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

CHAPTER 2REPORT 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.

2.2

FontRefer to Appendix P 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 1.1.1.1

Third level (Title of the sub-subtopic) level 2 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 P. 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. 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 P. 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 at Chapter 1.1.1.

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

2.8

Pagination

The preliminary pages should carry page numbers in small Roman numerals (i, ii, iii, etc.) followed by the Arabic page number 1 which only begin with 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.

No a. b. c. d. e. f. g. h. i. j. k. l. m.

Subject Title Page Borang Pengesahan Status PSM Surat Laporan Sulit / Terhad (Conditional) Declaration Approval Form for ONE SUPERVISOR Approval Form for TWO SUPERVISORS Abstrak Abstract Acknowledgement Table of Content List of Tables List of Figures List of Abbreviations, Symbols & Nomenclature

Example Appendix C Appendix D Appendix E Appendix F Appendix G Appendix H Appendix I Appendix J Appendix K Appendix L Appendix M Appendix N Appendix O

Page Number without page number without page number without page number without page number without page number without page number i ii Roman numeric (if any) Roman numeric Roman numeric Roman numeric Roman 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.

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

Others

All figures (picture, chart, diagram, etc.) must be clear. Scanned figures are allowed, but, must be in high resolution mode with fine cropping.

CHAPTER 3REFERENCE STYLE

Any report which makes use of others work, either in direct quotation or by reference, must contains a bibliography listing of all the sources. Only work directly cited or quoted in the text should be included in the bibliography.

3.1

Citation and Referencing

UTeM follows the Harvard System for literature citation and referencing style. This style must be used consistently throughout the report. References are made by giving the author's surname together with the year of publication. 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 ro