T E X A S D E PA RT M E N T O F I N F O R M AT I O N R E S O U R C E S

Functional Software
Design Description
Template
Version 1.2 14 JAN 2008

NOTE: Please remove this page when creating a Functional Software Design Description deliverable.

Texas Project Delivery Framework

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

Using This Template

The companion tool, Functional Software Design Description Instructions, provides detailed direction
for completing this template. This and other Framework Extension tools are available on the Framework
Web site.
To create a deliverable from this template:
1. Delete the template title page (previous page) and this page.
2. Replace [bracketed text] on the cover page (next page) with your project and agency information.
3. Replace [bracketed text] in the tool header area at the top of page i (Contents page) with the
same project and agency information as on the cover page.
Note: Please do not remove or modify content in the footer area.
4. Complete the entire template. Each section contains abbreviated instructions, shown in italics,
and a content area. The content area is marked with a placeholder symbol () or with a table.
Relevant text from other project deliverables may be pasted into content areas.
Note: Please do not remove the italicized instructions.
5. Update the table of contents by right-clicking and selecting Update Field, then Update entire
table.

NOTE: Please remove this page when creating a Functional Software Design Description deliverable.
DIR Document 25FS-T1-2

TEX A S P RO JE CT DE L IV E RY FRA ME WO RK

FUNCTIONAL SOFTWARE
DESIGN DESCRIPTION

[Agency/Organization Name]

[PROJECT NAME]

VERSION: [Version Number]

Approver Name

Title

REVISION DATE: [Date]

Signature

Date

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Contents
Section 1. Overview............................................................................................ 1
1.1 Purpose.............................................................................................. 1
1.2 Scope................................................................................................. 1
Section 2. System Architecture...........................................................................2
Section 3. Data Dictionary..................................................................................3
Section 4. Software Domain Design...................................................................4
4.1 Software Application Domain Chart...................................................4
4.2 Software Application Domains...........................................................4
Section 5.
5.1
5.2
5.3
5.4

Data Design.......................................................................................5
Persistent/Static Data........................................................................5
Transient/Dynamic Data.....................................................................5
External Interface Data......................................................................5
Transformation of Data......................................................................5

Section 6.
6.1
6.2
6.3

User Interface Design........................................................................6

User Interface Design Overview........................................................6
User Interface Navigation Hierarchy..................................................6
User Function Categories (or Use Cases).........................................6

Section 7. Other Interfaces.................................................................................8

Section 8. Other Design Features.......................................................................9
Section 9. Requirements Traceability Matrix.....................................................10
Section 10. References.......................................................................................11
Section 11. Glossary...........................................................................................12
Section 12. Revision History...............................................................................13
Section 13. Appendices.......................................................................................14

Based on
DIR Document 25FS-T1-2

Page i

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 1. Overview
1.1 Purpose
Describe the purpose of the Functional Software Design Description (SDD) and its intended
audience.

1.2 Scope
Describe the scope of the software to be produced.

Based on
DIR Document 25FS-T1-2

Page 1

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 2. System Architecture

Provide and describe a figure that depicts the overall system architecture.

Based on
DIR Document 25FS-T1-2

Page 2

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 3. Data Dictionary

Provide a reference to the location of or provide the actual Data Dictionary Table that contains a
description of each element in the software application.

Based on
DIR Document 25FS-T1-2

Page 3

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 4. Software Domain Design

4.1 Software Application Domain Chart
Provide a figure depicting the set of software application domains showing major components
and their relationships.

4.2 Software Application Domains

Customize this subsection to contain the subsections necessary to comprehensively document
the domains, components, functions, and tasks of the software design. Each subsection should
be titled for a specific domain, component, or task. Describe each domain within the design.
Depict and describe the hierarchy of domains, components, functions, and tasks.
4.2.x

Domain X
Provide a high-level description of the family of components within Domain X and provide a
function hierarchy chart of the component relationships. Include any database domains and their
stored procedures and triggers. If appropriate, provide a hierarchical depiction of the components
within the domain.

4.2.x.y Component Y1 of Domain X

Provide a high-level description of Component Y1 of Domain X. Include a functional
decomposition of the component into its lower-level functions, following principles of topdown design. If appropriate, provide a hierarchical depiction of Component Y1 of Domain X.

4.2.x.y.z Task Z of Component Y1 of Domain X

Provide a high-level description of Task Z of Component Y1 of Domain X. If appropriate for
the design, provide diagrams and narratives that specify the flow of data and control at a
component- or task-level.

Based on
DIR Document 25FS-T1-2

Page 4

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 5. Data Design

