ETP - How to Write Final Report - Updated 15 April 2015

download ETP - How to Write Final Report - Updated 15 April 2015

of 69

description

A guideline for Engineering Team Project for student.

Transcript of ETP - How to Write Final Report - Updated 15 April 2015

Slide 1

How to write final reportEET 333 ENGINEERING TEAM PROJECT (ETP)2ND SEMESTER, 2014/2015 SESSIONMuhd Hafizi Bin Idris1ORGANIZATION OF THE REPORT COVER PAGETITLE PAGEACKNOWLEDGEMENTAPPROVAL & DECLARATION SHEETABSTRAK (MALAY)ABSTRACT (ENGLISH)TABLE OF CONTENTSLIST OF TABLESLIST OF FIGURESLIST OF ABBREVIATIONS & SYMBOLSCHAPTER 1 INTRODUCTIONCHAPTER 2 LITERATURE REVIEWCHAPTER 3 METHODOLOGYCHAPTER 4 RESULTS & DISCUSSIONCHAPTER 5 COMMERCIALIZATION POTENTIALCHAPTER 6 CONCLUSION & RECOMMENDATIONSREFERENCESAPPENDICES

PreliminariesRoman numbering,i, ii, iii, iv, 2COVER PAGE

ETP Project Title (All in CAPITAL letter)DO NOT BOLDName for each members(All in CAPITAL letter)DO NOT BOLDFont size: 12Spacing: 1.53 spacesFont size: 18Spacing: 1.0Font size: 12Spacing: 1.54 spacesFont size: 18Spacing: 1.0Font size: 18Spacing: 1.0NO BOLDRefer Appendix ATitle should reflect the objectives of the project. 3Cover page formatBinding type: Tape BindingPaper Type: Hard A4 Paper (front & back)Colour of paper: Will be decided laterNote: Please add plastic cover at the front and back of your report.

4TITLE PAGE

ETP Project Title (All in CAPITAL letter)DO NOT BOLDName for each members(All in CAPITAL letter)DO NOT BOLDRefer Appendix HStart roman numbering, but the page number is HIDE for page title

5acknowledgementInclude a brief statement of appreciations and in recognition of any special assistance such as from supervisors, family, scholarships from certain sources, utilization of library, engineers, laboratory, technicians, computer facilities and assistance provided by the Schools.

6acknowledgement7

Approval & declaration sheet

Title of the projectOnly the first letter for each word is in CAPITAL Full Name for each member and their matrix numbers.Only the first letter for each word is in CAPITALFull name of your supervisors.All letters are in CAPITALRefer Appendix IRoman font8Abstrak (malay) & Abstract (english)Abstract provides the reader with a summary of the contents of the project report. It should therefore be brief but contain sufficient detail, telling the reader the introduction to the research/project and/or problem statement, techniques/methods employed; main results and conclusions. The Abstract is the "gateway" to the contents of the project report, and therefore it is important that the Abstract gives the reader a good initial impression.

TIPS:Write the Abstract last. The project report will be easier to be summarised once all the bits are in place.For abstrak (Malay), DO NOT translate word by word the abstract (English). Write the abstrak in Malay language using your own word which has the same meaning like what you use in abstract.

COMMON MISTAKE!!9Abstrak (malay) & Abstract (english)Limit to one page onlyGuide: 20% introduction, 60 % method, 20 % conclusion from the results.Not more than 200 words.Write in one paragraphAbstract CANNOT be included with the items below: Issues related to personal feeling, e.g. learned a lot of things from this project First and second person pronouns (I, we, you, me, my, etc.)Outline of chapters in your project reportAny issues that are not produced from your project (except comparison cases with another persons work)Figure/Tables.Mathematical formulae.

