Vous êtes sur la page 1sur 10

A Software Design Document

On
<The Title of Project>
Submitted in partial fulfillment of the requirements
for the award of the degree of

Bachelor of Technology
in
Computer Science and Engineering

Submitted by

< Student Name (Roll Number) >


< Student Name (Roll Number) >
< Student Name (Roll Number) >
< Student Name (Roll Number) >

Under the supervision of


Guide Name

DEPARTMENT OF COMPUTER SCIENCE AND ENGINEERING

G.L. BAJAJ INSTITUTE OF TECHNOLOGY & MANAGEMENT

Affiliated to

DR. APJ ABDUL KALAM TECHNICAL UNIVERSITY, LUCKNOW


Year - Semester - Session -

Month Name, Year


Software Design Document for <Project’s Title> Page 2

Abstract (16 pt Times New Roman/Center Align)

This section contains the abstract about the work being carried out as part of the research project
undertook by student. (Font- Times New Roman 12 size, Justified)
Software Design Document for <Project’s Title> Page 3

Acknowledgement (16 pt Times New Roman/Center Align)

This section covers the acknowledgement part for the research project undertaken.
Software Design Document for <Project’s Title> Page 4

Table of Contents
Abstract………………………………………………………………………………………… ii
Acknowledgement……………………………………………………………………………… iii
Table of Contents……………………………………………………………………………….. iv
List of Figures………………………………………………………………………………….... v
List of Tables……………………………………………………………………………………. vi
1. Introduction Error! Bookmark not defined.
1.1 Purpose Error! Bookmark not defined.
1.2 Scope Error! Bookmark not defined.
1.3 Definitions, Acronyms and Abbreviations Error! Bookmark not defined.
2. Attributes of Design Entities 1
2.1 Identification 1
2.2 Type 1
2.3 Purpose 1
2.4 Function Error! Bookmark not defined.
2.5 Dependencies Error! Bookmark not defined.
2.6 Interface Error! Bookmark not defined.
2.7 Resources 2
2.8 Processing 2
2.9 Data 2
3. Decomposition Description Error! Bookmark not defined.
3.1 General Structure 9
3.2 Procedural Approach Error! Bookmark not defined.
3.2.1 Module Decomposition Error! Bookmark not defined.
3.2.2 Data Decomposition Error! Bookmark not defined.
3.3 Object-Oriented Approach Error! Bookmark not defined.
3.3.1 Use Case Diagrams 3
3.3.2 Class Diagrams 3
3.3.3 Sequence Diagrams 3
3.3.4 State chart Diagrams 3
3.3.5 Activity Diagrams 3
3.3.6 Component Diagram 3
3.3.7 Deployment Diagram 3
5. Dependency Description Error! Bookmark not defined.
5. Interface Description Error! Bookmark not defined.
6. Detailed Design Error! Bookmark not defined.
7. References 4
Appendix A: Glossary 4
Software Design Document for <Project’s Title> Page 5

List of Figures (16 pt Times New Roman/Center Align)


Figure No. Description Page No.

Times new roman 12 point (everywhere in this table)


Software Design Document for <Project’s Title> Page 6

List of Tables (16 pt Times New Roman/Center Align)


Table No. Description Page No.

Times new roman, 12 point (everywhere in this table)


Software Design Document for <Project’s Title>
Page 7

1. Introduction
1.1 Purpose
This subsection should explain the purpose of the SDD and specify the intended audience for it.
The SDD described the software structure, software components, interfaces and data necessary for
the implementation phase. Each requirement in the SRS should be traceable to one or more design
entities in the SDD.

1.2 Scope
This subsection should relate the design document to the SRS and to the software to be developed.

1.3 Definitions, Acronyms and Abbreviations

This subsection should provide the definitions of all terms, acronyms and abbreviations that are
used in the SDD.

2. Attributes of Design Entities


2.1 Identification
The name of the entity should be specified. Two entities should not have the same name.