Customize the following subsections to describe the data contained in databases and other data
structures shared between design elements of the software design. Include persistent/static data,
transient/dynamic data, external interface data, and transformation of data. Label and title each
subsection appropriately.

5.1 Persistent/Static Data

5.1.x

Persistent/Static Data Store X

Describe and provide an illustration of the logical data model or entity relationship diagram(s) for
the Persistent/Static Data Store X. Include the purpose and general configuration of the data
store. Describe the Persistent/Static Data Store X. Include the purpose and general configuration
of the data store.

5.2 Transient/Dynamic Data

Describe the applications transient/dynamic data design and its general configuration. Include
the purpose for each of the transient/dynamic data design elements.

5.3 External Interface Data

Describe and provide diagrams of the external interfaces data design. Include the purpose and
general configuration within the description.

5.4 Transformation of Data

Describe the application's data transformation design. Include the general configuration and
purpose for each of the data transform design elements and the transformation mapping rules.

Based on
DIR Document 25FS-T1-2

Page 5

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 6. User Interface Design

6.1

User Interface Design Overview

Provide a high-level description of the user interface for this software application. Describe any
systems requirements (e.g., performance or usability) associated with all of the user interfaces.

6.2 User Interface Navigation Hierarchy

Provide and describe a diagram of the navigation hierarchy that illustrates how a user moves
through the user interface.

6.3 User Function Categories (or Use Cases)

Customize the following subsections to accurately and comprehensively document each category
of user function or use case that requires an interface. Document each category of user function
or use case individually in a corresponding subsection. Label each subsection appropriately and
title each subsection descriptively to indicate the function or use case being documented.
6.3.x

Function (or Use Case) X

Provide a description of the function supporting this category of user interfaces.

6.3.x.y Function (or Use Case) X Screen/Report Format/Other User Interface XX

Provide a description, and if appropriate, an image or mockup of each screen, report, or other
user interface within this function or use case.

6.3.x.y.1 Function (or Use Case) X Screen/Other User Interface XX Fields

Provide a Screen/Other User Interface Fields Table that includes descriptive information for
each field that appears on the screen or other user interface within the function or use case.
In addition, if the data is selected from a pick list, include the list of possible values or their
description. If the content of a field is derived from client-side calculations using other fields
or values, then specify the algorithm for the calculation in a descriptive footnote to the table. If
the content of a field is derived from server-side calculations or lookups, then specify the
source of that calculation (e.g., the class or stored procedure where the calculation occurs).

Based on
DIR Document 25FS-T1-2

Page 6

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Also, specify the error messages to be displayed when the input does not meet requirements
for the field.

Based on
DIR Document 25FS-T1-2

Page 7

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 7. Other Interfaces

Customize the following subsections to accurately and comprehensively document the design of
any additional interfaces not described in the previous sections. Identify the technology that will
be used to enable the interaction. Label each subsection appropriately and title each subsection
descriptively to indicate the interface being documented.

7.x Interface X
Describe the interface design including technology, the protocol, any specific message formats,
error conditions002C handshakes, initiation and closure, and other features that define the
design of the interface.

Based on
DIR Document 25FS-T1-2

Page 8

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 8. Other Design Features

Describe any design features that are not captured in the previous sections.

Based on
DIR Document 25FS-T1-2

Page 9

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 9. Requirements Traceability Matrix

Provide reference to the location of the Requirements Traceability Matrix that indicates traceabilty
from the system requirements documented in the System Requirements Specification to the
design elements documented in the System Design Description (SyDD), the design elements
documented in the SyDD to the software requirements documented in the Software
Requirements Specification (SRS), and the software requirements documented in the SRS to the
design elements documented in the Software Design Description.

Based on
DIR Document 25FS-T1-2

Page 10

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 10. References

Provide a list of all documents and other sources of information referenced in the Software
Design Description (SDD) and utilized in developing the Software Design Description. Include for
each the document number, title, date, and author.
Document No.

Based on
DIR Document 25FS-T1-2

Document Title

Date

Page 11

Author

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 11. Glossary

Define all terms and acronyms required to interpret the Software Design Description properly.

Based on
DIR Document 25FS-T1-2

Page 12

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 12. Revision History

Identify changes to the Software Design Description.
Version

Date

Based on
DIR Document 25FS-T1-2

Name

Description

Page 13

[Agency/Organization Name]
[Project Name]

FUNCTIONAL SOFTWARE DESIGN DESCRIPTION

[Version Number] | [Revision Date]

Section 13. Appendices

Include any relevant appendices.

Based on
DIR Document 25FS-T1-2

Page 14