fyp report template

24
Bahria University (Karachi Campus) Department of Applied Sciences & Graduate Studies FYP Report Format Template A revised version of FYP Report format. Incorporate the changes as according to the list given below.

Upload: jin-kazama

Post on 13-Apr-2015

88 views

Category:

Documents


4 download

DESCRIPTION

standard report

TRANSCRIPT

Page 1: FYP Report Template

Bahria University(Karachi Campus)

Department of Applied Sciences & Graduate Studies

FYP Report Format Template

A revised version of FYP Report format. Incorporate the changes as according to the list given below.

Page 2: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

FYP Thesis/Report Contents Copyright Dedication Acknowledgement Declaration of Authentication: All students are required to sign the report submission

declaration form to confirm that FYP report has been done without any plagiarism

Abstract Table of contents List of tables List of Figures Chapters

1. IntroductionThis chapter should explain the purpose of the project

i) The purposeii) The problem iii) The solution

2. Literature Review (Research contribution)3. Requirements

i) Stakeholdersii) Functional and non-Functional Requirementsiii) Feasibilityiv) Project Schedule

4. Methodology And Designi) Logical/Physical modelingii) Diagrams (use- cases, context, ERD etc)iii) GUI

5. Implementation (Component s development and integration) 6. Testing7. Evaluation: This chapter should describe system operation and output evaluation on the

basis of testing.8. Conclusion9. Future work10. References11. Appendices: It is highly appreciated if an overall Feasibility report will be added as the first

Appendix.

Page 3: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

Title Of the FYP(18 to 22 font size)

By

