28
FYP REPORT WRITING GENERAL GUIDELINE

FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

  • Upload
    others

  • View
    1

  • Download
    0

Embed Size (px)

Citation preview

Page 1: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

FYP REPORT WRITING

GENERAL GUIDELINE

Page 2: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

ABSTRACT AND INTRODUCTION

• Abstract: a precise and concise summary of the project - theessence of the work - it represents the report in a highly condensedform.

• Introduction: a discussion of the background to the project - thesubject/application area, the purpose, scope, limitations and theplan of work. Make clear the precise subject to be considered, thenature of the study and the plan of its treatment. The principalconclusions and recommendations will be reviewed. Conclude witha brief commentary on the structure of the Report.

• An outstanding Abstract and Introduction which read well andexhibit no technical errors. The Introduction must provide abackground to the subject area, the principal conclusions andrecommendations, the plan of the study and review of the structureof the Report

Page 3: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

ABSTRACT

• Important in academic writing.

• From abstract, the reader is able to see the overall content of the report.

• No citation in abstract

• ~ 250 words in one paragraph

Page 4: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

ABSTRACT

• Should contains the following:

– Introduction

– Problem statements

– Objectives

– Methodology/Approach

– Experimental results

Page 5: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INTRODUCTION: TITLE

• Should convey the flavours of the project in one short sentence.

• Include important keywords that related to your project.

Page 6: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INTRODUCTION: BACKGROUND

• A few paragraphs should be sufficient to cover the background to your project. Try to explain the overall aims of your project, its type and the work you have done to date. You should also describe your external client, if you have one.

• This section sets the scene for a naive reader who knows nothing about your research.

• Identifying the gap in knowledge that you want to fill.

• Characterise what research has already been done in this area, explaining how and in what respects the research project you propose would contribute to it and why it would be interesting and/or important to do.

• Include citations.

Page 7: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INTRODUCTION: PROBLEM STATEMENT

• Define a problem as any situation where a gap exists between the actual and the desired ideal.

• The problem itself, need to be stated clearly and with enough contextual detail to establish why it is important.

Page 8: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INTRODUCTION: AIM

• One clear and concise statement of what you hope to achieve overall at the end of your project.

• Can start with:– “The aim of this project is to ...”

– “This project aims to...”

• Each project consists only one aim.

• The aim can be further ‘tightened’ by specifying contribution/method/place of research/type of study/etc.

Page 9: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

AIM (Example)

The aim of this project is to develop a prototype in applying hybrid HMM/ANN approach for a speaker independent continuous Malay speech recognizer. With the development of the prototype, it will provide an opportunity to explore another approach in Malay language speech recognition.

Page 10: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INTRODUCTION: OBJECTIVE

• Identify specific, measurable achievement you hope to make that

• Build towards supporting the ultimate aim of your project.

• More precise than aims.

• Ensure all objectives begin with the word ‘to’, and are phrased so that your success or failure in meeting them can be tested or measured.

• Is written in point form

Page 11: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

OBJECTIVE (Example)

The objectives of this project are as follows:1. To study the hybrid HMM/ANN architectures

and the appropriate phoneme for Malay speech recognition.

2. To develop prototype of speaker independent continuous Malay language speech recognizer using hybrid HMM/ANN approach.

3. To show that hybrid HMM/ANN approach is better than traditional HMM approach in speech recognition, according to the results of the prototype to be developed.

Page 12: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INTRODUCTION: SCOPE

• A description of what activities you plan to carry out, and of the functional or academic boundaries of your project.

• Listing what you are not going to be covering will help you to clarify your project scope.

Page 13: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INTRODUCTION: SCOPE

• Specific software/tool that are going to be used in the project.

• Specific place of study for the project.

• Specific group of sample

Page 14: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

SCOPE (Example)

The scopes for this project are as follows:• This project develops a Malay language speech recognition prototype

using Hybrid HMM/ANN system approach, with HMM is the underlying structure and ANN just to augment the speech recognition.

• The modes use in this speech recognition system is speech to text, speaker independent, continuous speech, and medium vocabulary size with simple Malay sentences.

• Data recorded from speaker with precise, clear style of speaking, by avoiding slurring and running words, for vocabulary file and as training data.

• This prototype not suitable to recognize children speech or people with disabilities in speaking.

• This project utilizes CSLU toolkit for waveform analysis, training recognizer, implementing hybrid HMM/ANN approach with programming in tcl/tk and C language.

Page 15: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INTRODUCTION: JUSTIFICATION

