SCS203: PROGRAMMING AND DATABASE PRACTICUM

PROJECT REPORT GUIDE

INTRODUCTION

The project report should be documented with a software engineering approach to

the solution of the problem that you have sought to address. The project report
should be prepared in order to solve the problem in a methodical and professional
manner, making due references to appropriate techniques, technologies and
professional standards. You should start the documentation process from the first
step of software development so that you can easily identify the issues to be
focused upon in the ultimate project report. You should also include the details
from your project notebook, in which you would have recorded the progress of your
project throughout the course. The project report should contain enough details
to enable examiners to evaluate your work. The details, however, should not render
your project report as boring and tedious. The important points should be
highlighted in the body of the report, with details often relegated to appendices.

EXPLANATION OF CONTENTS

Title Page

Give the title of the project, details of the student and course/unit

Abstract

This should be one/two short paragraphs (100-150 words total), summarising the
project work. It is important that this is not just a re-statement of the original
project outline. A suggested flow is background, project aims and main
achievements. From the abstract, a reader should be able to ascertain if the
project is of interest to them and, it should present results of which they may
wish to know more details.

Acknowledgements

This should express your gratitude to those who have helped you in the preparation
of your project.

Table of Contents
The table of contents gives the readers a view of the detailed structure of the
report. You would need to provide section and subsection headings with associated
pages.

Table of Figures
List of all Figures, Tables, Graphs, Charts etc. along with their page numbers in
a table of figures.
 SCS203: PROGRAMMING AND DATABASE PRACTICUM

Chapter 1: Introduction

The introduction has several parts as given below:

1.1. Background
A description of the background and context of the project and its relation to
work already done in the area. Summarise existing work in the area concerned
with your project work.

1.2. Objectives
Concise statement of the aims and objectives of the project. Define exactly what
you are going to do in the project; the objectives should be about 30 /40 words.

1.3. Purpose, Scope and Applicability:

The description of Purpose, Scope, and Applicability are given below:
1.3.1. Purpose
Description of the topic of your project that answers questions on why you are
doing this project. How your project could improve the system its significance
and theoretical framework.

1.3.2. Scope
A brief overview of the methodology, assumptions and limitations. You should
answer the question: What are the main issues you are covering in your project?
What are the main functions of your project?

1.3.3. Applicability
You should explain the direct and indirect applications of your work. Briefly
discuss how this project will serve the computer world and people.

Chapter 2: Survey of Technologies

In this chapter Survey of Technologies i.e. programming language and database,

you should demonstrate your awareness and understanding of Available Technologies
related to the topic of your project. You should give the detail of all the
related technologies that are necessary to complete your project. You should
describe the technologies available in your chosen area and present a comparative
study of all those Available Technologies. Explain why you selected the one
technology for the completion of the objectives of your project.

Chapter 3: Requirements and Analysis

3.1. Problem Definition

Define the problem on which you are working in the project.Provide details of the
overall problem and then divide the problem in to sub-problems. Define each sub-
problem clearly.

3.2. Requirements Specification

In this phase you should define the requirements of the system, independent of
how these requirements will be accomplished. The Requirements Specification
describes the things in the system and the actions that can be done on these
things. Identify the operation and problems of the existing system. Define the
details of all the software and hardware needed for the development and
implementation of your project.
 SCS203: PROGRAMMING AND DATABASE PRACTICUM

3.2.1. Hardware Requirement

In this section, the equipment, graphics card, numeric co-processor, mouse, disk
capacity, RAM capacity etc. necessary to run the software must be noted.
3.2.2. Software Requirements
In this section, the operating system, the compiler, testing tools, linker, and
the libraries etc. necessary to compile, link and install the software must be
listed.

3.3. Preliminary Product Description

Identify the requirements and objectives of the new system. Define the functions
and operation of the application/system you are developing as your project.

3.4. Conceptual Models

You should understand the problem domain and produce a model of the system, which
describes operations that can be performed on the system, and the allowable
sequences of those operations. Conceptual Models could consist of complete Data
Flow Diagrams, ER diagrams, Object-oriented diagrams, System Flowcharts etc.

Chapter 4: System Design

Describes desired features and operations in detail, including screen layouts,

business rules, process diagrams, pseudocode and other documentation.

4.1. Basic Modules

You should follow the divide and conquer theory, so divide the overall problem
into more manageable parts and develop each part or module separately. When all
modules are ready, you should integrate all the modules into one system. In this
phase, you should briefly describe all the modules and the functionality of these
modules.