10Abstrak (malay) & Abstract (english)EXAMPLEThe project presents the modeling of Distributed Network Cell (DNC) based on grey-box approach. The equivalent model of DNC comprises of a converter-connected generator and a composite load model in parallel. The detail development of the equivalent model is described in this thesis. The dynamic equivalent model is presented in the form of sixth-order nonlinear state space format and developed from the algebraic and differential equations describing assumed typical components of DNC. The accuracy of the equivalent model is evaluated and validated by the best fit value calculation. The comparison has also been made between the equivalent model based on grey-box approach and black-box approach in order to show the effectiveness of the proposed parameter estimation procedure. The results obtained demonstrate that the developed grey-box model performs better under small and large disturbance compared to the black-box model. Therefore the equivalent model of DNC developed based on grey-box approach has the potential to significantly improve model accuracy of DNC compared to the black-box approach.11Abstrak (malay) & Abstract (english)

Refer Appendix J12Table of contentsTable of contents lists all headings and subheadings with their page numbersFor a computer programming project, students are encouraged to put all non-significant language programme-code in the APPENDICES.13Table of contents

Refer Appendix C14Table of contents

Refer Appendix C15Table of contents

Refer Appendix C16List of figures

Refer Appendix L17List of tables

Refer Appendix K18List of abbreviations & symbolsProvides a list of nomenclature and definitions of acronyms used in the project report. Make sure that the corresponding units, if applicable, are included. It is good practice to have a different section for nomenclature involving Greek symbols as might be encountered in equations and one for acronyms.The format is same with List of Tables/Figures but without sequence number and page number

19List of abbreviations & symbolsAbbreviationsWTWind TurbineTNBTenaga Nasional BerhadEMCElectromagnetic CompatibilitySymbolsPPowerICurrentVVoltageRResistanceCCapacitanceLInductance

20Chapter 1 - introductionChapter 1 must discuss all the items below:Background of the project / Overview of the projectProblem statementObjectives of the projectScopes of the projectReport Outline

21Chapter 1 - introductionProblem Statement stated the current situation of a matter and describes / explains the problems exist with the current situation and propose a possible solution / method to eliminate the problems.

ExampleIncreasing penetration levels of renewable energy resources are calling for detailed revisit of power system dynamic behavior in both transmission and distribution network. For such a study the equivalent dynamic models of DNC, or to that matter, the whole distribution network, are highly needed so that power system operators can estimate its impact on power system dynamic behaviour. Detailed modelling of the whole DNC is not practical due to the size of the system and computational time constrains associated with dynamic simulations of large power networks. The models should be simple and of low order yet able to represent appropriately DNC dynamics as seen by the external grid. The main goal therefore is to eliminate a part (small or large) of distribution network and to replace it by the equivalent model which exhibits the same dynamic characteristics.

22Chapter 1 - introductionObjectives of the project objectives aim to create solution for the problems stated in the problem statement

Example To design a hybrid energy systemTo develop the associate controller of the developed hybrid energy systemTo analyze the effects of .........

Wrong objectives:To help peoples...To ease the process of ..........To reduce the queue at .............SPECIFICNOT SPECIFICUNMEASURABLE23Chapter 1 - introductionScopes of the Project The scopes of the projectshould include the following:A brief statement of the general purpose of the project/study.The subject matter and topics studied and discussed.The location of the study, where the data were gathered or the entity to which the data belong.The population or universe from which the respondents were selected. The period of the study. This is the time, either months or years, during which the data were gathered.

Example:This investigation was conducted to determine the status of the teaching of science in the high schools of Province A as perceived by the teachers and students in science classes during the school year 1989-1990. the aspects looked into were the qualifications of teachers, their methods and strategies, facilities forms of supervisory assistance, problems and proposed solutions to problems.

FOCUS & LIMITATIONS24Chapter 1 - introductionReport Outline brief explanations on the type of contents inside each chapter (1-5).Make it in paragraph form.

ExampleChapter 1 discusses on the motivation of this project, the objectives of the project, ............................. Chapter 2 is on literature survey of .........................................................................Methodology is discussed in Chapter 3. ......................................................................................Chapter 4 is discussing on the results .............................................................................. Lastly, the conclusion on the project is discussed in Chapter 5. ..............................................................