• Justify your choice of project by explaining how the project will meet the requirements of your course, why the topic interests you and what you will gain from the project.

Page 16: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INTRODUCTION: CONSTRAINTS AND ASSUMPTIONS

• Any special-specific constraints and assumptions should be noted for review by your supervisor. Avoid plain statements that apply to all projects, such as ‘the project must be completed on time’.

Page 17: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INTRODUCTION: PROJECT PLAN

• Your initial project plan.

Page 18: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INTRODUCTION: ORGANIZATION OF REPORT

This report has seven chapters, including this introductory chapter which covers the motivation and background information that leads to an idea of furthering in the detail the concept of …..

Chapter 2 provides background knowledge of ….

Chapter 3 covers the …….

……

Page 19: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

INFORMATION GATHERING

• The write-up should include a literature survey looking at work related to the topic; a discussion of approaches appropriate for the solution of the problem; a clear and full identification and justification of the product requirements

• An outstanding discussion which identifies the underlying literature and relevance sources to the research objectives.

Page 20: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

ANALYSIS

• The student is expected to clearly establish and discuss the project topic. The report should culminate with a clear vision of what sort of product is to be produced and how, in general terms, it will function. Finally an explanation / justification for the tools and techniques to be used in executing the project work.

• An outstanding analysis which identifies the underlying principles behind the problem and gives a fully justified statement of requirements. A full treatment of possible approaches to its solution and available tools/techniques.

Page 21: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

SYNTHESIS

• The student is expected to describe and justify the work carried out in order to solve the problem being investigated. Typically this will cover design, implementation and testing. The student should describe the activities, discuss and justify decisions made during the work, e.g. alternative design structures, reasons for chosen data representations, HCI considerations. The work should be supported by suitable references and illustrative examples of the actual product documentation.

• An outstanding discussion of the problem solution which explores all aspects of the application of methods/tools used.

Page 22: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

SYNTHESIS

• Design– System architecture design

– User interface design

– System process design• Flowchart• Used Case• Sequence• Class

– Database design

– Network design

– Technique/Algorithm design

Page 23: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

SYNTHESIS

• Implementation of project– Operation– Environment

• Coding– Explaination on important part only– The modules involved.– Modules involved

• Implementation of algorithm• Discussion on analysis of data, or analysis to the

simulation done.

Page 24: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

EVALUATION

• This section of the report is expected to cover both the product produced and the management of the project. It should include: – A discussion of the results of any client feedback, user reports,

etc;– An evaluation of the choice of tools/methods used for the work;– a critical discussion of how the product measures up to its

specification; – A critical discussion of the progress of the project with respect

to the project plan expressed in the Project Proposal

• A outstanding evaluation of the work undertaken: the product, the choice of methods and tools and personal progress and performance, incisive, self-critical and complete in all respects.

Page 25: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

EVALUATION

• Testing• Database

• Program

• Input and Output

• Algorithm

– Testing towards interactions with other systems

– User Testing

– Suggestions and comments from users

– State the testing approach (e.g. black box testing)

Page 26: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

CONCLUSIONS AND RECOMMENDATIONS

• This section should cover the full project. The Conclusions should agree and balance logically with the introduction in terms of results and summary. Any conclusions should be drawn from the evidence presented in the report. Recommendations and suggestions for further work should indicate a wider perspective than that of the project.

• The conclusion gives a complete comparison between the main aims or purposes of the project and the results obtained or work done. Moreover it concludes an assessment of the results obtained or the work done and makes recommendations for further work in a novel or particularly revealing way.

Page 27: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

REFERENCES

• Related journals, articles or books on which contribute to your ideal or problem statement, or work that has been done similar to the objectives that you wish to modify for improvement, etc.

• Make sure you write in correct reference style (e.g. APA)

Page 28: FYP REPORT WRITING › 2017 › 02 › week-05-buw3923-… · FYP REPORT WRITING GENERAL GUIDELINE. ABSTRACT AND INTRODUCTION • Abstract: a precise and concise summary of the project

Presentation

• The presentation mark is aimed at assessing how effective the report is as a means of communication, for instance, the writing style (grammar, spelling, and punctuation), presentation of arguments, layout, bibliography and references used. In this section, appropriate use of appendices will be mark. It is too measure the evidence of the understanding of process in terms of linkage between chapters and the flow of the work.

• Note that, there will not be a mark per criterion, but rather the criteria will be used for guidance in assessment.

• An outstanding report which communicates exceptionally well to the reader.