The Project Report
Your project report is an account of the work done in terms of the development of the computing
artefact. It is important that you plan the report to effectively communicate with the people
reading it. This means producing a report that your supervisor will enjoy reading. The project
report should be a well-structured word processed document that is easy to read. The project
report should be 6000 (+/- 500) words in length. The precise structure of the project report is
presented below:
Title Page
This section should contain the following centred information:
The full title of the project
The full name of the author, followed by the student registration number in brackets
The centre at which the author is studying. This should be Pentecost University
3.2 Abstract
This section should consist of a synopsis of the project (150-200 words) stating the nature and
scope of the work undertaken, and a concise summary of the outcomes.
3.3 Contents Page
This section should show the page numbers of chapters, sections and sub-sections, a list of
figures and tables, and a list of appendices.
3.4 Acknowledgements
This section is optional, but you may wish to pay tribute to particular people who have given you special
assistance or support.
CHAPTER ONE
INTRODUCTION
1.0 Introduction
This chapter provides the context of your work in terms of:
1.1 Background to the system
1.2 The design that emerged
1.3 The main aims and objectives of the project
1.4 Short overview of the remaining chapters
1
CHAPTER TWO
BACKGROUND
2.0 Literature Review
2.1 ??
2.2 ??
This chapter locates your work in the relevant academic and other literature. For example, if your
project involves designing a web site, you will need briefly to describe the main features of web
technology, and discuss its benefits in terms of information provision, efficiency gains, etc. You will need
to relate this material to the particular problem you are addressing and discuss specific alternative
solutions that might apply. This applies to any techniques, technology or tools not described elsewhere
in the report. Also, you should give overview of the method or framework used to design your system
and justify its use in your project.
CHAPTER THREE
ANALYSIS
3.0 Introduction or Overview (Choose one)
This chapter consists of the analysis specification of the proposed system in terms of:
3.1 Requirements
For example, Operational, Performance and Security Requirements. Group into functional and
non-functional requirements.
Check ISA Topic 1 for more examples
3.1.1 Functional requirement
3.1.2 Non-functional
3.2 CATWOE
3.3 Conclusion
CHAPTER FOUR
DESIGN
4.0 Introduction or Overview (Choose one)
This chapter consists of the design specification for the proposed system in terms of:
2
4.1 Structural Model
Either a detailed class diagram or detailed data flow diagrams (DFD) and entity relationship diagrams
(ERD) must be used.
Classes and the relationships between them Methods and Attributes. The classes must be modelled
using UML notation.
4.2 E.g., ERD or UML
4.3 E.g., DFD or …
4.? Conclusion
Further guidance with respect to the content of this chapter is provided in Topic 3.
CHAPTER FIVE
OTHER MATTERS
5,0 Introduction or Overview (Choose one)
This chapter provides an account of your approach to project management and evaluation. You need to
describe what particular techniques you have used, why you have used these rather than others, and
present a summary of your main results.
Further guidance with respect to project management is provided in Topic 1, whilst Topic 4 provides
further guidance with respect to testing.
5.1 Project management
Issues with the project management
5.3 Project evaluation
Evaluate using the following:
o Does the design match the requirements?
o Have you built the right system?
o Validate YOUR design against YOUR requirements.
o Validate using structured walkthroughs. That is, someone went through the use of the
system with you checking requirements against the design.
The requirements specification
Required Inputs
CATWOE
The system design
The agenda
Blank Evaluation Matrix
Required Outputs
3
Completed evaluation matrix
List of design problems
The evaluation section of your project should include the following:
An overview of how YOU developed YOUR evaluation matrix – this should include the blank
evaluation matrix and an explanation of each field in the evaluation matrix.
An overview of YOUR approach to structured walkthrough – this should include a copy of the
agenda, the completed evaluation matrix and the list of design problems
An overview of how YOU rectified the design problems
5.3 Design Problems
Related to tools, techniques, methods and/or models
5.4 Conclusion
CHAPTER SIX
CONCLUSION
This chapter is a reflective evaluation of YOUR project in terms of:
Whether or not you achieved your aims and objectives
What problems occurred and how YOU overcame them
Things that YOU may do differently in any further projects that YOU undertake and YOUR
reasons for doing so
References
All references you cite within the body of your report should be fully referenced in this section, using the
Harvard Style. No reference should appear here unless it has been cited in the body of the report.
Appendices
These may include any supporting material to which a reader might wish to refer, but which is not
essential for the main body of the report. This might include:
Requirements Catalogue
Detailed Class Definitions (if required)
Evaluation Documentation