25Chapter 2 literature reviewLiterature review reviews on other peoples works and findings. It also includes background theories (all related equations), hypothesis and techniques related to your work.Justify the use of specific solution techniques or problem solving procedures in your workComments on other peoples works. What are the advantages?What are lacking/drawbacks?What need to be improved?

Put the references [ ] in your paragraph for any theories, techniques,methods and discussion on other peoples works.26Chapter 2 literature reviewExampleGenerally most of the works done only considered the static loads as the load models in the dynamic equivalent model of DNC [14-16, 20-22]. Only a few papers take into account the dynamic loads in their modelling [23, 25, 26]. The high proportion of induction motors are usually the most significant aspects of dynamic characteristics of system load as motors consume 60 to 70% of the total energy supplied by a power system [27]. Furthermore it has been suggested by [28] that for transient stability analysis in weak interconnected power systems (like DNC), the load needs to be represented by static part and dynamic part from induction motors. Thus it can be concluded that the dynamic load models should be considered in DNC modeling together with the static load model.

27Chapter 2 literature reviewExample

So far, the performance of micro grid/DNC has been investigated, with special emphasis on island operation [5]-[6], transient behaviour [7]-[8], as well as on control and protection schemes. An adequate equivalent dynamic model, representing the DNC, has not yet been proposed even though it is necessary for more thorough assessment of the performance of power systems with DNC.

28Chapter 3 - methodologyMethodology must include flow chart of the project showing all methods required for the project in sequence.Method can be defined as a systematic and orderly procedure or process for attaining the stated objectives.Every step/process stated in the flow chart must be described in detail.Methodology always involved a set of methods, techniques and tools.A tool is an instrument or apparatus that is necessary to the performance of some task.Technique is a systematic procedure by which a complex or scientific task is accomplishedMethod can include design, analysis and measurement.

Its better to separate general flow chart and specific/technical flow chart29Chapter 3 - methodologyExample of a general/overall flow chart

30Chapter 3 - methodology

Example of a technical/specific flow chart31Chapter 4 results & discussionResults can be depicted in the form of graphs, tables, figures or other suitable forms.Analysis must be made on every result you get / displayed in the chapter.Draw some conclusion after the analysis on all results.

ResultsAnalysisConclusion32Chapter 4 results & discussionExample

NoMonthTotal Sale1Jan 12002Feb30003Mac 15004April21005May80006June105407July46788August31469September725110October198711November998712December11567Total64956In the form of tableIn the form of pie chart33Chapter 4 results & discussion

Example

In the form of Column ChartIn the form of graph34Chapter 4 results & discussion

In the form of pictureSimulation resultExample

35Chapter 4 results & discussion

Measurement ResultExample

36Chapter 4 results & discussionAnalysis & conclusion

Figure 2.1 shows the total sale of Perodua in 2013. The highest sale is in December with total of 11567 cars. The lowest sale is in.. From the figure, it can be concluded that

Figure 2.1: Total Sales of Perodua in 2013The figure/table no. must be stated in the text/paragraphAnalysisConclusion37Chapter 5 commercialization potentialTarget consumer / market / user / application / industryComparison / market survey between your product/service with available product/service in the market in term ofCostExtra featuresUnique functionEtcPlease provide the data/information in the form of table, chart etc to support your statement.Draw conclusion how can your product/service compete with the available product/service in the market.

Commercialization potential bring 4 marks from total marks of your project.38Chapter 6 - conclusionConclusion must have these 2 sections.Summary of the report.Highlights whether the work completed complies with the set objective and the significance of the findings. State any limitations in achieving the objectives. Conclusion also must also includes:Recommendations for future worksSuggest future works based on work to be done to coupe the limitation or to improve your work. No analysis, data, figures, tables or equations should be included in the conclusionDont make your conclusion too lengthy (max 3 pages)

39