2.2 Type
The type attribute should describe the nature of the entity. It may simply name the kind of entity,
such as subprogram, module, procedure, process, data item, object etc. Alternatively, design
entities can be grouped, in order to assist in locating an entity dealing with a particular type of
information.

2.3 Purpose
This is a description of why the entity exists. It provides the rationale for the creation of the entity.
Therefore it designates the specific functional and performance requirements for which this entity
was created, using the SRS.
Software Design Document for <Project’s Title>
Page 8

2.4 Function

The function attribute should state the transformation applied by the entity inputs to produce the
desired output. In the case of a data entity, this attribute should state the type of information stored
or transmitted by the entity.

2.5 Dependencies
The dependencies attribute should identify the relationship of the entity with other entities. It
describes the nature of each interaction that may involve initiation, order of execution, data
sharing, creation, duplicating, usage, storage or destruction of other entities.

2.6 Interface

The interface attribute describes how other entities interact with this entity. It should describe the
methods of interaction and rules governing those interactions. It provides a description of the input
ranges, the meaning of inputs and outputs, the type and format of each input or output, and output
error codes.

2.7 Resources

The resources attribute identifies and describes all of the resources external to the design that are
needed by this entity to perform its function. It provides information about items such as physical
devices (printers, discs, memory), software services (math libraries, operating system services,
graphical user interface libraries), and processing resources (CPU cycles, memory allocation).

2.8 Processing
The processing attribute describes the rules used by the entity to achieve its function. It describes
the algorithm used by the entity to perform a specific task. It includes sequencing of events or
processes, process steps, conditions, termination criteria etc.

2.9 Data
The data attribute describes the method of representation, initial value, use, format and acceptable
values of internal data
Software Design Document for <Project’s Title>
Page 9

3. Decomposition Description
3.1 General Structure
This section of the SDD should record the division of the software system into design entities. It
describes the way the system is structured and the purpose and function of each entity. For each
entity, it provides a reference to the detailed description. It uses the identification, type, purpose,
function and subordinates attributes.

3.2 Procedural Approach


If a procedural approach is used, this includes a description of the basic modules of the system
and how they relate to other modules (which modules it calls etc.) Textual descriptions should also
be provided for each module that the system is decomposed into.

3.2.1 Module Decomposition

This subsection describes the decomposition information as given in 3.1 for software modules.

3.2.2 Data Decomposition

This subsection describes the decomposition information as given in 3.1 for data elements.

3.3 Object-Oriented Approach


In case an object-oriented approach is used, there should be class(inheritance) diagrams showing
the classes in the system. Textual descriptions should also be provided for each class/object that
the system is decomposed into. Use UML to describe the object-oriented decomposition under
following sub-sections.

3.3.1 Use Case Diagrams

3.3.2 Class Diagrams

3.3.3 Sequence Diagrams

3.3.4 State chart Diagrams

3.3.5 Activity Diagrams

3.3.6 Component Diagram

3.3.7 Deployment Diagram


Software Design Document for <Project’s Title>
Page 10

4. Dependency Description
This subsection describes the dependencies between different entities. It uses the identification,
type, purpose, dependencies and resources attributes.

5. Interface Description
This subsection describes everything designers, programmers and testers need to know to correctly
use the functions provided by an entity. It includes the details of external and internal interfaces
not provided in the SRS. It uses the identification, function and interfaces attributes.

6. Detailed Design
It contains the internal details of each design entity. These details include attribute descriptions
for identification, processing and data. It contains all the details that will be needed by the
programmers for implementation. Short English-like descriptions can be used to describe the
algorithms utilized. Data structure details should also be given.

7. References

Appendix A: Glossary
<Define all the terms necessary to properly interpret the SRS, including acronyms and
abbreviations. You may wish to build a separate glossary that spans multiple projects or the entire
organization, and just include terms specific to a single project in each SRS.>

Vous aimerez peut-être aussi