Common Mistakes in Writing Project Report

By:COIT Final Year Project

Committee

Objectives Must be something that can be evaluated

at the end of the project. Can be further divided into two (optional):

Project objectives General objectives of the project (things to be

achieved during the project) Can be just one or two.

System objectives Features that your system/application should have.

Objectives Examples of project objectives:

To study the RSA encryption algorithm. To design the rules to be used in deciding reasonable

encryption parameters. To develop an application that can encrypt data using the

RSA encryption scheme. Examples of system objectives:

To encrypt/decrypt 128-bit data using RSA encryption algorithm.

To enable users to enter any 128-bit data. To enable users to either enter the required parameters

manually or get the system to generate them automatically.

To develop a simple and intuitive GUI. To enable the encrypted data to be saved in a file.

Objectives

Not-so-acceptable objectives: To fulfill the graduation requirement

of the BIT program at UNITEN. To save the operating cost of UNITEN. To promote chess as the game of

choice during free time. To make the process of room

assignment more efficient.

Scopes Something that limits the amount of work that

you have to do. Many students are confused about the meaning

of scopes and objectives and tend to mix up between the two.

Examples of scopes: The system is to be used by IT students at UNITEN. The scopes of the author are to manage data collection

from users and to manage stocks in the inventory. The algorithm can only operate on text files. This system only works for companies that have strict

working hours.

Methodology Most students end-up copying the

contents of Software Engineering text book into their report.

While the review of methodology theories is essential, the main part here is to explain how do you want to apply the methodology to your development process.

For example, if you choose waterfall model, then explain what do you need to do (w.r.t. to your project) in each stage of the waterfall model.

Analysis This is where you make decision on what to

implement for your project based on the literature review, surveys and interviews that you have done earlier.

Among topics normally covered in this chapter: Summarizing the survey results. Finalizing the system requirements based on

surveys/interviews done earlier. Choosing the developments tools to be used based on the

literature review done. Choosing the most suitable algorithm/method to be used.

Your are supposed to give reasons for your choices.

Design The design chapter must include a complete

description of your system in such a way that given the design to any programmer, they should be able to develop the system the way you intend it to be.

Depending on the type of project, the design is presented in different ways. Examples: MIS DFD, ERD, Use Case Diagram Algorithm implementation flowchart Multimedia storyboard

Implementation Describes the important parts of your

development. System set up (if any) Important coding

Important parts are normally what you mention in your “system objectives”.

Start by giving an overall view of your implementation, then start describing individual portions.

Testing Most students end up putting the theory

of testing. DON’T do this. Describe the testing that you have done,

and your testing result. Test whether each small component is

working. Test whether the whole system works as it is

intended to. Use your “system objectives” as a guideline

on what to test.

Results and Discussion

Summarize what you have achieved.

Refer back to your project and system objectives and verify that you have achieved each of those.

If there are objectives that cannot be achieved, describe why they cannot be achieved.