Software Design Specification

<Project Name>

Version 1.0 approved

Prepared by <author>

<Organization>

<Date created>
Software Design Specification for <Project> Page ii

Table of Contents
Table of Contents...........................................................................................................................ii
Revision History.............................................................................................................................ii
1. Introduction..............................................................................................................................1
1.1 Purpose of this document...........................................................................................................1
1.2 Product Scope.............................................................................................................................1
1.3 References..................................................................................................................................1
1.4 Overview of document...............................................................................................................1
2. System architecture description.............................................................................................1
2.1 Architecture diagram..................................................................................................................1
2.2 Overview of modules/components.............................................................................................1
2.3 Structure and relationships.........................................................................................................1
3. Detailed description of components.......................................................................................2
3.1 Component 1..............................................................................................................................2
3.2 Component 2..............................................................................................................................3
3.3 Component 3..............................................................................................................................3
4. Data design...............................................................................................................................3
4.1 ER diagram.................................................................................................................................3
4.2 Data table design........................................................................................................................3
5. User interface design................................................................................................................3
6. Other.........................................................................................................................................3
6.1 Restrictions, limitations, and constraints....................................................................................3
6.2 Failure design.............................................................................................................................3

Revision History
Name Date Reason For Changes Version
Software Design Specification for <Project> Page 1

1. Introduction

1.1 Purpose of this document

<Describe the purpose of writing this document, full description of the main objectives of the SDS
document. >

1.2 Product Scope

<Provide a short description of the software being specified and its purpose, including relevant
benefits, objectives, and goals. This will be similar to what was written in the SRS. >

1.3 References
<List any other documents or Web addresses related to design issues. At minimum, this
document should reference the SRS.>

1.4 Overview of document

<A short description of how the rest of the SDS is organized and what can be found in the rest of
the document. This is not simply a table of contents. Motivate and briefly describe the various
parts.>

2. System architecture description

NOTE: this section is main focus in version 1.0 of the SDS, the high level design. The reader
should come away with a good view of exactly how your solution is to be organized.

2.1 Architecture diagram

< A pictorial representation, using a UML diagram to show your system architecture.>

2.2 Overview of modules/components

< The subsection will introduce the various components and subsystems. >

2.3 Structure and relationships

< Make clear the interrelationships and dependencies among the various components. Structure
chars can be useful here.>
Software Design Specification for <Project> Page 2

3. Detailed description of components

We’ll use the following template to describe our components.

3.1 Component 1
Identification The unique name for the component and the location of the
component in the system.
Type A module, a subprogram, a data file, a control procedure, a
class, etc.
Purpose Function and performance requirements implemented by the
design component, including derived requirements. Derived
requirements are not explicitly stated in the SRS, but are implied
or adjunct to formally stated SDS requirements.
Function What the component does, the transformation process, the
specific inputs that are processed, the algorithms that are used,
the outputs that are produced, where the data items are stored,
and which data items are modified.
Subordinates The internal structure of the component, the constituents of the
component, and the functional requirements satisfied by each
part.
Dependencies How the component's function and performance relate to other
components. How this component is used by other components.
The other components that use this component. Interaction
details such as timing, interaction conditions (such as order of
execution and data sharing), and responsibility for creation,
duplication, use, storage, and elimination of components.
Interfaces Detailed descriptions of all external and internal interfaces as
well as of any mechanisms for communicating through
messages, parameters, or common data areas. All error
messages and error codes should be identified. All screen
formats, interactive messages, and other user interface
components (originally defined in the SRS) should be given here.
Resources A complete description of all resources (hardware or software)
external to the component but required to carry out its functions.
Some examples are CPU execution time, memory (primary,
secondary, or archival), buffers, I/O channels, plotters, printers,
math libraries, hardware registers, interrupt structures, and
system services.
Processing The full description of the functions presented in the Function
subsection. Pseudocode can be used to document algorithms,
equations, and logic.(recommendation: process diagram)
Data For the data internal to the component, describes the
representation method, initial values, use, semantics, and format.
This information will probably be recorded in the data dictionary.

3.2 Component 2
< Use same table template as above >
Software Design Specification for <Project> Page 3

3.3 Component 3
……………….

4. Data design
<Data flow chart, ER diagrams can be useful here. And describe how to design your database
using several data tables as you need.>

4.1 ER diagram

4.2 Data table design

<For example, end user table >

5. User interface design

< This section will present the main principles of the system interface. A detailed description of
user interface including screen images or prototype is presented. And you’d better put on some
design sketches and specific text messages. >

6. Other

6.1 Restrictions, limitations, and constraints

<Special design issues which impact the design or implementation of the software are noted
here.>

6.2 Failure design

<List all the failures that may occur in your systems and how to handle them.>