Chapter 5 - conclusionRefer Appendix MSummaryRecommendations40All three elements in your report should have a flowObjectiveMethodologyConclusionTo develop a hybrid energy systemDesign and analyse the hybrid energy system using MATLABThe developed hybrid energy system capable to produce a output power of 10kW.Objective methodology conclusion41Language style & format1) Report must be written in English.

2) Avoid using I , We, You etc.e.g.: I designed an antenna using ADS software.

Instead use passive: Antenna was designed using ADS software

3) Avoid using command forme.g.: Connect the output of antenna to the rectifier

Instead use reporting style: The output of antenna was connected to the rectifier

Use passive words42Flow of contentsOne of the techniques to achieve smooth flow of contents is to maintain a thread between adjoining chapters; ensure that each section within a chapter lead on to the subsequent section; and paragraphs of sections are connected to each other. A common practice is to use "joining" words or sentences, particularly at the end and beginning of each chapter. A joining sentence at the end of a chapter tells the reader what to expect, while one at the beginning of a chapter reminds the reader of the contents of the previous chapter.

43Flow of contentsAvoid using long sentences. Long sentences are difficult to read. Use simple sentences/explanations. Try to keep sentence length to less than two lines, and at the same time, make appropriate use of punctuation.The repeated use of words can make a report difficult, if not boring, to read. Use a thesaurus to get synonyms to introduce variety, but make sure that they are used in the proper context. Do not employ bombastic words to show how clever you are with the language. Explanations using commonly encounter words are more effective than pompous sounding but rarely used vocabulary.

44marginThe stipulated margins for the general text are as follows:Top edge:2.5 cm or 1 inchRight side:2.5 cm or 1 inch Left side: 3.5 cm or 1.35 inch Bottom edge:2.5 cm or 1 inch

45margin

Refer Appendix B46margin

Refer Appendix B47Font & spacingFont type: Times New RomanFont size: 12Spacing: 1.5 (except specified)Paper size: A4Draft report: 70 gsmFinal Report: 80 gsmWhile 1.5 spacing is generally used throughout the text, 1.0 spacing is recommended for long tables, long quotations, notes, footnotes, and reference entries.

48Report lengthThe report length should not exceed 50 pages not including the appendices.

49paginationAll page numbers are placed without punctuation and about 1.0 cm from the top-edge, either above the middle of the lines of text or in the upper right-hand corner with the last digit even with the right-hand margin.Alternatively, page numbers may be positioned about 1.0 cm from the bottom edge below the middle of the lines of text. Consistency is more important in the choice of position of the page number.

50paginationThe Preliminaries are numbered in consecutive lower case Roman numerals (i, ii, iii, etc.). The Title Page at the front of the report is considered to be page i, but the number is hide. Roman numeral ii appears on the first page that follows the title Page. The Chapter, Reference and Appendix pages are numbered consecutively in Arabic numerals (1, 2, 3, etc.) beginning with 1 on the first page of the text (Chapter 1). First page for every chapter (Chapter 1, 2, 3, 4 & 5) is counted but the number is hide.

51pagination

The preliminariesRefer Appendix C52pagination

The page number for the first pageof each chapter is counted but thenumber is hide.53Mathematical equationEquations and formulae should be typed clearly using Equation Editor. The word equation (*) or eq. (*) are used to refer to the equation number. i.e. equation (1.0), eq. (1.0), equation (1.1), eq. (2.1), etc. Eq. (1.0), Eq. (1.1), Eq. (1.2) refer to the equations in Chapter 1, while Eq. (2.2), Eq. (2.3) refer to Chapter 2, etc.Subscripts and superscripts in the equations must be clearly shown.Each equations must be included in the text/paragraph.The variables or symbols used must be defined in the text. Alternatively, all those can be defined in List of Abbreviations & Symbols.

54

