<> Project: High Level Design Template
Department Name
Date
Version No. 1.00
Authorized by
HLD Template Page 1 of 12
Confidentiality Agreement
<Insert confidentiality clauses and Copy Rights>
Revision History
Version Date Author Reviewer Approver Comments
0.1 XXXXX Draft Version
0.2 XXXXX Incorporated some
document structure
and content related
changes
0.3 XXXXX Added some sections
like state and session
management,
caching etc.
suggested by Laxmi
R
1.0 XXXXX Baseline
HLD Template Page 2 of 12
Table of Contents
Introduction .................................................................................................................................. 6
1.1 Scope of the document .......................................................................................................................... 6
1.2 Intended Audience ................................................................................................................................ 6
1.3 System overview .................................................................................................................................... 6
System Design............................................................................................................................... 6
Application Design .............................................................................................................................................. 6
Process Flow .................................................................................................................................................. 6
Information Flow .......................................................................................................................................... 7
Components Design ............................................................................................................................................ 8
Key Design Considerations ................................................................................................................................. 8
API Catalogue ....................................................................................................................................................... 8
Data Design ................................................................................................................................... 8
Data Model ........................................................................................................................................................... 8
Data Access Mechanism...................................................................................................................................... 9
Data Retention Policies ....................................................................................................................................... 9
Data Migration ..................................................................................................................................................... 9
Interfaces 9
State and Session Management ............................................................................................... 10
Caching 10
Non Functional Requirements ................................................................................................. 10
Security Aspects ................................................................................................................................................. 10
Performance Aspects ......................................................................................................................................... 10
References ................................................................................................................................... 11
HLD Template Page 3 of 12
Index of Tables
No table of contents entries found.
HLD Template Page 4 of 12
Index of Figures
No table of contents entries found.
HLD Template Page 5 of 12
Introduction
1.1 Scope of the document
This section will cover details regarding scope of the document
Sample Content:
This document outlines the high level functional design of tax payer registration functionality. It
highlights/refers the high level flows / Use cases in registration process, design of components, along with
the rationale for the same. It serves as an input to the low level design documents that would further
elaborate on the application design.
1.2 Intended Audience
This section will cover categories of audiences who will be referring/reviewing this
document
Sample Content:
Web portal Development Team
Architecture Team
Quality Team
Department
1.3 System overview
This section will capture high level overview of system application i.e. for what system is
being developed ,the high level process flow
Who are the stake holders of system
Sample Content:
This system provides a web interface to the tax payer for filling up registration form and submits his
registration request. This system also provides facility to integrate third party application through API so
that tax payer can use third party application for registration. In Registration process, tax payer need to
complete registration form having some mandatory and optional fields. This system will do the both
structural validation and data validation in real time. There will be separate work flow for approval.
System Design
Application Design
This section will capture Process flow, Information flow having sequence diagram for different use
cases, component design details, key design considerations taken and API catalogue
Process Flow
This section will capture the flowcharts(s) representing process diagram
Sample Process Flow Chart:
If we take tax payer registration work flow as a sample, Work flow diagram will be as shown in diagram
HLD Template Page 6 of 12
Information Flow
This section will capture flow of information between all application components required to meet
the requirement
This will capture flow for both positive and negative scenarios
Sample Sequence Diagram:
HLD Template Page 7 of 12
Components Design
This section will capture the elaborative details of each component depicted in sequence diagram
This will also highlight importance/use of component
Key Design Considerations
This section will capture the list of key design consideration and the reason for taking considerations:
Sample Content:
Messaging component has been implemented as separate service because apart from website
portal, it could be invoked by other offline applications as well.
As Statement file generation is heavy process and volume is high so it has been implemented
as offline batch application ……
API Catalogue
Sample Content:
Sr. No. Name Of API Description Input Output Access
Level
1 getNewRegistrationReq This Api As per input As per output mentioned Public
provides the mentioned in in API document
registration API available at share point
data document
available at
share point
2
Data Design
Data Model
This section will capture high level design of data model
It will capture information like whether it is RDBMS/HDFS etc.
Entity relationship etc. diagrams will also be captured
Sample Content:
HLD Template Page 8 of 12
BNK.STMT_Request
PK Request_ID
User_ID
BNK_Acc_Num
Period_From
Period_To
BNK.Request_Details
PK ID
Request_ID
User_Name
User_Address
Data Access Mechanism
There will be a high level technical design consideration which will cover framework for data access
mechanism i.e. ORM implementation details etc. In this section, any customization specific to module (for
which this document is prepared) will be covered.
Data Retention Policies
This Section will capture policies related to data purging/data archiving
This will also capture specific tables for which data will be purged/archived
Data Migration
This section will capture the data migration strategy
We know that data migration is big activity so the strategy may get capture in separate
document. If it is being captured in separate document, we need to give the reference of same
document.
Interfaces
This section will capture the high level details of other Interfaces which are interacting with our application
in scope.
HLD Template Page 9 of 12
State and Session Management
There will be separate high level technical design document which will cover framework for state and session
management. In this section, any customization specific to module (for which this document is prepared) will
be covered.
Caching
There will be separate high level technical design document which will cover framework for caching. In this
section, any customization specific to module (for which this document is prepared) will be covered.
Non Functional Requirements
This section will capture non-functional aspects of system
This section will capture Security aspects and Performance aspects of the system
Security Aspects
Sample Content:
Apart from infra level security (Web application firewall/Network firewall) here are some sample
application level security considerations
Virus scanning of files before successful upload
Symantec library will be used as virus scanning engine
Only selective File format supported
Only *.docx,*.jpeg etc. .File format are supported
Restricted file upload size
File size to be uploaded should not be exceeded to 5 MB
Performance Aspects
This section will capture the performance aspects of the application in scope
HLD Template Page 10 of 12
References
This section will list down the documents which has been refereed while creating this document
S.No Document Name Version Date
Appendices
Appendix 1. Comments Matrix .......................................................................................12
HLD Template Page 11 of 12
Appendix 1. Comments Matrix
Since there is no formal tool finalized currently for logging comments on various document deliverables,
Comments Matrix is being put here to ensure comments are being tracked and resolved. Once a formal tool is
identified, this process might change for future deliverables.
S. No. IRD Review Date Raised Vendor Remarks
Comments
1
2
HLD Template Page 12 of 12