Name (Registration #)Name (Registration #)Name (Registration #)

Supervised by

(Give supervisor name)

Bahria University (Karachi Campus)

Year

FINAL YAER PROJECT REPORT

Page 4: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

TITLE OF THE PROJECT

BY

Name Registration #Name Registration #Name Registration #Name Registration #

Submitted to: Supervisor Name

In fulfillment of the requirement for the degree of

BS (Computer Science)

DEPARTMENT OF APPLIED SCIENCES & GRADUATE STUDIES

BAHRIA UNIVERSITY

2012

Page 5: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

DECLARATION OF AUTHENTICATION

Title of Report

Project Supervisor’s Name

We certify that the project presented in this report is to the best of our knowledge our own. All sources used and any help received in the preparation of this dissertation have been acknowledged. We hereby declare that non of us have submitted this material, either in whole or in part, for any other degree at this or any other institution.

Name and Signatures of students Date

(1)…………………………….. ……………………..

(2)……………………………. …………………….

(3)…………………………….. …………………….

Name and Signature of Supervisor Date

…………………………. ……………………….

Page 6: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

Acknowledgments

This page should consist of the acknowledgements to the people, companies and institutions that have been helpful to the author in compiling the reports. It is normal practice to thank the Head of Institute for the use of facilities with which the project was carried out, the supervisor for his/her suggestions and guidance and any other member of the academic and technical support staff who have made a significant contribution to the success of the project.

Page 7: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

Abstract

The abstract is a brief summary of your research. Typically, an abstract should be one page and/or less than 350 words. Your abstract should consist of concise precise to inform the reader of the content of the report, what the project was about, the main aim of the project, how the work was undertaken and major conclusions drawn from the work performed. It is important not to confuse an abstract with introduction. The first sentence should give the subject of the report and the last sentence should state the primary conclusion of the report. The abstract should be written in the present tense. It should not include illustrative material such as formula, diagrams, and charts. The abstract page numbered ii. It should conclude with short entry ‘Keywords’ …..Nominating several keywords by which a computerized library would find the project.

Page 8: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

Table of contents

The table of the contents is on a separate page and is numbered iii. The table of contents lists the sections of the report, a list of figures and a list of tables along with the page on which they begin.

1. INTRODUCTION....................................................................................................... 10

1.1 Purpose1.2 Problem1.3 Solution

2. BACKGROUND AND LITERATURE REVIEW .............................................. 11

3. REQUIREMENTS.................................................................................................. 12

3.1 Stakeholders3.2 Functional/Non Functional requirements3.3 Scheduling3.4 Costing

4. METHODOLOGY AND DESIGN ....................................................................... 13

4.1 Logical/Physical modeling4.2 Diagrams (use- cases, context, ERD etc)4.3 GUI

5. IMPLEMENTATION ............................................................................................ 14

6. TESTING................................................................................................................. 15

7. EVALUATION ........................................ ERROR! BOOKMARK NOT DEFINED.

8 CONCLUSIONS ..................................................................................................... 17

9. FUTURE WORK.................................................................................................... 18

10. APPENDICES......................................................................................................... 19

11. GENERAL GUIDELINES..................................................................................... 20

11.1 TYPING AND SIZE OF PAPER................................................................................ 2011.2 PAGE NUMBER AND SECTION NUMBER............................................................... 2011.3 MARGIN BOUNDARIES........................................................................................ 2111.4 DIAGRAMS AND FIGURES ................................................................................... 2111.5 PHOTOCOPYING ................................................................................................. 2111.6 FIXING OF PHOTOGRAPH .................................................................................... 2211.7 TABLES .............................................................................................................. 2211.8 EQUATIONS........................................................................................................ 22

Page 9: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

11.9 UNITS................................................................................................................. 2211.10 REFERENCES .................................................................................................. 23

11.10.1 List of References.................................................................................. 2311.10.2 Journal Articles..................................................................................... 2311.10.3 Conference Paper ................................................................................. 2411.10.4 Books..................................................................................................... 2411.10.5 Manuals................................................................................................. 2411.10.6 Unpublished Reports and Theses.......................................................... 2411.10.7 Web Based............................................................................................. 24

Page 10: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

1. Introduction

This should introduce the reader to the subject are described in the report, what the project was about and why it was undertaken. It should be written in a manner sufficient to allow a reader unfamiliar with the project to appreciate any background knowledge necessary to understand the report.

Defines and limits the ‘Scope’ of the effort. Clearly describe how you tackled the problem.

Describe the function, show the block diagram, and give the performance specifications as they appear in your final proposal. Show that you know what variables are important in your project’s performance, and what values they should take on. Describe briefly the subprojects into which the project has been divided. Introduce the structure of the report (what you will cover in which chapter).

To describe the precise detail bout your project, divide your chapter into sub headings. The first heading Purpose should give a brief summary of the usage of your project. The need in industry that makes you to work on this problem, you have to mention in the heading Problem. You also need to give a brief discussion about how you identify this problem. The Solution you have designed for the problem will be given under the subheading Solution.

Page 11: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

2. Background and Literature Review

This section should describe the current state of knowledge concerning the subject involved in the project. It should review literature on the subject and highlight the information relevant to the immediate activity undertaken in the project. The survey should cover a sufficient amount of available literature to highlight the gaps in current knowledge and to support and allow predictions to be made regarding main work covered in the project. Try to include related work (if you know). Where literature source are quoted, these should be accompanied by the author/s surname and year of publication within parentheses referring to the “Reference” section of the report.

Page 12: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

3. Requirements

All the requirements should be clearly stated such as Functional and Non-functionalrequirements.

Stakeholders/Possible customers of the project should be mentioned if possible. As the project should be live therefore you have to mention the organization for which the project is to be constructed or the customers of your project.

If your project is hardware based then you have to provide the detail of the hardware along with the total cost.

Timeline charts are the essential part of the documentation. PERT and GANTT charts should be made with the actual time division. You can also employ Critical Path Method to show the various critical situations for your project and /or the possible deliverables according to the schedule given in the time charts.

Clearly describe how you tackled the problem. Provide enough information for knowledgeable person where difficulty or lack of time has caused a change in the aims of the project. The nature of any changes and the reasons for these changes should be explicitly stated within this section.

A Feasibility report should be the integral part of this chapter to show the feasibility analysis of all phases where it has been done according to the requirement.

Page 13: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

4. Methodology and Design

You are required to describe

i. Requirement analysis techniques.

ii. Comparison of different choices for algorithms and data structures.

iii. Overall system structure.

iv. Data Normalization.

Give all relevant diagrams that you have used to develop the logical design of the project as well as the components helping you to build the physical design.

Context diagram, Data flow, actor-usecase diagram, entity relation, and object diagrams as appropriate.

Use your project logbook (file) to remind you of what decisions you took, and why you thought at the time they were good. Later, in the evolution, you can criticize them.

At this stage you are required to depict the possible Graphical User Interface of your Project. Mention forms, data fields and validation checks.

Page 14: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

5. Implementation

Give code details (not a complete listing, but description of key parts). Discuss the most important/interesting aspects. It probably won’t be possible to discuss everything- give a rationale for what you do discuss. Code shall be written following the standard such as Naming Conventions.

Page 15: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

6. Testing

Test plan – how the program/system was verified. Put the actual test results in the Appendix.

Page 16: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

7. Evaluation

This section should fully and logically discuss the progression of the project including the methods used and the results of experimentation, or the design; in such a way that examiner can evaluate the worth of the project. The discussion should be backed by detailed reference to material in the testing and result section of the report.

Page 17: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

8. Conclusions

This section should be a concise statement of the conclusions which may be drawn from the work attempted. The reader needs to be convinced that the design will work. If

Uncertainties remain, they should be pointed out, and alternatives, such as modifying performance specifications, should be spelled out to deal with foreseeable outcome.

Page 18: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

9. Future work

This section may be used to propose further work which may be carried out on the project in subsequent study projects. Suggestions of this type should be limited to proposals which involve significant amounts of work such as major modifications of equipment or development of student practical experiments. Any suggestion is to be given in sufficient detail to provide adequate information for a future student to be able to fully appraise the proposal.

Page 19: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

10. Appendices

These shall be used to give detailed results that shall be summarized in main text. The normal practice is “Annex A, B, C…” and, when required, “Appendix (to annex) 1, 2, 3…..” They should identify on every page by running header. Following items should be included in appendices

Page 20: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

11. General Guidelines

- Begin each chapter on new page.

- Each chapter should have small introduction at beginning of chapter. Introduction must link to previous chapter. It is a one or more then one paragraph but not more than one page that introduces the reader to the subject. The introduction presents basic background material, the history of the problem and contains the key sentence outlining the subjects to be discussed.

The total report length should under no circumstances exceed 150 pages; most projects somewhat shorter. There is no value in trying to artificially lengthen your project by ‘padding’ it. Each project is unique and has its own natural length, and you will probably know when you have said everything that you need to be said.

11.1 Typing and size of paper

I. The report is to be typewritten on one side of the paper on international size A4 paper (297mmX210mm). This paper must be good quality bond.

ii. Reports length should be 80-150 pages.

iii. Use Times New Roman, size 12 font throughout the reports.

Use 1.5 or double spacing.

11.2 Page number and Section number

- Use lower case Roman numerals for preliminary pages

I. Title page (not numbered on page)

ii. Abstract

Table of Contents

The text of the report begins with Arabic number 1. Number all pages. Page numbers can be inserted either at the bottom/top right or the bottom/top center.

All appendices should number as A-1, A-2, etc. for pages under appendix A, and B-1, B-2, etc. for pages under appendix B (See Table of Contents.).

Page 21: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

A hierarchical numbering scheme for chapter numbering shall be used. For instance, use 1 for chapter one, 2 for chapter 2, 1.1 for the subsection 1 of chapter 1, etc. (See the Table of Contents).

11.3 Margin boundaries

I. 1 -inch left margin.

ii. 0.5-inch margin on the other three sides.

11.4 Diagrams and figures

Figures and table should be inserted in the text in one of the three places

A full page diagram or illustration must be inserted on the left hand side facing the typescript which described it.

Small diagrams should be incorporated in the text with the legend appearing below (not recommended).

Each graph, diagram, etc., should have a figure number and title typed below it. The type style should be same as the text. Figures should be numbered consecutively (Fig.1, Fig. 2) or by chapters (Fig. 1.1, Fig 1.2, Fig. 2.1, etc). Whichever numbering system you use,make sure that you follow the same system for tables and equations.

Line drawings, graphs, and monograms should be in bold clear lines. Where graphs, diagrams and figures cannot be mounted vertically on the page these are to be mounted and labeled in such a way that they can be read from the right hand side(900 on the page) of the page .

All the axes of graphs are to be labeled with the parameter and its units. Information on illustrations and graphs such as labels, scales etc. must be typewritten.

11.5 Photocopying

Page 22: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

All the diagrams, etc. must be reproduced by an electronic or electrostatic or photographic method which is known not to fade.

11.6 Fixing of photograph

Full page photographs should be bound into the report. Small photographs must be firmly fixed to the paper. An alternative is to use color photocopying or digital processing.

11.7 Tables

Each table should be numbered consecutively (Table 1, Table 2) or by chapter (Table 1.1, Table 1.2, Table 2.1).Table number should be centre above the top of the table and be followed on the next line by a brief descriptive caption, preferably in cap. The type should be the same as the text. Refer to each table in text by number “In Table 1, one can clearly see………”The same rules for location of figures apply to tables.

TABLE 1. MEASURED RESISTOR VALUES AND THE METER ERROR

Nominal Value Marked Measured Value Error (%)

11.8 Equations

Centre each equation on separate line. Number equations consecutively in parentheses at the right margin. Equation may be referenced by number in the text, using parentheses around the number.

Y (t) = sin (x) dx (1)

11.9 Units

Page 23: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

The S.I. system of units is to be used throughout. Where difficulties are introduced by quotation of imperial units from reference source, these should be accompanied by the appropriate conversion to S.I. units in parentheses.

11.10 References

The references must list all published information sources that are directly quoted or used to support the technical discussion or equations. Reference to these sources must be made at the appropriate points within the report text. Use numbers enclosed in brackets in the text [1]. Each reference is preceded by a bracketed number in the list of reference. Reference number in the text should look as follows

[1] “User-friendly Support Environment for Requirement Analysis In User Interface Design”, Seongjun Yun, Minseok Pang, Hongjin Cho, Jongho Chae, Yoonjung Choi, Eun-Seok Lee

[1]

[3], [4]

[5]- [7]

These are all to be on the line and within punctuation marks. Example for textual referencing.

Maxwell [1] states that………

Reference should be cited as follows

11.10.1 List of References

References should be ordered alphabetically according to the surname of the first author (use the editor’s name or the organization’s name when the author’s name is absent). A list of references is the last section of each chapter.

11.10.2 Journal Articles

Page 24: FYP Report Template

Title of project

Revised by Project Coordinator (Asia Samreen)Applied Sciences & Graduate Studies Department

R. A. Barry and P. A. Humblet, “Models of blocking probability in all-optical networks with and without wavelength changers,” IEEE JSAC/SAC/LT Special issue on Optical Networks, 14(5) pp 858-867, June 1996.

11.10.3 Conference Paper

Gouda, M.G. and Dayal, U. (1971). Optimal semi-join schedules for query processing in local

Distributed database systems. In Proceedings of ACM SIGMOD International Conference on

The Management of Data, (Ann Arbor, Michigan, April 29 – May 1, 1980.) ACM, New York, 1981, pp. 164 – 165.

11.10.4 Books

Papoulis, Probability, Random Variables, and Stochastic Processes. McGraw-Hill, New York, 1984

11.10.5 Manuals

IBM. (1984). Information Systems Planning Guide. Fourth Edition, July 1984. SPSS Inc. (1983). SPSS-X User’s Guide. McGraw Hill Book Company, New York, 1983.

11.10.6 Unpublished Reports and Theses

Thorpe, A. (1982). Stability tests on a tender-price prediction model. M.Sc. Thesis, Loughborough University of Technology, UK. 1982.

11.10.7 Web Based

http//www.westwords.com/guffey/apa.html, “introduction of information technology”, West world technologies , last visited on 12 November 2008.