Updted Project Writing Guidelines
Updted Project Writing Guidelines
Updted Project Writing Guidelines
DEPARTMENT
OF
COMPUTER SCIENCE
AN APPROACH
TO
PRACTICAL PROJECT REPORT WRITING
(2022)
1
INTRODUCTION
A final year research project is the culmination of student’s academic national
diploma (ND) or higher national diploma (HND) programme. The main purpose of
preparing final year research project is to encourage graduating students to apply the
knowledge acquired during their studies and allows them to work on substantial
problems for an extended period of time and shows how proficient they are in solving
real world problems. It also affords them a sound opportunity to demonstrate their
competence as professionals and to apply what they have learnt in the other
components of their programme.
Besides, graduating students get a chance to improve their technical and
communication skills by integrating writing, presentation and team-work. Moreover,
student research project provides an integrated assessment of the students’ progress
toward the training they go through during their academic tenure at the Polytechnic.
This manual is organized in three major sections; while section one addresses general
considerations, section two presents the specific requirements of the academic
programmes offered at Department of computer science, School of Technology Kano
(SOT), Kano State Polytechnic and Section three describe the structural component of
the project report.
SECTION ONE
1.1 Components of a Project Report
A project report is made up of three major parts:
The Preliminaries section
The main body (text) section
The reference sections
The following is a general outlay of a research project report.
2
Preliminaries Cover Page, Title Page, Declaration, Approval Page,
Dedication Page, Acknowledgements Page, Abstract, Table of
Contents, List Of Tables and List Of Figures
Chapter One Introduction, Background to the study, Statement of the
problem, Motivation for the study, Objectives of the study,
Purpose of the study, Scope of the study, Significance of the
study, Project’s organization and Definition of terms.
Chapter Two Introduction, Review of related literature (an analysis of
previous research works) and theoretical framework.
Chapter Three Methodology, Choice of programming language, Requirement
Analysis modeling, Data and process modeling, Design
consideration (User interface design, data design and system
design), Design architecture/conceptual design, and detail
design of the proposed system.
Chapter Four System hardware requirement, System software Requirement,
Data Source (method of data collection), Implementation
procedure, Sample implementation input snapshot, Sample
implementation output snapshot, Evaluation of Results
(Graphically or analytically) and Discussion of Results.
Chapter Five Summary of Findings, Conclusion, Limitation of the study,
Recommendations and Contribution(s) to knowledge,
Reference Section Literature cited
3
Sources of project topic ideas may include the following:
Topic suggested by Academic Advisers or Supervisors
Topic obtained from lectures, seminars, conferences, workshops etc.
Topic obtained from books and journal articles (local and foreign)
Topic from identified current problems existing in any environment,
society or institution
Topic from areas of future studies as recommended in previous
projects
1.10 Margins:
Page margins shall be: 4cm left, 2.5cm right, 2.5cm top and 2.5cm bottom. The
bottom margin may measure more 2.5cm to avoid “windows” and “Orphans”
4
(These are incomplete lines, as those beginning or ending a paragraph, carried
over to the top of a page). The Researcher may avoid them by either rewriting
copy to eliminate the line or fill it out, or may make the bottom margin deeper,
moving the line to the next page.
1.11 Line Spacing:
All standard texts shall be double-spaced. Quotations of four lines or longer shall
be single – spaced with the left and right margins indented on each side.
References, bibliographic works, and endnotes, shall be single – spaced and
double spaced between entries.
1.12 Headings:
Chapter headings and subheadings shall be consistent throughout the research
project. If the Researcher uses all caps and centre the chapter heading for the
first chapter, be sure to use that format throughout the project. Also, there shall
be a minimum of three lines of space between the chapter heading and the start
of the first paragraph.
5
1.14 Corrections:
No forms of correction fluid or hand-written corrections are to be used.
Double - space between the title and the first entry, and between entries. Indent
the first line of an entry five spaces, and flush left each successive line.
List entries in alphabetical order according to authors last names. For unknown
authors, list in alphabetical order according to the word of the title (exclude A,
6
An, The). If there is no author or editor, place the title in the author position.
Alphabetize by the first significant word in the title. In text, a short title (or the
full title if it is short) should be used for the parenthetical citation.
Group authors should be alphabetized by the first significant word of the name.
When the author and publisher are identical, use the word “Author” as the name
of the publisher.
Separate author, title, and publication information with a period followed by one
space.
If the list is more than one page long, do not repeat the reference title, but
continue the page number in sequence.
1.15.1 Placing and punctuating the Parenthetical Reference:
The American Psychological Association (APA) recommends placing the
parenthetical reference at the end of the sentence, before the final period. On
some occasions, the reference can be placed within the sentence to clarify its
relationship to the part of the sentence it documents.
When the reference documents a long quotation that is set off from the text,
place it at the end of the passage after the final period.
Join the names in a multiple-author citation in running text by the word “and”. In
parenthetical material, in tables and captions, and in the reference list, join the
names by an ampersand “&”
7
SECTION TWO
SPECIFIC GUIDELINES FOR PROJECT WRITING IN THE
DEPARTMENT OF COMPUTER SCIENCE.
2.1 Project layout
PRELIMINARIES:
i. Cover Page
ii. Title Page
iii. Declaration
iv. Approval Page
v. Dedication Page
vi. Acknowledgements Page
vii. Abstract
viii. Table Of Contents
ix. List Of Tables
x. List Of Figures
8
3.2. Choice of programming language
3.3. Requirement Analysis modeling
3.4. Data and process modeling
3.5. Design consideration (User interface design, data design and system design)
3.6. Design architecture/conceptual design, and detail design of the proposed
system.
9
BY
STUDENT’S NAME
STUDENT’S REGISTRATION NUMBER
BY
STUDENT’S NAME
STUDENT’S REGISTRATION NUMBER
10
MONTH, YEAR (EG. AUGUST, 2018).
…………………………………………………………………………………………
……
2.2.3 Declaration
DECLARATION
I, …………………., hereby declare that this project essay and the practical project
titled: ……………………….. is an original project carried out by me in the
Department of Computer science under the supervision of Mr. …………………….
All references made to author’s works by me have been duly acknowledged.
Student name…………………………………….
------------------------------------
September 2019.
…………………………………………………………………………………………
……
2.2.4 Approval/certification Page
We the undersigned certify that this project was carried out by ………………….. with
matriculation number ………………… in the Department of Computer science,
School of technology Kano, Kano State Polytechnic.
……………………………………….. -------------------------------
PROJECT SUPERVISOR Date/signature
………………………... ---------------------------------
PROJECT COORDINATOR Date/signature
……………………….. ---------------------------------
HEAD OF DEPARTMENT Date/signature.
11
…………………………………………………………………………………………
……
2.2.5 Dedication Page
This project is dedicated to ------------------------------------------------------
…………………………………………………………………………………………
……
2.2.6 Acknowledgements Page
Acknowledgment should be arranged in this order:
1. Acknowledge God
2. Acknowledge supervisor
3. Acknowledge HOD
4. Acknowledge lecturers
5. Acknowledge student’s relatives
6. Acknowledge student’s friends
2.2.7 Abstract
An abstract should contain the following ingredients
1. Introduction
2. Statement of the problem
3. Objectives (you can state the major) objective or you outline them in specific
form
4. Results/findings
5. Major concluding remark
Note below
- No paragraph
- Single line spacing
- Italics
- Written in past tense
Written below, is a typical example of an abstract that satisfy the above conditions:
12
ABSTRACT
Social tagging systems are web-based sites that store user’s keywords called tags,
which continue to receive significant consideration in academic environment, due to
increasing acceptance of Web2.0 and growth in the number of users using social
tagging. , tagging systems give good support for users to tag resources and
communicate with, as well as recommend friends. Friend recommendation helps users
make a choice by presenting them with the best available information., this however
comes with associated problems like tag ambiguities and information overloading., to
address these issues, this work proposes a friend recommendation system based on
Ant Colony and FP-growth algorithms. The technique first applies the FP-Growth
algorithm to find the frequent activity sets among users and then construct the
combined trust graphs., after which the Ant Colony Optimization algorithm is finally
applied., It combines those trust graphs to calculate the optimal friend recommended
through iterations., Experimental results on a delicious dataset signify an
improvement in precision in the range 0.1% to 1.1%; recall in the range 21.85% to
50.84%; and F1 in the range 31.31% to 50.85% approximately., this shows a
significant improvement compared to the other approach. The future direction is to
use different data mining algorithms, large scale datasets and community detection
for friend recommendation in social tagging systems. We have described a new
recommendation process using FP-Growth Algorithm through which we achieved
good results and a strong recommendation.
…………………………………………………………………………………………
……
2.2.8 Table Of Contents
Here, a researcher is advised to use an automatic page numbering generation
function when generating his/her table of content, else, he/she must to mapped
each item to its appropriate page number.
PRELIMINARIES:
i. Cover Page
ii. Title Page
iii. Declaration
iv. Approval Page
v. Dedication Page
vi. Acknowledgements Page
vii. Abstract
viii. Table Of Contents
ix. List Of Tables
13
x. List Of Figures
15
the readers need to know before diving in to the project. As such it should provide
a detailed understanding of the topic.
1.2 Statement of the problem:
It is a statement & not a description of problem, it’s constructed after a careful and
serious thought of the problem being address. i.e., statement of the problem
answers the question why the problem is being undertaken. Statement of the
problem is extremely important to be formalized at the earlier stage of the study.
1.3 Motivation for the study:
What are the justifications/reasons to undertake the effort to address the issue
(Project topic)?
1.4 Aim of the study:
This illustrates reasons and what the study will do, which should reflect the
statement of the problem
1.5 Objectives of the study:
Consider the single aim you mention in 1.4 above and break it in to a number of
sub-aims call the objectives, each containing at least a single measurable element
1.6 Scope of the study:
Clearly state the span/extent to which you limit the functionality of your project
topic.
1.7 Significance of the study:
This refers to the important of the project’s finding to the world of knowledge. i.e.,
how the final product of the study will benefit the society.
1.8 Organization of the work:
This describes the Structure or the layout of the project, i.e., it describe how the
reader or the examiner can keep track of the progress or workflow of your work.
2.4 CHAPTER 2
REVIEW OF RELATED WORKS
16
The single aim of this chapter is to identify A POTENTIAL RESEARCHABLE
PROBLEM by reviewing the past works, and can be accomplish by decomposing the
aim in to the following important objectives;
• To clarify important concepts related to the project
• To report to the readers/examiners on how the problem were identified/found
(i.e., is it from literature or experiment or experience or etc.)
• To summarize the work of other researchers on the same project topic (this is
extremely impotent to reduce duplication of research)
• To report to the readers/examiners on how the investigation was conducted to
established the research problem.
At this stage, a student should review previous works on the topic. He/she may
provide the historical background on the core issues of discourse and provide current
pertinent ideas from credible sources. The layout of this chapter should be such that
the issues raised by the project title are adequately addressed. These should relate to
both theory and practice. Information may be sourced from but not limited to; text
books, e-library, journals articles, newspapers, exhibition catalogues, reports,
government documents, conference proceedings, public discussion and video.
This chapter should be concluded by clearly identifying or establishing the research
gaps from the literature which the current study will address in the research.
2.1 Introduction
Describe the work flow and progress format of the chapter
17
This report on how the ideas employed to solve the problem is modelled
and experimented, this includes the tools used, the processes and the
data generation process. As such, the objectives of this section are;
• To explain the choosing solution employed to address the problem
• Modelling (Designing the methodology with help of diagram or
representation)
• Describe what and how data was collected (experiment, survey,
primary, secondary etc.)
3.2 Choice of programming language:
This involve examining the problem and selecting the best programming
language that can efficiently solve the problem. Moreover, good
programming and writing skills are extremely important.
3.3. Requirement Analysis modeling:
This includes a description of both functional and non-functional
requirement and a model (a model is a representation of idea(s). It can
be represented mathematically (mathematical model) graphically
(graphical model) or else, as long as the model can clearly explain the
idea).
This involve designing the methodology with help of diagram or
representation such as flowchart, use-case diagram, activity diagram,
entity relation diagram, process diagram Algorithms, Pseudo-codes,
Mnemonics, symbolsetc.
3.4. Data process modeling:
Depending on the problem address, this is a process of creating a visual
representation for an information system to facilitate connection
between data points and structure by applying certain formal techniques
such as hierarchical data model, network data model, relational data
model, entity relationship data model or object-oriented data model. The
goal here is to illustrate the type of data to be used and the relationship
among these data types, i.e., the way the data can be grouped, organized,
including its format and attributes.
18
3.5. Design consideration:
This involves;
User interface design, also known as the front end the system
Data base design also known as the back end of the system
system design also known as integration, this is the process of
designing the architecture, components and interfaces for a
system so that it meets the end user requirement.
2.6 CHAPTER FOUR:
IMPLEMENTATION/RESULT EVALUATION
The main aim of this chapter is to describe the implementation processes, analysis and
justify the result by Putting deference or arguments to support the claim made.
4.0 Introduction
Describe the work flow and progress format of the chapter
4.1. System hardware requirement:
This refers to the specification of the hard ware component that the
implemented project will require for it proper and smooth operation, this might
involve specification for CPU, RAM, HDD capacity, type or model of the
machine to be used, other hard ware component (in the case of hardware
project) etc.
4.2. System software Requirement:
This deals with defining the resource specification that need to be installed on
the computer to provide an optimal functioning of the proposed project or
application. These include but not limited to the system platform, operating
system, application drivers and web browsers.
4.3. Data Source and Means
This involves a description on:
The data origin, (where you obtain the data),
Nature, size, and the type of the data (Primary or Secondary data type)
Method of data collection, (Survey, Interview, Observation,
Questionnaire, social media, online tracking, etc.)
19
4.4. Implementation procedure
This refers to the process involve when installing a new software ready for use.
These include; planning, process design, installation, configuration and
customization, system migration, testing and training,
4.5. Sample implementation input snapshot (screenshot):
Providing a pictorial snapshot or screenshot of the required input to the system
(i.e., screenshot of the input system interfaces)
4.6. Sample implementation output snapshot (screenshot)
4.7. Providing a pictorial snapshot or screenshot of the final expected output of the
system, (i.e., screenshot of the output system interfaces)
4.8. Evaluation of Results (for the research project)
These involve the following:
Reporting the results obtained from the Data gathering phase and how
the data was validated
Discussing the results of the end process (the final output of the system)
Interpreting the result (explaining and arguing the meaning of the final
output of the system)
Explain the meaning of the graph and tables if any.
20
5.2. Conclusion
Conclude the project work by stating whether it achieves the objectives or
otherwise justify. Here, you are to comment on the strength and weaknesses of
the research work
5.3. Recommendations
The objective here is to propose future direction(s) of the research project for
future researchers
5.4. Contribution(s) to knowledge:
Clearly, highlight the contributions made by your project to the world of
knowledge.
SECTION THREE
STRUCTURAL COMPONENT OF THE PROJECT REPORT.
Note:
21
‘Clear’ means not ambiguous, ‘Concise’ means compact and right word, ‘Coherence’
means interrelated between sentences, paragraph sub-sections, sections and chapters
as a unit.
Each chapter is written with certain objectives. These objectives have double-
fold functions.
1. First, it serves as a guidance in writing the body of chapters.
2. Second, it is also used by the examiners to evaluate the chapter.
It is highly recommended to write statement of objective for the chapters in
their introduction. i.e., introduction of each chapter solely contains the flow of
its objectives)
Objective must be clearly written and followed by description of how the
objectives were achieved
3.3 Component of a chapter
All chapters of a project most contain three components namely:
Introduction
Summary of the chapter contents. It includes a statement of objective of the
chapter. It helps the readers (examiners) to understand the flow of the sections
in the Body.
Body
Refers to the materials of the chapter. This can be sections and sub-sections.
Body explains the points for achieving the objectives.
Conclusion
22
Evaluation on the chapter’s objective achievement and is NOT a summary as it
has always been misunderstood.
23
Like a chapter, section also comprises of three main components namely;
introduction, body and conclusion. The first paragraph of section introduces the
readers (examiners) with work presented in a section. i.e., it elaborates the objective
and the significance of a section.
An example of introduction to section is as follows:
“This section presents the methodology of data collection. We used
two methods to collect data from experiments – method 1 and method 2.
We provide the description of each method and illustration of data collection
process flow in this section. We also present ...”
Body of a section
A body of a content contains the actual contents of the section. Body starts from
second paragraph of the section. It may contain tables, figures and their narrations in
the form of sub-sections and paragraphs. Last paragraph of the section concludes the
section.
Conclusion provides insight and presents the findings of section. Following is the
example of conclusion of the section:
24
“We presented the data collection methodology in this section. These
methods are widespread to collect consistent data due to their robustness in our field
of research. Therefore ...”
This unit of writing refers to division of section. Sub-sections have the same structure
as a section. However, the parts in a sub-section are smaller than in a section. i.e.,
Subsection starts with the introduction to sub-section.
First paragraph, after introduction, continues with the body.As a body, sub-sections
provide definition and explanation of targeted entities/concepts. For example;
Last sentences in last paragraph of the sub-section are the conclusion of the subsection
as shown in following example:
3.5 Paragraph
Paragraph is a division of sub-section and normally it describes a main point. It
contains paragraph title and description of the title followed by evaluation.
The title sentence presents the concept or entity emphasized in a paragraph. It is
followed by few sentences to explain the title of the paragraph. In the end, paragraph
must have evaluation of the explanation.
It is a good practice to write only one main point in a paragraph, to avoid confusion
over several points in a paragraph and to achieve clear flow of the points.
25
3.5.1 Title:
“Method1 has three drawbacks- drawback1, drawback2 anddrawback3.”
3.5.2 Explanation:
“Method1 adopts procedure1 to improve the performance ofparameter1. However,
procedure1 incurs cost1 and results indrawback1 ...”
3.5.3 Evaluation:
“Therefore, method1 is not suitable with scenario1 and requiresscenario2 for its
effectiveness”
3.6 Conclusion
A good Project report is beautifully structured and able to help the examiners to
follow and understand the flow.
Appearance of a project report can influence the examiner’s perception on the quality
of the work and generously award the marks.
3.7 Recap
An academic Project is a research undertaken to address an issue(s). This means
the finding must be highly reliable and trusted. Evidence should be provided to
26
References
A. Hevner, S. Chatterjee, “Design Research in Information Systems”,
Integrated Series 9 in Information Systems 22, DOI 10.1007/978-1-4419-5653-
8_2, Springer Science+Business Media, LLC 2010.
27
28
29