0% found this document useful (0 votes)
127 views23 pages

Project Documentation-1

The document provides guidelines for undergraduate research project documentation in the Department of Computer Science at Nnamdi Azikiwe University. It outlines the required preliminary pages, table of contents, and typical chapter structures. The preliminary pages include a cover page, title page, certification, approval, dedication, acknowledgements, and abstract. Typical chapter structures include introductions, literature reviews, methodology, system design and implementation, summary and conclusions. The document aims to standardize project documentation formatting and content for undergraduate students in the department.

Uploaded by

Nugwa Solomon
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
127 views23 pages

Project Documentation-1

The document provides guidelines for undergraduate research project documentation in the Department of Computer Science at Nnamdi Azikiwe University. It outlines the required preliminary pages, table of contents, and typical chapter structures. The preliminary pages include a cover page, title page, certification, approval, dedication, acknowledgements, and abstract. Typical chapter structures include introductions, literature reviews, methodology, system design and implementation, summary and conclusions. The document aims to standardize project documentation formatting and content for undergraduate students in the department.

Uploaded by

Nugwa Solomon
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 23

NNAMDI AZIKIWE UNIVERSITY, AWKA

DEPARTMENT OF COMPUTER SCIENCE

The Nitty-Gritty (Important Aspect) of


Undergraduate Research (Project)
Documentation
For
Department of Computer Science
By

M.O. Onyesolu

July 6th, 2023.


Project Documentation
Department of Computer Science
Presentation Outline
a. Introduction
b. Table of Contents
c. Preliminary Pages
d. Chapters Contents
(Chapter One to Chapter Five)
e. References
f. Appendices
Introduction

Research (undergraduate, postgraduate) is the


exploration of a specific topic within a field by a
student that makes an original contribution to the
discipline (Loyola Marymount University, 2021).

a) . . . exploration
 examination
 survey
 search
 investigation
 study
 assessment

b) . . . original contribution
Introduction . . Contd.
OUTLINE
Science and Engineering
1. Introduction
2. Literature Review
3. Materials and Methods
4. Results and Discussion
5. Summary, Conclusion and Recommendation
6. References

Computer Science
1. Introduction
2. Literature Review
3. Methodology and System Analysis
4. System Design and Implementation
5. Summary, Conclusion and Recommendation
6. References
Table of Contents
TABLE OF CONTENTS
COVER i
TITLE PAGE ii
CERTIFICATION iii
APPROVAL iv
DEDICATION v
ACKNOWLEDGEMENTS vi
ABSTRACT vii
TABLE OF CONTENTS **
LIST OF TABLES **
LIST OF FIGURES **
LIST OF PLATES **
Plates are pictures which so many confuse as figures

CHAPTER ONE: INTRODUCTION 1


1.1 Background of the Study 1
1.2 Statement of the Problem 2
1.3 Aim and Objectives of the Study 2
1.4 Significance of the Study 3
1.5 Scope of the Study 3
1.6 Limitations of the Study 3
1.7 Definition of Terms 4
Table of Contents . . contd.

CHAPTER TWO: LITERATURE REVIEW **


2.1 Conceptual Review **
Choose subsections/subtitles to suit the project/work in this section).

2.2 Review of Related Works **


The student is expected to review works (mostly journals) by other authors
related to the work/project/topic of discourse (at least twenty (20) works or
more)

2.3 Summary of Review and Knowledge Gap **


A summary of literature review and knowledge gap to show how the work is
different from the others reviewed in Section 2.2
Table of Contents . . contd.
CHAPTER THREE: METHODOLOGY AND SYSTEM ANALYSIS
(For a Project WITH a Case Study)
3.1 Methodology Adopted **
3.2 The Organization and Its Environment . . get the name of the case study,
describe it showing the location.
3.3 Organizational Structure (of the case study . . with organogram well
annotated)
3.4 Analysis of the Existing System
3.4.1 Data Flow of the Existing System
3.4.2 Weaknesses of the Existing System
3.5 Analysis of the Proposed System
3.5.1 Advantages of the Proposed System
3.6 High Level Model of the Proposed System

(For a Project WITHOUT a Case Study)


3.1 Methodology Adopted
3.2 Analysis of the Existing System
3.2.1 Data Flow of the Existing System
3.2.2 Weaknesses of the Existing System
3.3 Analysis of the Proposed System
3.3.1 Advantages of the Proposed System
3.4 High Level Model of the Proposed System
Table of Contents . . contd.
Chapter Three is the most important section that differentiates
one work/project from another.

Articulate all the materials/methods/tools/techniques used in


achieving the objectives and the aim theoretically.
There must be at least two methods/methodologies. One used
theoretically and the other used in the software design. Some
works have more.

