Está en la página 1de 14

JIET Group of Institutions

Software Design Document

For

Project Name

Project Name
Version
Date
Status

APPROVAL and Compulsory Review LIST


Role Name Date
Lab Faculty/ Incharge

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 1 08/04/2010


JIET Group of Institutions

1. Version Tracking
Date Version Comments Author

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 2 08/04/2010


JIET Group of Institutions

2. Contents

1. VERSION TRACKING........................................................................................2

2. CONTENTS........................................................................................................3

3. INTRODUCTION................................................................................................5

4. SCOPE................................................................................................................5

5. DEFINITIONS AND ACRONYMS......................................................................5

6. FUNCTIONAL DESCRIPTION...........................................................................6

7. FUNCTIONAL PARTITIONS..............................................................................7
7.1 Functional Description of Module......................................................................................................7
7.1.1 Module Name.................................................................................................................................7
7.1.2 Functional Block Diagram.............................................................................................................7
7.1.3 Module Dependencies....................................................................................................................7

8. DATA DESCRIPTION.......................................................................................8
8.1 Data Flow Diagram..............................................................................................................................8

8.2 Data structures used............................................................................................................................8

8.3 Constant Definition..............................................................................................................................8

8.4 Flow Charts..........................................................................................................................................8

8.5 E-R Diagram.........................................................................................................................................8

8.6 Database Description...........................................................................................................................8


8.6.1 Tables.............................................................................................................................................8
8.6.2 Views.............................................................................................................................................9
8.6.3 Triggers..........................................................................................................................................9
8.6.4 Stored Procedure............................................................................................................................9

9. USER INTERFACE DESIGN...........................................................................11


9.1.1 Form/Webpage Name..................................................................................................................11
9.1.2 Form/Webpage Description.........................................................................................................11
9.1.3 Form/Webpage Layout................................................................................................................11

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 3 08/04/2010


JIET Group of Institutions
10. MODULE DESCRIPTION...............................................................................12
10.1 Module Name..................................................................................................................................12

11. REFERENCES...............................................................................................14

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 4 08/04/2010


JIET Group of Institutions

3. Introduction

In this section details about the complete overview of the project. Capture the project
features, functionalities in detail.

4. Scope
In this section, detailed about the scope of the design document. What are the various
functional description is going to be covered in this document,explain them also.

5. Definitions and Acronyms

Abbreviation Description

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 5 08/04/2010


JIET Group of Institutions

6. Functional Description
Give the functional overview of the complete project in this section.
Give the functional block diagram of the project to be developed.
Give the brief description of the various blocks used in the projects.

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 6 08/04/2010


JIET Group of Institutions

7. Functional Partitions
This section explains each module with reference to its functionalities, description and
any other relevant information needed for the module.

7.1 Functional Description of Module

7.1.1 Module Name

Details about the individual module of the complete system. Also provide about
the block diagram with input/output to the block.

7.1.2 Functional Block Diagram


Draw the functional block diagram of the module.

7.1.3 Module Dependencies

7.1.3.1 Input Dependencies

List out the input dependencies of the module

7.1.3.2 Output Dependencies

Module Data Description

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 7 08/04/2010


JIET Group of Institutions

8. Data Description
8.1 Data Flow Diagram
This section will contain the data flow diagram of the software system which is
developed.

8.2 Data structures used


This section will contain the complete list of the data structures.

8.3 Constant Definition


This section will contain the complete list of constants used in the software.

8.4 Flow Charts


The flow charts for complete project and individual modules of the project.

8.5 E-R Diagram


E-R Diagram for the complete project.

8.6 Database Description


This section will cover the detail description of the database used in the project.

8.6.1 Tables
List out all the tables and their description which will be used in the project.

8.6.1.1.1 Table Name


Mention the name of the table.

8.6.1.1.2 Table Description


Mention the description of table.

8.6.1.1.3 Fields

Field Name Data Type Synonyms Description


Names of the field Mention the data Mention the Mention the
in the table that will type of the field. synonyms of field description of the
be used name, if used any. data field.

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 8 08/04/2010


JIET Group of Institutions

8.6.2 Views
8.6.2.1.1 View Name
Mention the name of the views used in the project databases.

8.6.2.1.2 View Description


Mention the description of the views.

8.6.3 Triggers

8.6.3.1.1 Trigger Name


Mention name of the triggers used in the project database.

8.6.3.1.2 Trigger Description


Mention the description of the triggers used in the project databases.

8.6.3.1.3 Trigger Event


Mention the event on which the trigger is activated.

8.6.3.1.4 Trigger Action


Mention the action which will be performed whenever the trigger is activated.

8.6.4 Stored Procedure


8.6.4.1.1 Stored Procedure Name
Mention the name of the stored procedure.

8.6.4.1.2 Stored Procedure Description


Description of the stored procedures.

8.6.4.1.3 Input Parameters


Variable Type Variable Name Variable Description
Data Type of the Name of the input Description of the input variable
input parameters parameters

8.6.4.1.4 Output Parameters


Variable Type Variable Name Variable Description
Data Type of the Name of the output Description of the output variable
output parameters parameters

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 9 08/04/2010


JIET Group of Institutions
8.6.4.1.5 Return values
Status of the stored procedures.

8.6.4.1.6 Stored Procedure Pseudo code


Mention the pseudo code of the stored procedure.

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 10 08/04/2010


JIET Group of Institutions

9. User Interface Design

9.1.1 Form/Webpage Name


Mention the name of the form/webpage used in the project.

9.1.2 Form/Webpage Description


Describe the purpose of the form/webpage used in the project.

9.1.3 Form/Webpage Layout


Draw the form/webpage layout using MS word drawing tools.

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 11 08/04/2010


JIET Group of Institutions

10. Module Description


10.1 Module Name
Mention the module name.
10.1.1.1 Class Name
Mention the name of the class.
10.1.1.2 Class Description
Describe the purpose of the class in the module.
10.1.1.3 Class Dependencies
Mention the dependencies of the class on the other classes. It may be in the same module
or the other module.

10.1.1.4 Class Functions

10.1.1.4.1.1 Function Name

Declaration of the function over here.

Return_Type Function_Name(Arguments1,Arguments2…etc)

10.1.1.4.1.2 Description
Description of the function.

10.1.1.4.1.3 Input Parameters


Variable Type Variable Name Variable Description
Data Type of the Name of the input Description of the input variable
input parameters parameters

10.1.1.4.1.4 Output Parameters


Variable Type Variable Name Variable Description
Data Type of the Name of the output Description of the output variable
output parameters parameters

10.1.1.4.1.5 Return values


Status of the function

10.1.1.4.1.6 Pseudo code

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 12 08/04/2010


JIET Group of Institutions
In this section write down the pseudo code for the functions.

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 13 08/04/2010


JIET Group of Institutions
11. References
In this section list out all the references used for developing this document and the
software.

Prepared By Ashutosh Vyas & Vishnu Gehlot Page 14 08/04/2010