School of Engineering Sciences and Technology
Computer Engineering Department
1 Attachment Project Report Guidelines
1.1 Chapters of the Project
A Computer Engineering project is documented following the Software Engineering Methodology that closely
resembles that of the Waterfall Model. A project document should include at the least the following chapters:
Sample Headings to include in your documentation:
This is a sample of a thorough attachment project document – Highlighting the sub- headings you may
include. Please take note of the chapters and sub-topics you should include in your documentations.
CHAPTER 1: INTRODUCTION
1.1 Introduction
1.1.1 Background
1.1.2 Company Organogram
1.1.3 Vision
1.1.4 Mission Statement
1.2 System’s Request Summary
1.3 Problem Definition
1.4 Aim
1.5 Objectives
1.6 Constraints
1.7 Justification
1.8 Conclusion
CHAPTER 2: PLANNING
2.0 Introduction
2.1 Business Value
2.2 Feasibility Study
2.2.1 Technical Feasibility
2.2.2 Operational Feasibility
2.2.3 Economic Feasibility
2.3 Risk Analysis
2.4 Project Plan
2.4.1 Project Schedule
1
2.4.2 Gantt Chart
CHAPTER 3: ANALYSIS
3.0 Introduction
3.1 Information Gathering Methodologies 3.2 Analysis of the existing
system 3.3 Process Analysis
3.4 Data Analysis
3.4.1 Context Diagram 3.4.2 Data-Flow Diagram 3.5 Weaknesses in the
current system 3.6 Evaluation of Alternatives
3.7 Requirements Analysis
3.7.1 Functional Requirements
2.7.2 Non-Functional Requirements
CHAPTER 4: DESIGN
4.0 Introduction
4.1 System Design
4.2 Architectural Design
4.3 Physical Design
4.4 Database Design
4.5 Program Design
4.5.1 Package Diagram 4.5.2 Class Diagram
4.5.3 Sequence Diagram 4.5.4 Context Diagram 4.5.5
Data-Flow Diagram 4.6 Interface Design
4.6.1 Security Design
4.6.2 Input Design
4.6.3 Output Design
CHAPTER 5: IMPLEMENTATION
5.1 Coding
5.2 Testing
5.2.1 Unit Testing
5.2.2 Modular Testing
5.2.3 Objectives Testing
5.2.4 Acceptance Testing
5.2.5 Validation
5.2.6 Verification
5.3 Installation
5.3.1 Hardware Installation
5.3.2 Software Installation
5.3.3 Database Installation
5.3.4 Application System Installation 5.3.5 Training
5.3.6 Review
5.3.7 Back-up
2
APPENDIX A: User Manual
APPENDIX B: Sample Code
APPENDIX C: Research Methodologies
Brief description of some of the sections:
(a) Introduction
• The introduction contains a brief snapshot of the entire project, a brief problem
outline and its justification, expected results and environment highlights. It is a
summary of the entire project and is usually rewritten many times as the rest of the
document changes.
(b) Problem Definition
• Here the project problem is described in detail, including the background to the
problem area one is working on. The need and nature of the problem must be clearly
visible to the reader/examiner.
(c) Project Objectives
• Objectives of the problem must be stated in a SMART way. These objectives must be
satisfied on completion of the project. They can be included as a sub topic in chapter
(b) above.
(d) Proposed Solutions, Evaluation of Options, Resource Requirements and System Boundaries
Note: (b), (c), (d) usually part of (a) above.
(e) Feasibility Study
• This section answers the question if it is possible to do the project under certain
conditions or constraints. One must cover economic feasibility (cost-benefit analysis),
technical feasibility and social feasibility.
(f) System Alternatives/Methodology
• This section is an exploration of the various options available to solving the given
problem, an evaluation of those options and a justification of the chose approach.
Also include a section to discuss the tools that you would use to solve the problem
in the approach chosen and a justification of the use of those tools.
(g) System Specification/Analysis
• This essentially entails requirements specification. A requirements specification must
give the functional and non-functional requirements for the required system,
including the hardware and software needs.
(h) System Design
• This is one of the most critical sections that shows clearly your understanding or
misunderstanding of your system requirements. This section requires a presentation
of the system context diagram, the detailed data flow diagram(s). If working on a
database design, one must include all the entity relationship diagrams, and
accompanying data dictionary. The system design section must also include the
algorithm design where all important algorithms must be presented either as
pseudocode or as flowchart. The other most important aspect to design is the user
interface design.
(i) Implementation
• A discussion of the important system code is included in this section, the functions,
their purpose and their requirements. Also include the entire code listing for the
examiner to inspect.
(j) System Evaluation/Assessment*
• One must be able to look critically at the work they have done, the good points and
the areas that are possibly ambiguous, alternative ways of presenting certain issues,
etc.
(k) Conclusion*
• This is a summary of the project, which can also cover what is in (i); therefore more
often than not, the section (i) is covered under the conclusion chapter to avoid
repetition.
(l) Appendices
• This is an optional section which includes information that could not be included in
previous sections but is pointed to as further reading in the previous sections.
Appendices are not just put there; there must be somewhere in your text where they
are referred to or pointed to or even briefly discussed.
4
1.2 The Document Cover Page
The cover page of the document must follow the following
format:
Sales Inventory System (size 16)
Donna Musiyandaka (size 14)
C0567843M
Chinhoyi University of Technology (size 12)
Department of ICT and Electronics(size 12)
Standard Chartered Corporation (size 12)
January 2023 to December 2024(italic, size 12)
This project is submitted in partial fulfilment of the requirements for the advanced diploma in ……(italic, size 11)
6
Samples of Chapter headings:
Either this:
2 Problem Definition and Methodology ………………………….
2.1 Methodology
…………………….
2.1.1 Justification
……………………
Or you can put the word Chapter before the major chapter numbering as follows: Chapter 2
Problem Definition and Methodology
2. 1 Methodology
…………………….
2.1.1 Justification
……………………
7
8
