You are on page 1of 18

System Design

Description
Template
Version 1.2 14 JAN 2008
NOTE: Please remove this page when creating a System Design Description deliverable.
Texas Project Delivery ramewor! S"STE# DES$%N DES&'$PT$ON
Using This Template
The companion tool( System Design Description Instructions( provides detailed direction )or
completing this template. This and other ramewor! Extension tools are available on the ramewor! *eb
site.
To create a deliverable )rom this template:
+. Delete the template title page ,previo-s page. and this page.
/. 'eplace 0brac!eted text1 on the cover page ,next page. with yo-r project and agency in)ormation.
2. 'eplace 0brac!eted text1 in the tool header area at the top o) page i ,&ontents page. with the
same project and agency in)ormation as on the cover page.
Note: Please do not remove or modi)y content in the )ooter area.
3. &omplete the entire template. Each section contains abbreviated instr-ctions( shown in italics(
and a content area. The content area is mar!ed with a placeholder symbol ,. or with a table.
'elevant text )rom other project deliverables may be pasted into content areas.
Note: Please do not remove the italici4ed instr-ctions.
5. 6pdate the table o) contents by right7clic!ing and selecting 86pdate ield(9 then 86pdate entire
table.9
NOTE: Please remove this page when creating a System Design Description deliverable.
D$' Doc-ment /5SD7T+7/
TEXAS PROJECT DELI VERY FRAE!OR"
SYSTEM DESIGN DESCRIPTION
[Agency/Organization Name]
[PROECT N!ME"
:E'S$ON: 0:ersion N-mber1 'E:$S$ON D;TE: 0Date1
Approver Name Title Signature Date
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Contents
Section +. $ntrod-ction........................................................................................... +
+.+ P-rpose.................................................................................................................... +
+./ Scope....................................................................................................................... +
Section /. System ;rchitect-re............................................................................. /
/.+ ;rchitect-ral Design ;pproach................................................................................ /
/./ ;rchitect-re Design.................................................................................................. /
Section 2. Data Dictionary..................................................................................... 2
Section 3. System Domain Design........................................................................3
3.+ System Domain &hart............................................................................................... 3
3./ System Domains....................................................................................................... 3
Section 5. Data Design.......................................................................................... 5
5.+ Persistent<Static Data............................................................................................... 5
5./ Transient<Dynamic Data........................................................................................... 5
5.2 External $nter)ace Data............................................................................................. 5
5.3 Trans)ormation o) Data............................................................................................. 5
Section >. 6ser $nter)ace Design........................................................................... >
>.+ 6ser $nter)ace Design Overview.............................................................................. >
>./ 6ser $nter)ace Navigation ?ierarchy........................................................................>
>.2 6ser -nction &ategories ,or 6se &ases................................................................>
Section @. Other $nter)aces.................................................................................... A
Section A. Other Design eat-res......................................................................... B
Section B. 'eC-irements Traceability #atrix.......................................................+D
Section +D. 'e)erences....................................................................................... ++
Section ++. %lossary........................................................................................... +/
Section +/. 'evision ?istory............................................................................... +2
Section +2. ;ppendices....................................................................................... +3
Eased on
D$' Doc-ment /5SD7T+7/ Page i
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section #$ Intro%&ction
1.1 Purpose
Describe the purpose of the SyDD and its intended audience.

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

Eased on
D$' Doc-ment /5SD7T+7/ Page +
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section '$ System !rchitect&re
2.1 Architectural Design Approach
Describe the architectural design approach.

2.2 Architecture Design


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

Eased on
D$' Doc-ment /5SD7T+7/ Page /
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section ($ 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 system.

Eased on
D$' Doc-ment /5SD7T+7/ Page 2
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section )$ System Domain Design
4.1 System Domain hart
Provide a figure depicting the set of system domains showing major components and their
relationships.

4.2 System Domains


Customize this subsection to contain the subsections necessary to comprehensively document
the domains, components, functions, and tass of the system design. !ach subsection should be
titled for a specific domain, component, or tas and labeled appropriately. Describe each domain
within the design. Depict and describe the hierarchy of domains, components, functions, and
tass.
4.2.x Domain X
Provide a domain hierarchy chart and a high"level description of Domain # and the family of
components that mae up Domain #.

4.2.x.y Component Y1 of Domain X


Provide a hierarchical depiction and high"level description of Component $% of Domain #.

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


Provide a high"level description of Tas & of Component $% of Domain #. 'f appropriate
for the design, provide diagrams and narratives that specify the flow of data and control
at a component or tas level.