4.2. Data Design

Data design will consist of how you organize, managing and manipulate the data.

4.2.1. Schema Design

Define the structure and explanation of schemas used in your project.
4.2.2. Data Integrity and Constraints
Define and explain all the validity checks and constraints you are providing to
maintain data integrity.
4.3. Procedural Design
Procedural design is a systematic way for developing algorithms or procedurals.
4.3.1. Logic Diagrams
Define the systematical flow of procedure that improves its comprehension and
helps the programmer during implementation. e.g., Control Flow Chart, Process
Diagrams etc.
4.3.2. Data Structures
Create and define the data structure used in your procedures.
4.3.3 Algorithms Design
With proper explanations of input data, output data, logic of processes, design
and explain the working of algorithms.

4.4. User Interface Design

Define user, task, environment analysis and how you intend to map those
requirements in order to develop a “User Interface”. Describe the external and
internal components and the architecture of your user interface. Show some rough
pictorial views of the user interface and its components.
 SCS203: PROGRAMMING AND DATABASE PRACTICUM

4.5. Security Issues

Discuss Real-time considerations and Security issues related to your project and
explain how you intend avoiding those security problems. What are your security
policy plans and architecture?

4.6. Test Cases Design

Define test cases, which will provide easy detection of errors and mistakes with
in a minimum period of time and with the least effort. Explain the different
conditions in which you wish to ensure the correct working of your software.

Chapter 5: Implementation and Testing

5.1. Implementation Approaches

Define the plan of implementation, and the standards you have used in the
implementation.

5.2. Coding Details and Code Efficiency

Students not need include full source code, instead, include only the important
codes (algorithms, applets code, forms code etc). The program code should contain
comments needed for explaining the work a piece of code does. Comments may be
needed to explain why it does it, or, why it does a particular way. You can
explain the function of the code with a shot of the output screen of that program
code.

5.2.1 Code Efficiency

You should explain how your code is efficient and how you have handled code
optimisation.

5.2.2. Testing Approach

Testing should be according to the scheme presented in the system design chapter
and should follow some suitable model – e.g., category partition, state machine-
based. Both functional testing and user-acceptance testing are appropriate.
Explain your approach of testing.

5.2.3. Unit Testing

Unit testing deals with testing a unit or module as a whole. This would test the
interaction of many functions but, do confine the test within one module.

5.2.4. Integrated Testing

Brings all the modules together into a special testing environment, then checks
for errors, bugs and interoperability. It deals with tests for the entire
application. Application limits and features are tested here.

5.3. Modifications and Improvements

Once you finish the testing you are bound to be faced with bugs, errors and you
will need to modify your source code to improve the system. Define what
modification you implemented in the system and how it improved your system.

Chapter 6: Results and Discussion

6.1. Test Reports

Explain the test results and reports based on your test cases, which should show
that your software is capable of facing any problematic situation and that it
 SCS203: PROGRAMMING AND DATABASE PRACTICUM

works fine in different conditions. Take the different sample inputs and show the
outputs.

6.2. User Documentation

Define the working of the software; explain its different
functions, components with screen shots. The user document should provide all the
details of your product in such a way that any user reading the manual, is able
to understand the working and functionality of the document.

Chapter 7: Conclusions

7.1. Conclusion
The conclusions can be summarized in a fairly short chapter. This chapter brings
together many of the points that you would have made in the other chapters.

7.2. Limitations of the System

Explain the limitations you encountered during the testing of your software that
you were not able to modify. List the criticisms you accepted during the
demonstrations of your software.

REFERENCES

It is very important that you acknowledge the work of others that you have used
or adapted in your own work, or that provides the essential background or context
to your project. The use of references is the standard way to do this. Please
follow the given standard for the references for books, journals, and online
material.

GLOSSARY

If you use any acronyms, abbreviations, symbols, or uncommon terms in the project
report then their meaning should be explained where they first occur. If you go
on to use any of them extensively then it is helpful to list them in this section
and define the meaning.

APPENDICES

These may be provided to include further details of results, mathematical

derivations, certain illustrative parts of the program code (e.g., class
interfaces), user documentation etc. In particular, if there are technical details
of the work done that might be useful to others who wish to build on this work,
but that are not sufficiently important to the project as a whole to justify being
discussed in the main body of the project, then they
should be included as appendices.