SYSTEM DESIGN DOCUMENT TEMPLATE v0.1

Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 14

System Design Document

<Project Name>

Document ID SYSTEM DESIGN-v0.1


Version Number 0.1
Issue Date April 01, 2020
Classification Public
System Design <Customer logo>
Version: 0.1

Copyright Notice

© COMPANYNAME, (original issue year – current issue year)

All Rights Reserved

The information contained in this document is the property of COMPANYNAME. No part of


this document may be reproduced, stored in a retrieval system, or transmitted in any form,
or by any means; mechanical, photocopying, recording, or otherwise, without the prior
written consent of COMPANYNAME. Under the law, copying includes translating into
another language or format. Legal action will be taken against any infringement.

The information contained in this document is subject to change without notice and does
not carry any contractual obligation for COMPANYNAME. COMPANYNAME reserves the right
to make changes to any products or services described in this document at any time without
notice. COMPANYNAME shall not be held responsible for the direct or indirect consequences
of the use of the information contained in this document.

805834964.docx Public Page 2 of 14


System Design <Customer logo>
Version: 0.1

Revision History
Date Version Description Author (s)
04/01/2020 0.1 Draft Version John Doe

Reviewed By (Customer) Signature Date

The reviewer signoff shall signify the recommendation for acceptance of this document.

Sign Off
805834964.docx Public Page 3 of 14
System Design <Customer logo>
Version: 0.1

Prepared By Acknowledged By

<Name> <Name>
Title: <Position> Title: <Position>
COMPANYNAME COMPANYNAME
Date: Date:

Accepted By Accepted By

<Name> <Name>
Title: <Position> Title: <Position>
<Customer Company Name > <Customer Company Name >
Date: Date:

805834964.docx Public Page 4 of 14


System Design <Customer logo>
Version: 0.1

Table of Contents

List of Tables......................................................................................................................7

List of Figures.....................................................................................................................8

1 Introduction...............................................................................................................9

1.1 Purpose of Document..............................................................................................9


1.2 Document Scope.....................................................................................................9
1.2.1 In-Scope............................................................................................................9

1.2.2 Out-of-Scope.....................................................................................................9

1.2.3 Assumptions......................................................................................................9

1.3 Methodology, Tools, and Approach........................................................................9


1.4 Acronyms and Abbreviations...................................................................................9

2 Design Overview......................................................................................................10

2.1 Background Information........................................................................................10


2.2 System Evolution Description................................................................................10
2.3 Required Environment...........................................................................................10
2.4 Constraints............................................................................................................10
2.5 Design Trade-offs...................................................................................................11

3 Logical Architecture..................................................................................................11

3.1 Hardware Architecture..........................................................................................11


3.2 Application Architecture........................................................................................11
3.3 Communication Architecture................................................................................11

4 Physical Architecture................................................................................................11

5 Data Model..............................................................................................................12

5.1 Database Management System Files.....................................................................12


5.2 Non-Database Management System Files.............................................................12

6 Detailed Design........................................................................................................12

6.1 Hardware Detailed Design.....................................................................................12


6.2 Application Detailed Design...................................................................................12
805834964.docx Public Page 5 of 14
System Design <Customer logo>
Version: 0.1

6.3 Communication Detailed Design...........................................................................12

7 External Interface Design..........................................................................................12

7.1 Interface Architecture...........................................................................................12


7.2 Interface Detailed Design......................................................................................12

8 Graphical User Interface (GUI)..................................................................................13

8.1 Interface Design Rules...........................................................................................13


8.2 Inputs.....................................................................................................................13
8.3 Outputs..................................................................................................................13
8.4 Navigation Hierarchy.............................................................................................13
8.4.1 Screen [x.1].....................................................................................................13

8.4.2 Screen [x.2].....................................................................................................13

9 System Integrity Controls.........................................................................................13

Appendix..........................................................................................................................14

805834964.docx Public Page 6 of 14


System Design <Customer logo>
Version: 0.1

List of Tables

805834964.docx Public Page 7 of 14


System Design <Customer logo>
Version: 0.1

List of Figures

805834964.docx Public Page 8 of 14


System Design <Customer logo>
Version: 0.1

1 Introduction

<Provide an overview of the system and some additional information to place the system in
context.>

1.1 Purpose of Document

<Provide an overall description of the SDD, its purpose. Reference the system name and
identifying information about the system to be implemented.>

1.2 Document Scope

<Discuss the scope of the document and how it accomplishes its purpose.>

1.2.1 In-Scope

<Describe the in scope>

1.2.2 Out-of-Scope

<Describe the out of scope>

1.2.3 Assumptions

<State the assumptions that the system should be based on. Assumptions are the
fundamental conditions that must hold for the project to succeed>

1.3 Methodology, Tools, and Approach

<List and describe the methodology, tools, and technique use.>

1.4 Acronyms and Abbreviations


<The following acronyms and abbreviations will apply to this document>
GUI Graphical User Interface
SDD System Design Document

805834964.docx Public Page 9 of 14


System Design <Customer logo>
Version: 0.1

2 Design Overview

2.1 Background Information

<Describe the background information>

2.2 System Evolution Description

<Describe the modification >

2.3 Required Environment

<List the proposed and/or required managed environments >

Product/Solution Environment

CAVIS II - Production

- Development (Temporary i.e. loan server)

2.4 Constraints

<Describe any global limitations or constraints that have a significant impact on the design of
the system's software (and describe the associated impact). Such constraints may be
imposed by any of the following (the list is not exhaustive):

 Hardware or software environment


 End-user environment
 Availability or volatility of resources
 Standards compliance
 Interoperability requirements
 Interface/protocol requirements

805834964.docx Public Page 10 of 14


System Design <Customer logo>
Version: 0.1

 Data repository and distribution requirements


 Security requirements (or other such regulations)
 Memory and other capacity limitations
 Performance requirements
 Network communications
 Verification and validation requirements (testing)
 Other means of addressing quality goals
 Other requirements described in the requirements specification >

2.5 Design Trade-offs

<Describe the trade-offs>

3 Logical Architecture

3.1 Hardware Architecture

<Describe the hardware architecture>

3.2 Application Architecture

<Describe the software architecture>

3.3 Communication Architecture

<Describe the communication architecture>

4 Physical Architecture

<Describe the network architecture>

805834964.docx Public Page 11 of 14


System Design <Customer logo>
Version: 0.1

5 Data Model

5.1 Database Management System Files

<Database Management System Files diagram and description>

5.2 Non-Database Management System Files

<Non-Database Management System Files diagram and description>

6 Detailed Design

6.1 Hardware Detailed Design

<Describe the detailed design>

6.2 Application Detailed Design

<Describe the software detailed design>

6.3 Communication Detailed Design

<Describe the communication detailed design>

7 External Interface Design

7.1 Interface Architecture

<Describe the interface architecture>

7.2 Interface Detailed Design

<Describe the interface detailed design>

805834964.docx Public Page 12 of 14


System Design <Customer logo>
Version: 0.1

8 Graphical User Interface (GUI)

8.1 Interface Design Rules

<Describe the interface design rules>

8.2 Inputs

<List of inputs>

8.3 Outputs

<List of outputs>

8.4 Navigation Hierarchy

8.4.1 Screen [x.1]

<Screen design>

8.4.2 Screen [x.2]

<Screen design>

9 System Integrity Controls

<Describe the system integrity controls>

805834964.docx Public Page 13 of 14


System Design <Customer logo>
Version: 0.1

Appendix

<List of requirements traceability matrix, glossary of terms, etc>

805834964.docx Public Page 14 of 14

You might also like