Mathematical equationThe equation is centeredThe equation number is aligned to the right55Figures formatFigure must be properly centred on the page within the prescribed margin. The number of the figure must correspond to a similar number in the text.The word Figure or Fig. is numbered in Arabic numeral, and its caption is placed below and middles the figure (font 12, single-spaced).A figure should not extend beyond one page. Figures should be arranged close to the discussion and analysis and numbered in sequence, such as Figure 1.1, Figure 1.2, Figure 1.3, and so on for figures correspond to Chapter 1.The text Figure in the paragraph should not be Bold. For example: Figure 1.2 shows the..... The characteristic of distance relay is shown in Figure 3.1.If the figure is taken from other sources, the reference must be cited. For example: Figure 4.1: Characteristic of a distance relay [6].56Figures format

Figure centered2 spaces2 spacesboldFont 12, centeredSingle spacingCode the referenceif the figure is takenfrom other source.Refer Appendix D57Tables formatTable must be properly centred on the page within the prescribed margin. The number of the table must correspond to a similar number in the text. It may be useful to place tables in each chapter very close to the discussion related to the table.The tables in a chapter must be organized in sequence such as for Chapter 3, the tables are Table 3.1, Table 3.2 and so on.The word Table, its number and its caption appear above and middle the table (font 12, single-spaced). The text Table in the paragraph should not be Bold. For example: Table 6.3 shows the..... or The data of sun radiation in Perlis is shown in Table 2.5.If the table is taken from other sources, the reference must be cited. For example: Table 3.1: Data during bipolar mode [3].

58

Tables formatRefer Appendix E2 spaces2 spacesboldFont 12, centered, Single spacingCode the referenceif the table is takenfrom other source.Table mustbe centered59Headings & sub-headingsMajor headings such as INTRODUCTION for CHAPTER 1 should be in capitals and bold.Content of each chapter may be divided into sub-headings such as for Chapter 1, the sub-headings are 1.1, 1.2, 1.3, and so on. The sub-headings also can be divided into smaller sections such as 1.1.1, 1.1.2, 1.1.3 and so on depending how the writer organize the text The sub-heading should not be bold and in small letters.

60Headings & sub-headings

CAPITAL letters, Bold, CenteredSubheadings: Do not Bold, small lettersRefer Appendix B61Citation in textWhen u want to cite other peoples works (from book, proceeding papers, journals, websites etc) in your text/paragraph, you must use your own words which bring the same meaning with what trying to be explained by the authors. And then put the reference [ ].

Example: Q. Zhang designed a xxxx xxxxx xxxxxx xxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx [2].Your own words62Citation in textThe citation put in text must be in sequence, [1], [2], [3], .For a combination of citation in sequence, put under one bracket, [3-9].

Example xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx [1]. xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx [2]. xxxxxxxxxxx xxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx [3-6].

63referencesThis section begins on a fresh page bearing the heading REFERENCES in capital letters, centred.The list of references begins four spaces below the heading and is double-spaced between entries but single-spaced within each entry. References must be presented/wrote according to the Number System.

64Refer Appendix Greferences

Double spacing between referencesRefer Appendix F65appendicesThis section if it is included must be useful and must be referred to in the text.This section is separated from the preceding material by a cover sheet bearing the heading APPENDICES in capital letters and centred. This section may be divided into APPENDIX A, APPENDIX B, APPENDIX A(i), APPENDIX A(ii), APPENDIX B(i) etc and should be in capital and bold.If appendix with its title, if it has one, should be listed separately in the Table of Contents as a first order subdivision under the heading APPENDICES.

66Units of measurementThe Systeme International dUnites (SI) should be used for all scientific and laboratory data.

67importantDo not copy & paste directly paragraph or sentences taken somewhere. Use your own words to represent the information/references cited. Do not use Google Translate and directly put into the report. Google translate only can be used as guidance.All report have to be uploaded into turn it in website to check for similarity index/plagiarism.Similarity index must be less than 30%.The contribution of report evaluation is 40%.So, produce THE BEST REPORT before it is submitted to the panel for evaluation!! 68Thank you..Q & A69