DESIGN DOCUMENTATION

for

<Project>

Prepared by
regno rollno name

October 15, 2016

1
Contents
1 Introduction 3
1.1 Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 System Architecture 4
2.1 Module 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.2 Module 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

3 Data Description 5
3.1 Database design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.2 Data Flow Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.3 Entities and Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.4 Use case diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.5 Class diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.6 Activity diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.7 Dataset Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4 Algorithms 6
4.1 Algorithm 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.2 Algorithm 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

References 7

2
1 Introduction
Briefly explain the purpose of the project and the proposed solution

1.1 Purpose
explain the purpose of the document.

1.2 Overview
A short description of how the rest of the document is organized and what can be found
in the rest of the document. Briefly describe the various parts!

3
2 System Architecture
In this section, explain the detailed architecture of the proposed system. It should
include the architecture diagram and the explanation of the modules of the system.

2.1 Module 1
Explain the functions of module 1

2.2 Module 2
Explain the functions of module 2

4
3 Data Description
In this section. explain the database design, schema, data flow.

3.1 Database design

the db design, entities and the schema.

3.2 Data Flow Diagram

The various levels of data flows relevant tot he project.

3.3 Entities and Relationships

An optional section. If there exist any relationships between the entities, give the details
and an er diagram representing it.

3.4 Use case diagram

Give the use case diagram of the project.

3.5 Class diagram

Give the uml class diagram of the entities involved.

3.6 Activity diagram

A flowchart or activity diagram explaining the user activity flow. An optional section.

3.7 Dataset Design

Give the dataset that will be used in the implementation of the project.

5
4 Algorithms
Explain the pseudocodes of the algorithms that will be used in the implementation of
the project.

4.1 Algorithm 1
psuedocode and its explanation briefly.

4.2 Algorithm 2
psuedocode and its explanation briefly.

6
Bibliography
[1]

[2]

[3]

[4]

[5]

[6]