The type of system will determine the type of software


methodology in the software design (IoT, OOHDM, SHDM,
OOADM, SSADM, Agile, etc.) employed. Each of these
methodologies has accompanied components. For example, for
OOADM, some of the components are - Data Flow Diagram
(DFD), use case diagram. Interaction diagram, sequence diagram,
activity diagram, collaboration diagram, package diagram etc.-
these should conceptualized and presented to depict some processes
in the system developed.
Table of Contents . . contd.
CHAPTER FOUR: SYSTEM DESIGN AND IMPLEMENTATION
Note: Choose the sections that are applicable to your work.
4.1 Objectives of the Design (security, modularity, extensibility, etc.)
4.2 Control Centre/Main Menu
4.3 The Submenus/Subsystems
4.4 System Specifications (Choose specifications that are applicable to the work)
4.4.1 Database Development Tool (if any)
4.4.2 Database Design and Structure (if any)
4.4.3 Math Specification (if any)
4.4.4 Program Module Specification (if any)
4.4.5 Input/Output Format
4.4.6 Algorithm
4.4.7 Data Dictionary
4.5 System Flowchart (If any)
4.6 System Implementation
4.6.1 Proposed System Requirements
4.6.1.1 Hardware Requirements
4.6.1.2 Software Requirements
4.6.2 Program Development
4.6.2.1 Choice of Programming Environment
4.6.3 Training
4.6.4 Documentation
4.6.5 System Conversion
4.6.5.1 Changeover Procedures
4.6.5.1 Recommended Procedure
Table of Contents . . contd.

CHAPTER FIVE: SUMMARY, CONCLUSION AND


RECOMMENDATION

5.1 Summary
5.2 Conclusion
5.3 Recommendation
5.3.1 Application Areas
5.3.2 Suggestion for Further Research
5.4 Contribution to Knowledge

REFERENCES

Appendix A: Program Listings


Appendix B: Sample Outputs
Appendix C: Questionnaire (Where It Is Applicable)
Preliminary Pages

Preliminary pages . . . made up of the following:


• Cover Page
• Title Page
• Certification Page
• Approval Page
• Dedication
• Acknowledgements
• Abstract
• Table of Contents
• List of Tables
• List of Figures
• List of Plates

These pages are numbered in Roman numerals (i, ii, iii, iv, . . .,
xxx)
Preliminary Pages . . Cover Page
DESIGN AND IMPLEMENTATION OF A WEB-BASED
SYSTEM FOR ENGAGING TEACHERS AND PARENTS
TOWARDS STUDENTS' PERFORMANCE

BY

GODWIN EJIKEME ANIEGWU


2013516010F

DEPARTMENT OF COMPUTER SCIENCE


FACULTY OF PHYSICAL SCIENCES
NNAMDI AZIKIWE UNIVERSITY,
AWKA

JUNE, 2022
Preliminary Pages . . Title Page
DESIGN AND IMPLEMENTATION OF A WEB-BASED
SYSTEM FOR ENGAGING TEACHERS AND PARENTS
TOWARDS STUDENTS' PERFORMANCE

BY

GODWIN EJIKEME ANIEGWU


2013516010F

A PROJECT SUBMITTED TO THE DEPARTMENT OF


COMPUTER SCIENCE, FACULTY OF PHYSICAL SCIENCES,
NNAMDI AZIKIWE UNIVERSITY, AWKA IN PARTIAL
FULFILLMENT OF THE REQUIREMENTS FOR THE DEGREE
OF BACHELOR OF SCIENCE

JUNE, 2022
Preliminary Pages . . Certification

CERTIFICATION

I, OLUWATOYIN MARY YEROKUN with registration number


2016517002P hereby certify that I am responsible for the work submitted in
this project and that this is an original work which has not been submitted to
this University or any other institution for the award of a degree or diploma.

________________________ _________________________
Signature of Candidate Date
Preliminary Pages . . Approval
APPROVAL
This project written by Oluwatoyin Mary Yerokun has been examined
and approved for the award of degree of Bachelor of Science of Nnamdi
Azikiwe University, Awka.

________________________ _________________________
Prof. M.O. Onyesolu Date
Supervisor
________________________ _________________________
Dr. I.E. Onyenwe Date
Head, Dept of Computer Science

________________________ _________________________
External Examiner Date

________________________ _________________________
Prof. E.K. Anakwuba Date
Dean, Faculty of Physical Sciences
Preliminary Pages . . Others
Dedication – A message to honour or express affection/respect to
someone or something . . . This is written on a separate page

Acknowledgements – Expressing gratitude for or appreciation of . . .


This is written on a separate page