Eased on
D$' Doc-ment /5SD7T+7/ Page 3
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section *$ Data Design
Customize the following subsections to describe the data contained in databases and other data
structures shared between design elements of the system design, include persistent(static data,
transient(dynamic data, e)ternal interface data, and transformation of data. *abel and title each
subsection appropriately.
!.1 Persistent/Static Data
5.1.x PersistentStatic Data Store X
Describe and provide an illustration of the logical data model or entity relationship diagram+s, for
the Persistent(Static Data Store #. 'nclude the purpose and general configuration of the data
store.

!.2 "ransient/Dynamic Data


Describe the system-s transient(dynamic data design and its general configuration. 'nclude the
purpose for each of the transient(dynamic data design elements.

!.# $%ternal &nter'ace Data


Describe and, if appropriate, provide diagrams of the e)ternal interfaces- data design. 'nclude the
purpose and general configuration of the data design elements.

!.4 "rans'ormation o' Data


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

Eased on
D$' Doc-ment /5SD7T+7/ Page 5
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section +$ User Inter,ace Design
(.1 )ser &nter'ace Design O*er*ie+
Provide a high"level description of the user interface for this system. Describe any systems
re/uirements +e.g., performance or usability, associated with all of the user interfaces.

(.2 )ser &nter'ace Na*igation ,ierarchy


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

(.# )ser -unction ategories .or )se ases/


Customize the following subsections to accurately and comprehensively document each category
of user function or use case that re/uires an interface. Document each category of user function
or use case individually in a corresponding subsection. *abel each subsection appropriately and
title each subsection descriptively to indicate the function or use case being documented.
!.".x #unction $or %se Case& X
Provide a description of the function supporting this category of user interfaces.

!.".x.y #unction $or %se Case& X Screen/Report Format/Other User Interface XX


Provide a description, and if appropriate, an image or mocup 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(0ther 1ser 'nterface 2ields Table that includes descriptive information
for each field that appears on the screen or other user interface within the function or use
case.
'n addition, if the data is selected from a pic list, include the list of possible values or
their description. 'f 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. 'f the content of a field is derived from server side calculations or
Eased on
D$' Doc-ment /5SD7T+7/ Page >
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
looups, then specify the source of that calculation +e.g., the class or stored procedure
where the calculation occurs,.
3lso, specify the error messages to be displayed when the input does not meet
re/uirements for the field.

Eased on
D$' Doc-ment /5SD7T+7/ Page @
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section -$ Other Inter,aces
Customize the following subsections to accurately and comprehensively document the design of
any additional interfaces not described in the previous sections. 'dentify the technology that will
be used to enable the interaction. *abel each subsection appropriately and title each subsection
descriptively to indicate the interface being documented.
'.x Interface X
Describe the interface design including technology, the protocol, any specific message formats,
error conditions, handshaes, initiation and closure, and other features that define the design of
the interface.

Eased on
D$' Doc-ment /5SD7T+7/ Page A
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section .$ Other Design /eat&res
Describe any design features that are not captured in the previous sections.

Eased on
D$' Doc-ment /5SD7T+7/ Page B
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section 0$ Re1&irements Tracea2ility Matri3
Provide reference to the location of the 4e/uirements Traceability 5atri) that indicates traceabilty
from the system re/uirements documented in the System 4e/uirements Specification to the
design elements documented in the System Design Description.

Eased on
D$' Doc-ment /5SD7T+7/ Page +D
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section #4$ Re,erences
Provide a list of all documents and other sources of information referenced in the System Design
Description and utilized in developing the System Design Description. 'nclude for each the
document number, title, date, and author.
Document No. Document Title Date Aut(or
Eased on
D$' Doc-ment /5SD7T+7/ Page ++
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section ##$ Glossary
Define of all terms and acronyms re/uired to interpret the System Design Description properly.

Eased on
D$' Doc-ment /5SD7T+7/ Page +/
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section #'$ Re5ision 6istory
'dentify changes to the System Design Description.
)ersion Date Name Description

Eased on
D$' Doc-ment /5SD7T+7/ Page +2
0;gency<Organi4ation Name1 S"STE# DES$%N DES&'$PT$ON
0Project Name1 0:ersion N-mber1 = 0'evision Date1
Section #($ !ppen%ices
'nclude any relevant appendices.

Eased on
D$' Doc-ment /5SD7T+7/ Page +3

You might also like