Abstract–Summary of the entire work, usually has these components –


introduction (one sentence), motivation, aim of the study,
materials/methods/tools employed, result(s) of the work and conclusion.

Table of Contents – Listing of all the titles/subtitles in the


documentation with the corresponding pages where they appeared and
the way they appeared

List of Tables – Listing of all the tables with the corresponding pages
where they appeared.

List of Figures – Listing of all the figures with the corresponding pages
where they appeared.
Preliminary Pages . . List of Tables
LIST OF TABLES

3.1: Essential Attributes for Identification Process 75


3.2: Data Reduction 75
3.3: Input Variables, Ranges and Fuzzy Sets 82
3.2: Confusion Matrix for a Binary Classification 86
4.1: Test Data 104
4.2: Plant Distribution 105
4.3: Confusion Matrix for Test Data 107
4.4: Accuracy of Model on Different Membership Functions 108
4.5: Precision of Model on Different Membership Functions 109
4.6: Recall Rate of Model on Different Membership Functions 110

Note: The tables are/were not listed by appending the word Table as . .
Table 3.1: Essential Attributes for Identification Process 75
Table 3.2: Data Reduction 75
Preliminary Pages . . List of Figures
LIST OF FIGURES

2.1: Detailed listing of computational intelligence techniques 12


2.2: Branches of Artificial Intelligence 13
2.3: The architecture of a basic industrial robot 13
3.1: Process Flow of Agile in SDLC 66
3.2: Process Flow of the System 66
3.3: Use Case Diagram of the System 67
4.16: System Flowchart of the Neuro Fuzzy Expert System 99
4.17: Screen Shot of Test Data Conversion 103
4.18: Numeric Transformation of Input Data 104
4.19: Accuracy Plot 107

Note: The figures are/were not listed by appending the word Figure as . .
Figure 2.2 Branches of Artificial Intelligence 13
Figure 4.16 System Flowchart of the Neuro Fuzzy Expert System 99
References. . In-text
(Parenthetical and Narrative)
In-text reference where the author of the source is known…

a. …the result of this is a ‘technical super identity’ (Onyeka, 2021).

b. Ayo and Okeke (2015) found that light … (as part of a sentence)

c. …thus Ndidi (1966) refers to the modern sophistication as…

d. Onyesolu et al. (2012) developed an ATM multimodal …

In-text reference to more than one source…..

a. More recent studies (Bartlett, 1992; James, 1998) show that…

a. The researchers (Bartlett, 1992; Brown, 1876; James et al., 1998)


refer to…
References. . Listing
REFERENCES

Author, A.A. (1994). Title of work. Location: Publisher.


Rose, L. (1977). Crime and punishment. London: Batsford.
Gordon, E.W., & Rourke, A. (1966). Compensatory education for the
disadvantaged. New York: College Entrance Examination Board.

Author, A.A., & Author, B.B. (1994). Title of chapter. In A. Editor, B.


Editor, & C. Editor (Eds.), Title of book (pp. xxx-xxxx). Location:
Publisher.
Capra, F. (1983). The systems view of life. In The turning point: science,
society and the rising culture (pp. 376-399). London: Fontana Press

Author, A.A., Author, B.B., & Author, C.C. (1994). Title of article.
Title of Periodical, xx, xxx-xxxx.
Phillips, E. & Okeke, B.O. (1985). The Australian scene. Australian
Journal of Ecology, 3(2), 25-29.
References. . Listing (Contd.)
Author, A.A., Author, B.B., & Author, C.C. (2000). Title of article.
Title of Periodical, xx, xxx-xxxx. Retrieved Month day, year, from
web address
Ijeh, E.A. & Okeke, B.O. (1985). The Australian scene. Australian
Journal of Ecology, 3(2), 25-29. Retrieved June 08, 2023, from
https://www.ijkl.com/ires.php

Field, G. (2001). Rethinking reference rethought. In Revelling in


Reference: Reference and Information Services Section Symposium, 12-
14 October 2001 (pp. 59-64). Melbourne, Victoria, Australia: Australian
Library and Information Association ……Conference Proceedings

Chijioke, A.I. (2019). Design and implementation of cryptographic


model for security of e-transactions. Doctoral dissertation. Awka,
Anambra State: Nnamdi Azikiwe University.
(Published dissertation or thesis)

Nnabugwu, N.G. (2018). Design and implementation of a hybrid


database encryption model. Unpublished master’s thesis, Nnamdi
Azikiwe University, Awka, Nigeria. (unpublished dissertation or
thesis)
Appendix

Appendices

• Appendix A: Program Listings


• Appendix B: Sample Outputs
• Appendix C: Questionnaire (Where it is applicable)
Thank You

You might also like